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 40f557b9ef..905948fa92 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 @@ -11221,7 +11221,7 @@ "/meta": { "get": { "summary": "Get GitHub 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/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/articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names, and the public keys used by GitHub to sign commits made through the web UI.\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" ], @@ -29393,6 +29393,121 @@ } } }, + "/orgs/{org}/interaction-limits/pulls/creation-cap": { + "patch": { + "summary": "Update pull request creation cap for an org", + "description": "Updates the pull request creation cap for an organization. The cap limits the total number\nof open pull requests a user can have across all public repositories in the organization\nat one time.\n\nOnly users with admin access to the organization can configure the cap.", + "tags": [ + "interactions" + ], + "operationId": "interactions/update-pull-request-creation-cap-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/orgs#update-pull-request-creation-cap-for-an-org" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pull request creation cap is enabled" + }, + "max_open_pull_requests": { + "type": "integer", + "description": "The maximum number of open pull requests a user can have at one time", + "minimum": 1, + "maximum": 1000 + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "enabled": true, + "max_open_pull_requests": 1 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pull request creation cap is enabled" + }, + "max_open_pull_requests": { + "type": "integer", + "description": "The maximum number of open pull requests a user can have at one time", + "minimum": 1, + "maximum": 1000 + } + }, + "required": [ + "enabled", + "max_open_pull_requests" + ] + }, + "examples": { + "default": { + "summary": "Response", + "value": { + "enabled": true, + "max_open_pull_requests": 1 + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "405": { + "description": "Method Not Allowed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/invitations": { "get": { "summary": "List pending organization invitations", @@ -38574,6 +38689,10 @@ "parent_team_id": { "type": "integer", "description": "The ID of a team to set as the parent team." + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided." } }, "required": [ @@ -38736,6 +38855,11 @@ "type": "integer", "description": "The ID of a team to set as the parent team.", "nullable": true + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided.", + "nullable": true } } }, @@ -39143,7 +39267,7 @@ "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", - "description": "Lists a team's repositories 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}/repos`.", + "description": "Lists a team's repositories visible to the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` or `repo` scope to use this endpoint.\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`.", "tags": [ "teams" ], @@ -63937,7 +64061,7 @@ "properties": { "suggestions": { "type": "object", - "description": "Pending suggestions for each suggestible field (`type`,\n`issue_field_values`, `labels`, `assignees`, `state`) the\nrequest touched. Omitted for fields not in the request or\nwith no pending suggestions. Items tagged `already_applied`\nare echoes of the current request's inputs whose target is\nalready applied to the issue; they are not persisted as\npending suggestions.\n", + "description": "Pending suggestions for each suggestible field (`type`,\n`issue_field_values`, `labels`, `assignees`, `state`) the\nrequest touched. Omitted for fields not in the request or\nwith no pending or ignored suggestions. Items tagged\n`ignored` are echoes of the current request's inputs that\nwere not persisted as pending suggestions.\n", "properties": { "type": { "type": "array", @@ -63961,8 +64085,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -64005,8 +64136,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -64033,8 +64171,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -64061,8 +64206,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -64095,8 +64247,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -71042,6 +71201,305 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async": { + "put": { + "summary": "Merge a pull request asynchronously", + "description": "Merges a pull request into the base branch in the background. Merging in this way allows certain types of errors to be retried, and avoids the risk of timeouts for particularly complex merges.\n\nThis is the required method for merging stacked PRs, but also supports unstacked PRs. When using this endpoint to merge a stacked pull request, all pull requests in the stack up to and including the requested PR will be merged into the base branch.\n\nThe response includes a UUID that can be used to fetch the result of the merge. If another asynchronous merge request has already been made for this pull request, the UUID of that request will be returned instead with a 409 response status to indicate that the merge options may be different from those that were requested. If there isn't an existing asynchronous merge request, a 202 response status is used.\n\nIf the pull request is already merged, the merge commit OID will be returned immediately with a 200 status.\n\nIf the pull request cannot be merged (e.g. because it is closed, or still a draft) this result will be returned immediately with a 400 response status. Branch protection rules and repository rules are not run at this stage, only basic pull request state checks are performed.", + "tags": [ + "pulls" + ], + "operationId": "pulls/merge-async", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously" + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "commit_title": { + "type": "string", + "description": "Title for the automatic commit message." + }, + "commit_message": { + "type": "string", + "description": "Extra detail to append to automatic commit message." + }, + "sha": { + "type": "string", + "description": "SHA that pull request head must match to allow merge. If not provided, the current head of the PR at the time of the request will be used; if the PR is pushed in between the merge being requested and being executed, the merge will be cancelled." + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "description": "The action that will be taken to merge the pull request. `direct_merge` merges the pull request directly without using a merge queue; `merge_queue` adds the pull request to a merge queue; `default` selects the most appropriate option.", + "enum": [ + "default", + "direct_merge", + "merge_queue" + ] + } + } + }, + "examples": { + "default": { + "value": { + "commit_title": "Fix race condition", + "commit_message": "Avoids a race by trying to read the file and handling the exception if it does not exist.", + "sha": "6358cd125586d9def8c3e5943f23506202da81cc", + "merge_method": "squash", + "merge_action": "default" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "if the merge request was accepted and will run in the background", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-async-result" + }, + "examples": { + "response-if-merge-request-was-accepted": { + "summary": "Request accepted", + "value": { + "status": "pending", + "details": { + "message": "Merge request enqueued.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "merge", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + } + } + } + } + }, + "200": { + "description": "if the pull request was already merged, or is already in a merge queue", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-async-result" + }, + "examples": { + "response-if-pull-request-was-already-merged": { + "summary": "Already merged", + "value": { + "status": "merged", + "details": { + "message": "Pull request is already merged.", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + }, + "response-if-pull-request-is-already-enqueued": { + "summary": "Already enqueued", + "value": { + "status": "enqueued", + "details": { + "message": "Pull request is already in the merge queue." + } + } + } + } + } + } + }, + "409": { + "description": "if there is an existing merge request already enqueued for this pull request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-async-result" + }, + "examples": { + "response-if-a-merge-request-already-exists": { + "value": { + "status": "pending", + "details": { + "message": "A merge request already exists for this pull request.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "squash", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + } + } + } + } + }, + "400": { + "description": "if the pull request is not ready to be merged, e.g. because it is closed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-async-result" + }, + "examples": { + "response-if-pull-request-is-not-ready-to-be-merged": { + "value": { + "status": "failed", + "details": { + "message": "Pull request is closed." + } + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}": { + "get": { + "summary": "Get the result of an asynchronous merge", + "description": "Fetches the current result of an asynchronous merge request, identified by the UUID that was returned when the merge was requested.\n\nWhile the merge is still queued, the response includes the UUID, merge method, and expected head SHA of the request. Once the merge has completed, the response reports whether it was merged, including the merge commit OID on success or a message describing why it could not be merged on failure.\n\nThe result of an asynchronous merge request is retained for 24 hours after its most recent update. After this window the request expires and this endpoint returns a `404` response for its UUID.", + "tags": [ + "pulls" + ], + "operationId": "pulls/get-merge-async-result", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#get-the-result-of-an-asynchronous-merge" + }, + "x-github": { + "triggersNotification": false, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + }, + { + "name": "uuid", + "description": "The UUID of the asynchronous merge request, as returned when the merge was requested.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "the current result of the asynchronous merge request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-async-result" + }, + "examples": { + "response-if-the-merge-is-still-queued": { + "summary": "Still queued", + "value": { + "status": "pending", + "details": { + "message": "Merge request is in progress.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "merge", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + }, + "response-if-the-pull-request-is-enqueued": { + "summary": "Enqueued in the merge queue", + "value": { + "status": "enqueued", + "details": { + "message": "Pull request is in the merge queue." + } + } + }, + "response-if-the-merge-succeeded": { + "summary": "Merge succeeded", + "value": { + "status": "merged", + "details": { + "message": "Pull request was merged.", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + }, + "response-if-the-merge-failed": { + "summary": "Merge failed", + "value": { + "status": "failed", + "details": { + "message": "Merge conflict: the pull request could not be merged." + } + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { "summary": "Get all requested reviewers for a pull request", @@ -79305,6 +79763,11 @@ "type": "integer", "description": "The ID of a team to set as the parent team.", "nullable": true + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided.", + "nullable": true } }, "required": [ @@ -125207,6 +125670,15 @@ ] } }, + "storage": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, "actions": { "type": "array", "items": { @@ -141795,6 +142267,26 @@ }, "nullable": true }, + "git-user": { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "\"Chris Wanstrath\"" + }, + "email": { + "type": "string", + "example": "\"chris@ozmm.org\"" + }, + "date": { + "type": "string", + "format": "date-time", + "example": "\"2007-10-29T02:42:39.000-07:00\"" + } + } + }, "verification": { "title": "Verification", "type": "object", @@ -152539,6 +153031,102 @@ "sha" ] }, + "pull-request-merge-async-result": { + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", + "type": "object", + "additionalProperties": false, + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] + }, + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] + } + }, + "required": [ + "status", + "details" + ] + }, "pull-request-review-request": { "title": "Pull Request Review Request", "description": "Pull Request Review Request", 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 dcc1219513..090476c7a1 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 @@ -8324,7 +8324,7 @@ paths: 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/articles/about-github-s-ip-addresses/)." - The API's response also includes a list of GitHub's domain names. + The API's response also includes a list of GitHub's domain names, and the public keys used by GitHub to sign commits made through the web UI. The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. @@ -21885,6 +21885,90 @@ paths: enabledForGitHubApps: true category: interactions subcategory: orgs + "/orgs/{org}/interaction-limits/pulls/creation-cap": + patch: + summary: Update pull request creation cap for an org + description: |- + Updates the pull request creation cap for an organization. The cap limits the total number + of open pull requests a user can have across all public repositories in the organization + at one time. + + Only users with admin access to the organization can configure the cap. + tags: + - interactions + operationId: interactions/update-pull-request-creation-cap-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/interactions/orgs#update-pull-request-creation-cap-for-an-org + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether the pull request creation cap is enabled + max_open_pull_requests: + type: integer + description: The maximum number of open pull requests a user can + have at one time + minimum: 1 + maximum: 1000 + required: + - enabled + examples: + default: + summary: Example request body + value: + enabled: true + max_open_pull_requests: 1 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether the pull request creation cap is enabled + max_open_pull_requests: + type: integer + description: The maximum number of open pull requests a user can + have at one time + minimum: 1 + maximum: 1000 + required: + - enabled + - max_open_pull_requests + examples: + default: + summary: Response + value: + enabled: true + max_open_pull_requests: 1 + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '405': + description: Method Not Allowed + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: orgs "/orgs/{org}/invitations": get: summary: List pending organization invitations @@ -28502,6 +28586,10 @@ paths: parent_team_id: type: integer description: The ID of a team to set as the parent team. + parent_team_slug: + type: string + description: The slug of a team to set as the parent team. Ignored + when `parent_team_id` is also provided. required: - name examples: @@ -28630,6 +28718,11 @@ paths: type: integer description: The ID of a team to set as the parent team. nullable: true + parent_team_slug: + type: string + description: The slug of a team to set as the parent team. Ignored + when `parent_team_id` is also provided. + nullable: true examples: default: value: @@ -28932,6 +29025,8 @@ paths: description: |- Lists a team's repositories visible to the authenticated user. + OAuth app tokens and personal access tokens (classic) need the `read:org` or `repo` scope to use this endpoint. + > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. tags: @@ -47217,10 +47312,9 @@ paths: Pending suggestions for each suggestible field (`type`, `issue_field_values`, `labels`, `assignees`, `state`) the request touched. Omitted for fields not in the request or - with no pending suggestions. Items tagged `already_applied` - are echoes of the current request's inputs whose target is - already applied to the issue; they are not persisted as - pending suggestions. + with no pending or ignored suggestions. Items tagged + `ignored` are echoes of the current request's inputs that + were not persisted as pending suggestions. properties: type: type: array @@ -47239,8 +47333,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed issue_field_values: type: array items: @@ -47265,8 +47364,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed labels: type: array items: @@ -47284,8 +47388,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed assignees: type: array items: @@ -47303,8 +47412,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed state: type: array items: @@ -47326,8 +47440,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed examples: default: "$ref": "#/components/examples/issue" @@ -52217,6 +52336,229 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async": + put: + summary: Merge a pull request asynchronously + description: |- + Merges a pull request into the base branch in the background. Merging in this way allows certain types of errors to be retried, and avoids the risk of timeouts for particularly complex merges. + + This is the required method for merging stacked PRs, but also supports unstacked PRs. When using this endpoint to merge a stacked pull request, all pull requests in the stack up to and including the requested PR will be merged into the base branch. + + The response includes a UUID that can be used to fetch the result of the merge. If another asynchronous merge request has already been made for this pull request, the UUID of that request will be returned instead with a 409 response status to indicate that the merge options may be different from those that were requested. If there isn't an existing asynchronous merge request, a 202 response status is used. + + If the pull request is already merged, the merge commit OID will be returned immediately with a 200 status. + + If the pull request cannot be merged (e.g. because it is closed, or still a draft) this result will be returned immediately with a 400 response status. Branch protection rules and repository rules are not run at this stage, only basic pull request state checks are performed. + tags: + - pulls + operationId: pulls/merge-async + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + commit_title: + type: string + description: Title for the automatic commit message. + commit_message: + type: string + description: Extra detail to append to automatic commit message. + sha: + type: string + description: SHA that pull request head must match to allow merge. + If not provided, the current head of the PR at the time of the + request will be used; if the PR is pushed in between the merge + being requested and being executed, the merge will be cancelled. + merge_method: + type: string + description: The merge method to use. + enum: + - merge + - squash + - rebase + merge_action: + type: string + description: The action that will be taken to merge the pull request. + `direct_merge` merges the pull request directly without using + a merge queue; `merge_queue` adds the pull request to a merge + queue; `default` selects the most appropriate option. + enum: + - default + - direct_merge + - merge_queue + examples: + default: + value: + commit_title: Fix race condition + commit_message: Avoids a race by trying to read the file and handling + the exception if it does not exist. + sha: 6358cd125586d9def8c3e5943f23506202da81cc + merge_method: squash + merge_action: default + responses: + '202': + description: if the merge request was accepted and will run in the background + content: + application/json: + schema: + "$ref": "#/components/schemas/pull-request-merge-async-result" + examples: + response-if-merge-request-was-accepted: + summary: Request accepted + value: + status: pending + details: + message: Merge request enqueued. + uuid: 630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42 + merge_method: merge + merge_action: default + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + '200': + description: if the pull request was already merged, or is already in a + merge queue + content: + application/json: + schema: + "$ref": "#/components/schemas/pull-request-merge-async-result" + examples: + response-if-pull-request-was-already-merged: + summary: Already merged + value: + status: merged + details: + message: Pull request is already merged. + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + response-if-pull-request-is-already-enqueued: + summary: Already enqueued + value: + status: enqueued + details: + message: Pull request is already in the merge queue. + '409': + description: if there is an existing merge request already enqueued for + this pull request + content: + application/json: + schema: + "$ref": "#/components/schemas/pull-request-merge-async-result" + examples: + response-if-a-merge-request-already-exists: + value: + status: pending + details: + message: A merge request already exists for this pull request. + uuid: 630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42 + merge_method: squash + merge_action: default + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + '400': + description: if the pull request is not ready to be merged, e.g. because + it is closed + content: + application/json: + schema: + "$ref": "#/components/schemas/pull-request-merge-async-result" + examples: + response-if-pull-request-is-not-ready-to-be-merged: + value: + status: failed + details: + message: Pull request is closed. + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}": + get: + summary: Get the result of an asynchronous merge + description: |- + Fetches the current result of an asynchronous merge request, identified by the UUID that was returned when the merge was requested. + + While the merge is still queued, the response includes the UUID, merge method, and expected head SHA of the request. Once the merge has completed, the response reports whether it was merged, including the merge commit OID on success or a message describing why it could not be merged on failure. + + The result of an asynchronous merge request is retained for 24 hours after its most recent update. After this window the request expires and this endpoint returns a `404` response for its UUID. + tags: + - pulls + operationId: pulls/get-merge-async-result + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#get-the-result-of-an-asynchronous-merge + x-github: + triggersNotification: false + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + - name: uuid + description: The UUID of the asynchronous merge request, as returned when + the merge was requested. + in: path + required: true + schema: + type: string + responses: + '200': + description: the current result of the asynchronous merge request + content: + application/json: + schema: + "$ref": "#/components/schemas/pull-request-merge-async-result" + examples: + response-if-the-merge-is-still-queued: + summary: Still queued + value: + status: pending + details: + message: Merge request is in progress. + uuid: 630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42 + merge_method: merge + merge_action: default + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + response-if-the-pull-request-is-enqueued: + summary: Enqueued in the merge queue + value: + status: enqueued + details: + message: Pull request is in the merge queue. + response-if-the-merge-succeeded: + summary: Merge succeeded + value: + status: merged + details: + message: Pull request was merged. + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + response-if-the-merge-failed: + summary: Merge failed + value: + status: failed + details: + message: 'Merge conflict: the pull request could not be merged.' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": get: summary: Get all requested reviewers for a pull request @@ -58154,6 +58496,11 @@ paths: type: integer description: The ID of a team to set as the parent team. nullable: true + parent_team_slug: + type: string + description: The slug of a team to set as the parent team. Ignored + when `parent_team_id` is also provided. + nullable: true required: - name examples: @@ -91643,6 +91990,12 @@ components: type: string example: - example.com + storage: + type: array + items: + type: string + example: + - example.com actions: type: array items: @@ -104702,6 +105055,21 @@ components: format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true + git-user: + title: Git User + description: Metaproperties for Git author/committer information. + type: object + properties: + name: + type: string + example: '"Chris Wanstrath"' + email: + type: string + example: '"chris@ozmm.org"' + date: + type: string + format: date-time + example: '"2007-10-29T02:42:39.000-07:00"' verification: title: Verification type: object @@ -112882,6 +113250,75 @@ components: - merged - message - sha + pull-request-merge-async-result: + title: Pull Request Merge Async Result + description: Pull Request Merge Async Result + type: object + additionalProperties: false + properties: + status: + type: string + enum: + - pending + - merged + - enqueued + - failed + details: + oneOf: + - description: When an asynchronous merge request was created or already + existed + type: object + additionalProperties: false + properties: + message: + type: string + uuid: + type: string + merge_method: + type: string + enum: + - default + - merge + - squash + - rebase + merge_action: + type: string + enum: + - default + - merge_queue + - direct_merge + expected_head_sha: + type: string + description: SHA that the pull request head must match for the enqueued + merge to proceed. + required: + - message + - uuid + - merge_method + - merge_action + - expected_head_sha + - description: When the pull request cannot be merged + type: object + additionalProperties: false + properties: + message: + type: string + required: + - message + - description: When the pull request is already merged + type: object + additionalProperties: false + properties: + message: + type: string + sha: + type: string + required: + - message + - sha + required: + - status + - details pull-request-review-request: title: Pull Request Review Request description: Pull Request Review Request 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 7ec4bc2d6c..3173eda6f5 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 @@ -11221,7 +11221,7 @@ "/meta": { "get": { "summary": "Get GitHub 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/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/articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names, and the public keys used by GitHub to sign commits made through the web UI.\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" ], @@ -29346,6 +29346,121 @@ } } }, + "/orgs/{org}/interaction-limits/pulls/creation-cap": { + "patch": { + "summary": "Update pull request creation cap for an org", + "description": "Updates the pull request creation cap for an organization. The cap limits the total number\nof open pull requests a user can have across all public repositories in the organization\nat one time.\n\nOnly users with admin access to the organization can configure the cap.", + "tags": [ + "interactions" + ], + "operationId": "interactions/update-pull-request-creation-cap-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/orgs#update-pull-request-creation-cap-for-an-org" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pull request creation cap is enabled" + }, + "max_open_pull_requests": { + "type": "integer", + "description": "The maximum number of open pull requests a user can have at one time", + "minimum": 1, + "maximum": 1000 + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "enabled": true, + "max_open_pull_requests": 1 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pull request creation cap is enabled" + }, + "max_open_pull_requests": { + "type": "integer", + "description": "The maximum number of open pull requests a user can have at one time", + "minimum": 1, + "maximum": 1000 + } + }, + "required": [ + "enabled", + "max_open_pull_requests" + ] + }, + "examples": { + "default": { + "summary": "Response", + "value": { + "enabled": true, + "max_open_pull_requests": 1 + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "405": { + "description": "Method Not Allowed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/invitations": { "get": { "summary": "List pending organization invitations", @@ -38527,6 +38642,10 @@ "parent_team_id": { "type": "integer", "description": "The ID of a team to set as the parent team." + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided." } }, "required": [ @@ -38689,6 +38808,11 @@ "type": "integer", "description": "The ID of a team to set as the parent team.", "nullable": true + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided.", + "nullable": true } } }, @@ -39096,7 +39220,7 @@ "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", - "description": "Lists a team's repositories 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}/repos`.", + "description": "Lists a team's repositories visible to the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` or `repo` scope to use this endpoint.\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`.", "tags": [ "teams" ], @@ -63854,7 +63978,7 @@ "properties": { "suggestions": { "type": "object", - "description": "Pending suggestions for each suggestible field (`type`,\n`issue_field_values`, `labels`, `assignees`, `state`) the\nrequest touched. Omitted for fields not in the request or\nwith no pending suggestions. Items tagged `already_applied`\nare echoes of the current request's inputs whose target is\nalready applied to the issue; they are not persisted as\npending suggestions.\n", + "description": "Pending suggestions for each suggestible field (`type`,\n`issue_field_values`, `labels`, `assignees`, `state`) the\nrequest touched. Omitted for fields not in the request or\nwith no pending or ignored suggestions. Items tagged\n`ignored` are echoes of the current request's inputs that\nwere not persisted as pending suggestions.\n", "properties": { "type": { "type": "array", @@ -63878,8 +64002,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -63922,8 +64053,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -63950,8 +64088,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -63978,8 +64123,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -64012,8 +64164,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -70959,6 +71118,305 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async": { + "put": { + "summary": "Merge a pull request asynchronously", + "description": "Merges a pull request into the base branch in the background. Merging in this way allows certain types of errors to be retried, and avoids the risk of timeouts for particularly complex merges.\n\nThis is the required method for merging stacked PRs, but also supports unstacked PRs. When using this endpoint to merge a stacked pull request, all pull requests in the stack up to and including the requested PR will be merged into the base branch.\n\nThe response includes a UUID that can be used to fetch the result of the merge. If another asynchronous merge request has already been made for this pull request, the UUID of that request will be returned instead with a 409 response status to indicate that the merge options may be different from those that were requested. If there isn't an existing asynchronous merge request, a 202 response status is used.\n\nIf the pull request is already merged, the merge commit OID will be returned immediately with a 200 status.\n\nIf the pull request cannot be merged (e.g. because it is closed, or still a draft) this result will be returned immediately with a 400 response status. Branch protection rules and repository rules are not run at this stage, only basic pull request state checks are performed.", + "tags": [ + "pulls" + ], + "operationId": "pulls/merge-async", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously" + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "commit_title": { + "type": "string", + "description": "Title for the automatic commit message." + }, + "commit_message": { + "type": "string", + "description": "Extra detail to append to automatic commit message." + }, + "sha": { + "type": "string", + "description": "SHA that pull request head must match to allow merge. If not provided, the current head of the PR at the time of the request will be used; if the PR is pushed in between the merge being requested and being executed, the merge will be cancelled." + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "description": "The action that will be taken to merge the pull request. `direct_merge` merges the pull request directly without using a merge queue; `merge_queue` adds the pull request to a merge queue; `default` selects the most appropriate option.", + "enum": [ + "default", + "direct_merge", + "merge_queue" + ] + } + } + }, + "examples": { + "default": { + "value": { + "commit_title": "Fix race condition", + "commit_message": "Avoids a race by trying to read the file and handling the exception if it does not exist.", + "sha": "6358cd125586d9def8c3e5943f23506202da81cc", + "merge_method": "squash", + "merge_action": "default" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "if the merge request was accepted and will run in the background", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-async-result" + }, + "examples": { + "response-if-merge-request-was-accepted": { + "summary": "Request accepted", + "value": { + "status": "pending", + "details": { + "message": "Merge request enqueued.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "merge", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + } + } + } + } + }, + "200": { + "description": "if the pull request was already merged, or is already in a merge queue", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-async-result" + }, + "examples": { + "response-if-pull-request-was-already-merged": { + "summary": "Already merged", + "value": { + "status": "merged", + "details": { + "message": "Pull request is already merged.", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + }, + "response-if-pull-request-is-already-enqueued": { + "summary": "Already enqueued", + "value": { + "status": "enqueued", + "details": { + "message": "Pull request is already in the merge queue." + } + } + } + } + } + } + }, + "409": { + "description": "if there is an existing merge request already enqueued for this pull request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-async-result" + }, + "examples": { + "response-if-a-merge-request-already-exists": { + "value": { + "status": "pending", + "details": { + "message": "A merge request already exists for this pull request.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "squash", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + } + } + } + } + }, + "400": { + "description": "if the pull request is not ready to be merged, e.g. because it is closed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-async-result" + }, + "examples": { + "response-if-pull-request-is-not-ready-to-be-merged": { + "value": { + "status": "failed", + "details": { + "message": "Pull request is closed." + } + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}": { + "get": { + "summary": "Get the result of an asynchronous merge", + "description": "Fetches the current result of an asynchronous merge request, identified by the UUID that was returned when the merge was requested.\n\nWhile the merge is still queued, the response includes the UUID, merge method, and expected head SHA of the request. Once the merge has completed, the response reports whether it was merged, including the merge commit OID on success or a message describing why it could not be merged on failure.\n\nThe result of an asynchronous merge request is retained for 24 hours after its most recent update. After this window the request expires and this endpoint returns a `404` response for its UUID.", + "tags": [ + "pulls" + ], + "operationId": "pulls/get-merge-async-result", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#get-the-result-of-an-asynchronous-merge" + }, + "x-github": { + "triggersNotification": false, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + }, + { + "name": "uuid", + "description": "The UUID of the asynchronous merge request, as returned when the merge was requested.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "the current result of the asynchronous merge request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-async-result" + }, + "examples": { + "response-if-the-merge-is-still-queued": { + "summary": "Still queued", + "value": { + "status": "pending", + "details": { + "message": "Merge request is in progress.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "merge", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + }, + "response-if-the-pull-request-is-enqueued": { + "summary": "Enqueued in the merge queue", + "value": { + "status": "enqueued", + "details": { + "message": "Pull request is in the merge queue." + } + } + }, + "response-if-the-merge-succeeded": { + "summary": "Merge succeeded", + "value": { + "status": "merged", + "details": { + "message": "Pull request was merged.", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + }, + "response-if-the-merge-failed": { + "summary": "Merge failed", + "value": { + "status": "failed", + "details": { + "message": "Merge conflict: the pull request could not be merged." + } + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { "summary": "Get all requested reviewers for a pull request", @@ -79222,6 +79680,11 @@ "type": "integer", "description": "The ID of a team to set as the parent team.", "nullable": true + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided.", + "nullable": true } }, "required": [ @@ -124719,6 +125182,15 @@ ] } }, + "storage": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, "actions": { "type": "array", "items": { @@ -141226,6 +141698,26 @@ }, "nullable": true }, + "git-user": { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "\"Chris Wanstrath\"" + }, + "email": { + "type": "string", + "example": "\"chris@ozmm.org\"" + }, + "date": { + "type": "string", + "format": "date-time", + "example": "\"2007-10-29T02:42:39.000-07:00\"" + } + } + }, "verification": { "title": "Verification", "type": "object", @@ -151954,6 +152446,102 @@ "sha" ] }, + "pull-request-merge-async-result": { + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", + "type": "object", + "additionalProperties": false, + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] + }, + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] + } + }, + "required": [ + "status", + "details" + ] + }, "pull-request-review-request": { "title": "Pull Request Review Request", "description": "Pull Request Review Request", 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 e24a6824a5..95cd6ae3a3 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 @@ -8324,7 +8324,7 @@ paths: 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/articles/about-github-s-ip-addresses/)." - The API's response also includes a list of GitHub's domain names. + The API's response also includes a list of GitHub's domain names, and the public keys used by GitHub to sign commits made through the web UI. The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. @@ -21850,6 +21850,90 @@ paths: enabledForGitHubApps: true category: interactions subcategory: orgs + "/orgs/{org}/interaction-limits/pulls/creation-cap": + patch: + summary: Update pull request creation cap for an org + description: |- + Updates the pull request creation cap for an organization. The cap limits the total number + of open pull requests a user can have across all public repositories in the organization + at one time. + + Only users with admin access to the organization can configure the cap. + tags: + - interactions + operationId: interactions/update-pull-request-creation-cap-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/interactions/orgs#update-pull-request-creation-cap-for-an-org + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether the pull request creation cap is enabled + max_open_pull_requests: + type: integer + description: The maximum number of open pull requests a user can + have at one time + minimum: 1 + maximum: 1000 + required: + - enabled + examples: + default: + summary: Example request body + value: + enabled: true + max_open_pull_requests: 1 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether the pull request creation cap is enabled + max_open_pull_requests: + type: integer + description: The maximum number of open pull requests a user can + have at one time + minimum: 1 + maximum: 1000 + required: + - enabled + - max_open_pull_requests + examples: + default: + summary: Response + value: + enabled: true + max_open_pull_requests: 1 + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '405': + description: Method Not Allowed + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: orgs "/orgs/{org}/invitations": get: summary: List pending organization invitations @@ -28465,6 +28549,10 @@ paths: parent_team_id: type: integer description: The ID of a team to set as the parent team. + parent_team_slug: + type: string + description: The slug of a team to set as the parent team. Ignored + when `parent_team_id` is also provided. required: - name examples: @@ -28593,6 +28681,11 @@ paths: type: integer description: The ID of a team to set as the parent team. nullable: true + parent_team_slug: + type: string + description: The slug of a team to set as the parent team. Ignored + when `parent_team_id` is also provided. + nullable: true examples: default: value: @@ -28895,6 +28988,8 @@ paths: description: |- Lists a team's repositories visible to the authenticated user. + OAuth app tokens and personal access tokens (classic) need the `read:org` or `repo` scope to use this endpoint. + > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. tags: @@ -47145,10 +47240,9 @@ paths: Pending suggestions for each suggestible field (`type`, `issue_field_values`, `labels`, `assignees`, `state`) the request touched. Omitted for fields not in the request or - with no pending suggestions. Items tagged `already_applied` - are echoes of the current request's inputs whose target is - already applied to the issue; they are not persisted as - pending suggestions. + with no pending or ignored suggestions. Items tagged + `ignored` are echoes of the current request's inputs that + were not persisted as pending suggestions. properties: type: type: array @@ -47167,8 +47261,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed issue_field_values: type: array items: @@ -47193,8 +47292,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed labels: type: array items: @@ -47212,8 +47316,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed assignees: type: array items: @@ -47231,8 +47340,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed state: type: array items: @@ -47254,8 +47368,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed examples: default: "$ref": "#/components/examples/issue" @@ -52145,6 +52264,229 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async": + put: + summary: Merge a pull request asynchronously + description: |- + Merges a pull request into the base branch in the background. Merging in this way allows certain types of errors to be retried, and avoids the risk of timeouts for particularly complex merges. + + This is the required method for merging stacked PRs, but also supports unstacked PRs. When using this endpoint to merge a stacked pull request, all pull requests in the stack up to and including the requested PR will be merged into the base branch. + + The response includes a UUID that can be used to fetch the result of the merge. If another asynchronous merge request has already been made for this pull request, the UUID of that request will be returned instead with a 409 response status to indicate that the merge options may be different from those that were requested. If there isn't an existing asynchronous merge request, a 202 response status is used. + + If the pull request is already merged, the merge commit OID will be returned immediately with a 200 status. + + If the pull request cannot be merged (e.g. because it is closed, or still a draft) this result will be returned immediately with a 400 response status. Branch protection rules and repository rules are not run at this stage, only basic pull request state checks are performed. + tags: + - pulls + operationId: pulls/merge-async + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + commit_title: + type: string + description: Title for the automatic commit message. + commit_message: + type: string + description: Extra detail to append to automatic commit message. + sha: + type: string + description: SHA that pull request head must match to allow merge. + If not provided, the current head of the PR at the time of the + request will be used; if the PR is pushed in between the merge + being requested and being executed, the merge will be cancelled. + merge_method: + type: string + description: The merge method to use. + enum: + - merge + - squash + - rebase + merge_action: + type: string + description: The action that will be taken to merge the pull request. + `direct_merge` merges the pull request directly without using + a merge queue; `merge_queue` adds the pull request to a merge + queue; `default` selects the most appropriate option. + enum: + - default + - direct_merge + - merge_queue + examples: + default: + value: + commit_title: Fix race condition + commit_message: Avoids a race by trying to read the file and handling + the exception if it does not exist. + sha: 6358cd125586d9def8c3e5943f23506202da81cc + merge_method: squash + merge_action: default + responses: + '202': + description: if the merge request was accepted and will run in the background + content: + application/json: + schema: + "$ref": "#/components/schemas/pull-request-merge-async-result" + examples: + response-if-merge-request-was-accepted: + summary: Request accepted + value: + status: pending + details: + message: Merge request enqueued. + uuid: 630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42 + merge_method: merge + merge_action: default + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + '200': + description: if the pull request was already merged, or is already in a + merge queue + content: + application/json: + schema: + "$ref": "#/components/schemas/pull-request-merge-async-result" + examples: + response-if-pull-request-was-already-merged: + summary: Already merged + value: + status: merged + details: + message: Pull request is already merged. + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + response-if-pull-request-is-already-enqueued: + summary: Already enqueued + value: + status: enqueued + details: + message: Pull request is already in the merge queue. + '409': + description: if there is an existing merge request already enqueued for + this pull request + content: + application/json: + schema: + "$ref": "#/components/schemas/pull-request-merge-async-result" + examples: + response-if-a-merge-request-already-exists: + value: + status: pending + details: + message: A merge request already exists for this pull request. + uuid: 630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42 + merge_method: squash + merge_action: default + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + '400': + description: if the pull request is not ready to be merged, e.g. because + it is closed + content: + application/json: + schema: + "$ref": "#/components/schemas/pull-request-merge-async-result" + examples: + response-if-pull-request-is-not-ready-to-be-merged: + value: + status: failed + details: + message: Pull request is closed. + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}": + get: + summary: Get the result of an asynchronous merge + description: |- + Fetches the current result of an asynchronous merge request, identified by the UUID that was returned when the merge was requested. + + While the merge is still queued, the response includes the UUID, merge method, and expected head SHA of the request. Once the merge has completed, the response reports whether it was merged, including the merge commit OID on success or a message describing why it could not be merged on failure. + + The result of an asynchronous merge request is retained for 24 hours after its most recent update. After this window the request expires and this endpoint returns a `404` response for its UUID. + tags: + - pulls + operationId: pulls/get-merge-async-result + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#get-the-result-of-an-asynchronous-merge + x-github: + triggersNotification: false + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + - name: uuid + description: The UUID of the asynchronous merge request, as returned when + the merge was requested. + in: path + required: true + schema: + type: string + responses: + '200': + description: the current result of the asynchronous merge request + content: + application/json: + schema: + "$ref": "#/components/schemas/pull-request-merge-async-result" + examples: + response-if-the-merge-is-still-queued: + summary: Still queued + value: + status: pending + details: + message: Merge request is in progress. + uuid: 630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42 + merge_method: merge + merge_action: default + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + response-if-the-pull-request-is-enqueued: + summary: Enqueued in the merge queue + value: + status: enqueued + details: + message: Pull request is in the merge queue. + response-if-the-merge-succeeded: + summary: Merge succeeded + value: + status: merged + details: + message: Pull request was merged. + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + response-if-the-merge-failed: + summary: Merge failed + value: + status: failed + details: + message: 'Merge conflict: the pull request could not be merged.' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": get: summary: Get all requested reviewers for a pull request @@ -58082,6 +58424,11 @@ paths: type: integer description: The ID of a team to set as the parent team. nullable: true + parent_team_slug: + type: string + description: The slug of a team to set as the parent team. Ignored + when `parent_team_id` is also provided. + nullable: true required: - name examples: @@ -91258,6 +91605,12 @@ components: type: string example: - example.com + storage: + type: array + items: + type: string + example: + - example.com actions: type: array items: @@ -104250,6 +104603,21 @@ components: format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true + git-user: + title: Git User + description: Metaproperties for Git author/committer information. + type: object + properties: + name: + type: string + example: '"Chris Wanstrath"' + email: + type: string + example: '"chris@ozmm.org"' + date: + type: string + format: date-time + example: '"2007-10-29T02:42:39.000-07:00"' verification: title: Verification type: object @@ -112417,6 +112785,75 @@ components: - merged - message - sha + pull-request-merge-async-result: + title: Pull Request Merge Async Result + description: Pull Request Merge Async Result + type: object + additionalProperties: false + properties: + status: + type: string + enum: + - pending + - merged + - enqueued + - failed + details: + oneOf: + - description: When an asynchronous merge request was created or already + existed + type: object + additionalProperties: false + properties: + message: + type: string + uuid: + type: string + merge_method: + type: string + enum: + - default + - merge + - squash + - rebase + merge_action: + type: string + enum: + - default + - merge_queue + - direct_merge + expected_head_sha: + type: string + description: SHA that the pull request head must match for the enqueued + merge to proceed. + required: + - message + - uuid + - merge_method + - merge_action + - expected_head_sha + - description: When the pull request cannot be merged + type: object + additionalProperties: false + properties: + message: + type: string + required: + - message + - description: When the pull request is already merged + type: object + additionalProperties: false + properties: + message: + type: string + sha: + type: string + required: + - message + - sha + required: + - status + - details pull-request-review-request: title: Pull Request Review Request description: Pull Request Review Request diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 38af8ee8ea..44cdbd1cf4 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -11235,7 +11235,7 @@ "/meta": { "get": { "summary": "Get GitHub 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/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/articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names, and the public keys used by GitHub to sign commits made through the web UI.\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" ], @@ -29510,6 +29510,121 @@ } } }, + "/orgs/{org}/interaction-limits/pulls/creation-cap": { + "patch": { + "summary": "Update pull request creation cap for an org", + "description": "Updates the pull request creation cap for an organization. The cap limits the total number\nof open pull requests a user can have across all public repositories in the organization\nat one time.\n\nOnly users with admin access to the organization can configure the cap.", + "tags": [ + "interactions" + ], + "operationId": "interactions/update-pull-request-creation-cap-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/orgs#update-pull-request-creation-cap-for-an-org" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pull request creation cap is enabled" + }, + "max_open_pull_requests": { + "type": "integer", + "description": "The maximum number of open pull requests a user can have at one time", + "minimum": 1, + "maximum": 1000 + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "enabled": true, + "max_open_pull_requests": 1 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pull request creation cap is enabled" + }, + "max_open_pull_requests": { + "type": "integer", + "description": "The maximum number of open pull requests a user can have at one time", + "minimum": 1, + "maximum": 1000 + } + }, + "required": [ + "enabled", + "max_open_pull_requests" + ] + }, + "examples": { + "default": { + "summary": "Response", + "value": { + "enabled": true, + "max_open_pull_requests": 1 + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "405": { + "description": "Method Not Allowed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/invitations": { "get": { "summary": "List pending organization invitations", @@ -38766,6 +38881,10 @@ "parent_team_id": { "type": "integer", "description": "The ID of a team to set as the parent team." + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided." } }, "required": [ @@ -38948,6 +39067,11 @@ "type": "integer", "description": "The ID of a team to set as the parent team.", "nullable": true + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided.", + "nullable": true } } }, @@ -39355,7 +39479,7 @@ "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", - "description": "Lists a team's repositories 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}/repos`.", + "description": "Lists a team's repositories visible to the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` or `repo` scope to use this endpoint.\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`.", "tags": [ "teams" ], @@ -64225,7 +64349,7 @@ "properties": { "suggestions": { "type": "object", - "description": "Pending suggestions for each suggestible field (`type`,\n`issue_field_values`, `labels`, `assignees`, `state`) the\nrequest touched. Omitted for fields not in the request or\nwith no pending suggestions. Items tagged `already_applied`\nare echoes of the current request's inputs whose target is\nalready applied to the issue; they are not persisted as\npending suggestions.\n", + "description": "Pending suggestions for each suggestible field (`type`,\n`issue_field_values`, `labels`, `assignees`, `state`) the\nrequest touched. Omitted for fields not in the request or\nwith no pending or ignored suggestions. Items tagged\n`ignored` are echoes of the current request's inputs that\nwere not persisted as pending suggestions.\n", "properties": { "type": { "type": "array", @@ -64249,8 +64373,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -64293,8 +64424,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -64321,8 +64459,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -64349,8 +64494,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -64383,8 +64535,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -71349,6 +71508,305 @@ } } }, + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async": { + "put": { + "summary": "Merge a pull request asynchronously", + "description": "Merges a pull request into the base branch in the background. Merging in this way allows certain types of errors to be retried, and avoids the risk of timeouts for particularly complex merges.\n\nThis is the required method for merging stacked PRs, but also supports unstacked PRs. When using this endpoint to merge a stacked pull request, all pull requests in the stack up to and including the requested PR will be merged into the base branch.\n\nThe response includes a UUID that can be used to fetch the result of the merge. If another asynchronous merge request has already been made for this pull request, the UUID of that request will be returned instead with a 409 response status to indicate that the merge options may be different from those that were requested. If there isn't an existing asynchronous merge request, a 202 response status is used.\n\nIf the pull request is already merged, the merge commit OID will be returned immediately with a 200 status.\n\nIf the pull request cannot be merged (e.g. because it is closed, or still a draft) this result will be returned immediately with a 400 response status. Branch protection rules and repository rules are not run at this stage, only basic pull request state checks are performed.", + "tags": [ + "pulls" + ], + "operationId": "pulls/merge-async", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously" + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "commit_title": { + "type": "string", + "description": "Title for the automatic commit message." + }, + "commit_message": { + "type": "string", + "description": "Extra detail to append to automatic commit message." + }, + "sha": { + "type": "string", + "description": "SHA that pull request head must match to allow merge. If not provided, the current head of the PR at the time of the request will be used; if the PR is pushed in between the merge being requested and being executed, the merge will be cancelled." + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "description": "The action that will be taken to merge the pull request. `direct_merge` merges the pull request directly without using a merge queue; `merge_queue` adds the pull request to a merge queue; `default` selects the most appropriate option.", + "enum": [ + "default", + "direct_merge", + "merge_queue" + ] + } + } + }, + "examples": { + "default": { + "value": { + "commit_title": "Fix race condition", + "commit_message": "Avoids a race by trying to read the file and handling the exception if it does not exist.", + "sha": "6358cd125586d9def8c3e5943f23506202da81cc", + "merge_method": "squash", + "merge_action": "default" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "if the merge request was accepted and will run in the background", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-async-result" + }, + "examples": { + "response-if-merge-request-was-accepted": { + "summary": "Request accepted", + "value": { + "status": "pending", + "details": { + "message": "Merge request enqueued.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "merge", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + } + } + } + } + }, + "200": { + "description": "if the pull request was already merged, or is already in a merge queue", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-async-result" + }, + "examples": { + "response-if-pull-request-was-already-merged": { + "summary": "Already merged", + "value": { + "status": "merged", + "details": { + "message": "Pull request is already merged.", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + }, + "response-if-pull-request-is-already-enqueued": { + "summary": "Already enqueued", + "value": { + "status": "enqueued", + "details": { + "message": "Pull request is already in the merge queue." + } + } + } + } + } + } + }, + "409": { + "description": "if there is an existing merge request already enqueued for this pull request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-async-result" + }, + "examples": { + "response-if-a-merge-request-already-exists": { + "value": { + "status": "pending", + "details": { + "message": "A merge request already exists for this pull request.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "squash", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + } + } + } + } + }, + "400": { + "description": "if the pull request is not ready to be merged, e.g. because it is closed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-async-result" + }, + "examples": { + "response-if-pull-request-is-not-ready-to-be-merged": { + "value": { + "status": "failed", + "details": { + "message": "Pull request is closed." + } + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}": { + "get": { + "summary": "Get the result of an asynchronous merge", + "description": "Fetches the current result of an asynchronous merge request, identified by the UUID that was returned when the merge was requested.\n\nWhile the merge is still queued, the response includes the UUID, merge method, and expected head SHA of the request. Once the merge has completed, the response reports whether it was merged, including the merge commit OID on success or a message describing why it could not be merged on failure.\n\nThe result of an asynchronous merge request is retained for 24 hours after its most recent update. After this window the request expires and this endpoint returns a `404` response for its UUID.", + "tags": [ + "pulls" + ], + "operationId": "pulls/get-merge-async-result", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#get-the-result-of-an-asynchronous-merge" + }, + "x-github": { + "triggersNotification": false, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + }, + { + "name": "uuid", + "description": "The UUID of the asynchronous merge request, as returned when the merge was requested.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "the current result of the asynchronous merge request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-async-result" + }, + "examples": { + "response-if-the-merge-is-still-queued": { + "summary": "Still queued", + "value": { + "status": "pending", + "details": { + "message": "Merge request is in progress.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "merge", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + }, + "response-if-the-pull-request-is-enqueued": { + "summary": "Enqueued in the merge queue", + "value": { + "status": "enqueued", + "details": { + "message": "Pull request is in the merge queue." + } + } + }, + "response-if-the-merge-succeeded": { + "summary": "Merge succeeded", + "value": { + "status": "merged", + "details": { + "message": "Pull request was merged.", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + }, + "response-if-the-merge-failed": { + "summary": "Merge failed", + "value": { + "status": "failed", + "details": { + "message": "Merge conflict: the pull request could not be merged." + } + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + } + }, "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { "summary": "Get all requested reviewers for a pull request", @@ -79612,6 +80070,11 @@ "type": "integer", "description": "The ID of a team to set as the parent team.", "nullable": true + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided.", + "nullable": true } }, "required": [ @@ -125936,6 +126399,15 @@ ] } }, + "storage": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, "actions": { "type": "array", "items": { @@ -142920,6 +143392,26 @@ }, "nullable": true }, + "git-user": { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "\"Chris Wanstrath\"" + }, + "email": { + "type": "string", + "example": "\"chris@ozmm.org\"" + }, + "date": { + "type": "string", + "format": "date-time", + "example": "\"2007-10-29T02:42:39.000-07:00\"" + } + } + }, "verification": { "title": "Verification", "type": "object", @@ -153854,6 +154346,102 @@ "sha" ] }, + "pull-request-merge-async-result": { + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", + "type": "object", + "additionalProperties": false, + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] + }, + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] + } + }, + "required": [ + "status", + "details" + ] + }, "pull-request-review-request": { "title": "Pull Request Review Request", "description": "Pull Request Review Request", diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index d8db2a935d..0045935c4a 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -8332,7 +8332,7 @@ paths: 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/articles/about-github-s-ip-addresses/)." - The API's response also includes a list of GitHub's domain names. + The API's response also includes a list of GitHub's domain names, and the public keys used by GitHub to sign commits made through the web UI. The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. @@ -21947,6 +21947,90 @@ paths: enabledForGitHubApps: true category: interactions subcategory: orgs + "/orgs/{org}/interaction-limits/pulls/creation-cap": + patch: + summary: Update pull request creation cap for an org + description: |- + Updates the pull request creation cap for an organization. The cap limits the total number + of open pull requests a user can have across all public repositories in the organization + at one time. + + Only users with admin access to the organization can configure the cap. + tags: + - interactions + operationId: interactions/update-pull-request-creation-cap-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/interactions/orgs#update-pull-request-creation-cap-for-an-org + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether the pull request creation cap is enabled + max_open_pull_requests: + type: integer + description: The maximum number of open pull requests a user can + have at one time + minimum: 1 + maximum: 1000 + required: + - enabled + examples: + default: + summary: Example request body + value: + enabled: true + max_open_pull_requests: 1 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether the pull request creation cap is enabled + max_open_pull_requests: + type: integer + description: The maximum number of open pull requests a user can + have at one time + minimum: 1 + maximum: 1000 + required: + - enabled + - max_open_pull_requests + examples: + default: + summary: Response + value: + enabled: true + max_open_pull_requests: 1 + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '405': + description: Method Not Allowed + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: orgs "/orgs/{org}/invitations": get: summary: List pending organization invitations @@ -28604,6 +28688,10 @@ paths: parent_team_id: type: integer description: The ID of a team to set as the parent team. + parent_team_slug: + type: string + description: The slug of a team to set as the parent team. Ignored + when `parent_team_id` is also provided. required: - name examples: @@ -28743,6 +28831,11 @@ paths: type: integer description: The ID of a team to set as the parent team. nullable: true + parent_team_slug: + type: string + description: The slug of a team to set as the parent team. Ignored + when `parent_team_id` is also provided. + nullable: true examples: default: value: @@ -29045,6 +29138,8 @@ paths: description: |- Lists a team's repositories visible to the authenticated user. + OAuth app tokens and personal access tokens (classic) need the `read:org` or `repo` scope to use this endpoint. + > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. tags: @@ -47395,10 +47490,9 @@ paths: Pending suggestions for each suggestible field (`type`, `issue_field_values`, `labels`, `assignees`, `state`) the request touched. Omitted for fields not in the request or - with no pending suggestions. Items tagged `already_applied` - are echoes of the current request's inputs whose target is - already applied to the issue; they are not persisted as - pending suggestions. + with no pending or ignored suggestions. Items tagged + `ignored` are echoes of the current request's inputs that + were not persisted as pending suggestions. properties: type: type: array @@ -47417,8 +47511,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed issue_field_values: type: array items: @@ -47443,8 +47542,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed labels: type: array items: @@ -47462,8 +47566,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed assignees: type: array items: @@ -47481,8 +47590,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed state: type: array items: @@ -47504,8 +47618,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed examples: default: "$ref": "#/components/examples/issue" @@ -52405,6 +52524,229 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async": + put: + summary: Merge a pull request asynchronously + description: |- + Merges a pull request into the base branch in the background. Merging in this way allows certain types of errors to be retried, and avoids the risk of timeouts for particularly complex merges. + + This is the required method for merging stacked PRs, but also supports unstacked PRs. When using this endpoint to merge a stacked pull request, all pull requests in the stack up to and including the requested PR will be merged into the base branch. + + The response includes a UUID that can be used to fetch the result of the merge. If another asynchronous merge request has already been made for this pull request, the UUID of that request will be returned instead with a 409 response status to indicate that the merge options may be different from those that were requested. If there isn't an existing asynchronous merge request, a 202 response status is used. + + If the pull request is already merged, the merge commit OID will be returned immediately with a 200 status. + + If the pull request cannot be merged (e.g. because it is closed, or still a draft) this result will be returned immediately with a 400 response status. Branch protection rules and repository rules are not run at this stage, only basic pull request state checks are performed. + tags: + - pulls + operationId: pulls/merge-async + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + commit_title: + type: string + description: Title for the automatic commit message. + commit_message: + type: string + description: Extra detail to append to automatic commit message. + sha: + type: string + description: SHA that pull request head must match to allow merge. + If not provided, the current head of the PR at the time of the + request will be used; if the PR is pushed in between the merge + being requested and being executed, the merge will be cancelled. + merge_method: + type: string + description: The merge method to use. + enum: + - merge + - squash + - rebase + merge_action: + type: string + description: The action that will be taken to merge the pull request. + `direct_merge` merges the pull request directly without using + a merge queue; `merge_queue` adds the pull request to a merge + queue; `default` selects the most appropriate option. + enum: + - default + - direct_merge + - merge_queue + examples: + default: + value: + commit_title: Fix race condition + commit_message: Avoids a race by trying to read the file and handling + the exception if it does not exist. + sha: 6358cd125586d9def8c3e5943f23506202da81cc + merge_method: squash + merge_action: default + responses: + '202': + description: if the merge request was accepted and will run in the background + content: + application/json: + schema: + "$ref": "#/components/schemas/pull-request-merge-async-result" + examples: + response-if-merge-request-was-accepted: + summary: Request accepted + value: + status: pending + details: + message: Merge request enqueued. + uuid: 630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42 + merge_method: merge + merge_action: default + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + '200': + description: if the pull request was already merged, or is already in a + merge queue + content: + application/json: + schema: + "$ref": "#/components/schemas/pull-request-merge-async-result" + examples: + response-if-pull-request-was-already-merged: + summary: Already merged + value: + status: merged + details: + message: Pull request is already merged. + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + response-if-pull-request-is-already-enqueued: + summary: Already enqueued + value: + status: enqueued + details: + message: Pull request is already in the merge queue. + '409': + description: if there is an existing merge request already enqueued for + this pull request + content: + application/json: + schema: + "$ref": "#/components/schemas/pull-request-merge-async-result" + examples: + response-if-a-merge-request-already-exists: + value: + status: pending + details: + message: A merge request already exists for this pull request. + uuid: 630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42 + merge_method: squash + merge_action: default + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + '400': + description: if the pull request is not ready to be merged, e.g. because + it is closed + content: + application/json: + schema: + "$ref": "#/components/schemas/pull-request-merge-async-result" + examples: + response-if-pull-request-is-not-ready-to-be-merged: + value: + status: failed + details: + message: Pull request is closed. + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}": + get: + summary: Get the result of an asynchronous merge + description: |- + Fetches the current result of an asynchronous merge request, identified by the UUID that was returned when the merge was requested. + + While the merge is still queued, the response includes the UUID, merge method, and expected head SHA of the request. Once the merge has completed, the response reports whether it was merged, including the merge commit OID on success or a message describing why it could not be merged on failure. + + The result of an asynchronous merge request is retained for 24 hours after its most recent update. After this window the request expires and this endpoint returns a `404` response for its UUID. + tags: + - pulls + operationId: pulls/get-merge-async-result + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#get-the-result-of-an-asynchronous-merge + x-github: + triggersNotification: false + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pull-number" + - name: uuid + description: The UUID of the asynchronous merge request, as returned when + the merge was requested. + in: path + required: true + schema: + type: string + responses: + '200': + description: the current result of the asynchronous merge request + content: + application/json: + schema: + "$ref": "#/components/schemas/pull-request-merge-async-result" + examples: + response-if-the-merge-is-still-queued: + summary: Still queued + value: + status: pending + details: + message: Merge request is in progress. + uuid: 630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42 + merge_method: merge + merge_action: default + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + response-if-the-pull-request-is-enqueued: + summary: Enqueued in the merge queue + value: + status: enqueued + details: + message: Pull request is in the merge queue. + response-if-the-merge-succeeded: + summary: Merge succeeded + value: + status: merged + details: + message: Pull request was merged. + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + response-if-the-merge-failed: + summary: Merge failed + value: + status: failed + details: + message: 'Merge conflict: the pull request could not be merged.' + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": get: summary: Get all requested reviewers for a pull request @@ -58342,6 +58684,11 @@ paths: type: integer description: The ID of a team to set as the parent team. nullable: true + parent_team_slug: + type: string + description: The slug of a team to set as the parent team. Ignored + when `parent_team_id` is also provided. + nullable: true required: - name examples: @@ -92121,6 +92468,12 @@ components: type: string example: - example.com + storage: + type: array + items: + type: string + example: + - example.com actions: type: array items: @@ -105501,6 +105854,21 @@ components: format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true + git-user: + title: Git User + description: Metaproperties for Git author/committer information. + type: object + properties: + name: + type: string + example: '"Chris Wanstrath"' + email: + type: string + example: '"chris@ozmm.org"' + date: + type: string + format: date-time + example: '"2007-10-29T02:42:39.000-07:00"' verification: title: Verification type: object @@ -113835,6 +114203,75 @@ components: - merged - message - sha + pull-request-merge-async-result: + title: Pull Request Merge Async Result + description: Pull Request Merge Async Result + type: object + additionalProperties: false + properties: + status: + type: string + enum: + - pending + - merged + - enqueued + - failed + details: + oneOf: + - description: When an asynchronous merge request was created or already + existed + type: object + additionalProperties: false + properties: + message: + type: string + uuid: + type: string + merge_method: + type: string + enum: + - default + - merge + - squash + - rebase + merge_action: + type: string + enum: + - default + - merge_queue + - direct_merge + expected_head_sha: + type: string + description: SHA that the pull request head must match for the enqueued + merge to proceed. + required: + - message + - uuid + - merge_method + - merge_action + - expected_head_sha + - description: When the pull request cannot be merged + type: object + additionalProperties: false + properties: + message: + type: string + required: + - message + - description: When the pull request is already merged + type: object + additionalProperties: false + properties: + message: + type: string + sha: + type: string + required: + - message + - sha + required: + - status + - details pull-request-review-request: title: Pull Request Review Request description: Pull Request Review Request 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 0b0d689ddf..711cad54b1 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 @@ -61528,7 +61528,7 @@ "/meta": { "get": { "summary": "Get GitHub 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/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/articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names, and the public keys used by GitHub to sign commits made through the web UI.\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" ], @@ -61743,6 +61743,15 @@ ] } }, + "storage": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, "actions": { "type": "array", "items": { @@ -151444,6 +151453,255 @@ } } }, + "/orgs/{org}/interaction-limits/pulls/creation-cap": { + "patch": { + "summary": "Update pull request creation cap for an org", + "description": "Updates the pull request creation cap for an organization. The cap limits the total number\nof open pull requests a user can have across all public repositories in the organization\nat one time.\n\nOnly users with admin access to the organization can configure the cap.", + "tags": [ + "interactions" + ], + "operationId": "interactions/update-pull-request-creation-cap-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/orgs#update-pull-request-creation-cap-for-an-org" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pull request creation cap is enabled" + }, + "max_open_pull_requests": { + "type": "integer", + "description": "The maximum number of open pull requests a user can have at one time", + "minimum": 1, + "maximum": 1000 + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "enabled": true, + "max_open_pull_requests": 1 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pull request creation cap is enabled" + }, + "max_open_pull_requests": { + "type": "integer", + "description": "The maximum number of open pull requests a user can have at one time", + "minimum": 1, + "maximum": 1000 + } + }, + "required": [ + "enabled", + "max_open_pull_requests" + ] + }, + "examples": { + "default": { + "summary": "Response", + "value": { + "enabled": true, + "max_open_pull_requests": 1 + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "405": { + "description": "Method Not Allowed", + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/invitations": { "get": { "summary": "List pending organization invitations", @@ -231738,6 +231996,10 @@ "parent_team_id": { "type": "integer", "description": "The ID of a team to set as the parent team." + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided." } }, "required": [ @@ -233130,6 +233392,11 @@ "type": "integer", "description": "The ID of a team to set as the parent team.", "nullable": true + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided.", + "nullable": true } } }, @@ -235307,7 +235574,7 @@ "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", - "description": "Lists a team's repositories 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}/repos`.", + "description": "Lists a team's repositories visible to the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` or `repo` scope to use this endpoint.\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`.", "tags": [ "teams" ], @@ -431111,7 +431378,7 @@ "properties": { "suggestions": { "type": "object", - "description": "Pending suggestions for each suggestible field (`type`,\n`issue_field_values`, `labels`, `assignees`, `state`) the\nrequest touched. Omitted for fields not in the request or\nwith no pending suggestions. Items tagged `already_applied`\nare echoes of the current request's inputs whose target is\nalready applied to the issue; they are not persisted as\npending suggestions.\n", + "description": "Pending suggestions for each suggestible field (`type`,\n`issue_field_values`, `labels`, `assignees`, `state`) the\nrequest touched. Omitted for fields not in the request or\nwith no pending or ignored suggestions. Items tagged\n`ignored` are echoes of the current request's inputs that\nwere not persisted as pending suggestions.\n", "properties": { "type": { "type": "array", @@ -431135,8 +431402,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -431179,8 +431453,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -431207,8 +431488,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -431235,8 +431523,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -431269,8 +431564,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -552186,200 +552488,1165 @@ "schema": { "type": "integer" } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "nullable": true, - "properties": { - "commit_title": { - "type": "string", - "description": "Title for the automatic commit message." - }, - "commit_message": { - "type": "string", - "description": "Extra detail to append to automatic commit message." - }, - "sha": { - "type": "string", - "description": "SHA that pull request head must match to allow merge." - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - } - }, - "examples": { - "response-if-merge-was-successful": { - "value": { - "commit_title": "Expand enum", - "commit_message": "Add a new value to the merge_method enum" - } - } - } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "commit_title": { + "type": "string", + "description": "Title for the automatic commit message." + }, + "commit_message": { + "type": "string", + "description": "Extra detail to append to automatic commit message." + }, + "sha": { + "type": "string", + "description": "SHA that pull request head must match to allow merge." + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + } + }, + "examples": { + "response-if-merge-was-successful": { + "value": { + "commit_title": "Expand enum", + "commit_message": "Add a new value to the merge_method enum" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "if merge was successful", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Result", + "description": "Pull Request Merge Result", + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "merged": { + "type": "boolean" + }, + "message": { + "type": "string" + } + }, + "required": [ + "merged", + "message", + "sha" + ] + }, + "examples": { + "response-if-merge-was-successful": { + "value": { + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "merged": true, + "message": "Pull Request successfully merged" + } + } + } + } + } + }, + "405": { + "description": "Method Not Allowed if merge cannot be performed", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-merge-cannot-be-performed": { + "value": { + "message": "Pull Request is not mergeable" + } + } + } + } + } + }, + "409": { + "description": "Conflict if sha was provided and pull request head did not match", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-sha-was-provided-and-pull-request-head-did-not-match": { + "value": { + "message": "Head branch was modified. Review and try the merge again." + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "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": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async": { + "put": { + "summary": "Merge a pull request asynchronously", + "description": "Merges a pull request into the base branch in the background. Merging in this way allows certain types of errors to be retried, and avoids the risk of timeouts for particularly complex merges.\n\nThis is the required method for merging stacked PRs, but also supports unstacked PRs. When using this endpoint to merge a stacked pull request, all pull requests in the stack up to and including the requested PR will be merged into the base branch.\n\nThe response includes a UUID that can be used to fetch the result of the merge. If another asynchronous merge request has already been made for this pull request, the UUID of that request will be returned instead with a 409 response status to indicate that the merge options may be different from those that were requested. If there isn't an existing asynchronous merge request, a 202 response status is used.\n\nIf the pull request is already merged, the merge commit OID will be returned immediately with a 200 status.\n\nIf the pull request cannot be merged (e.g. because it is closed, or still a draft) this result will be returned immediately with a 400 response status. Branch protection rules and repository rules are not run at this stage, only basic pull request state checks are performed.", + "tags": [ + "pulls" + ], + "operationId": "pulls/merge-async", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously" + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "commit_title": { + "type": "string", + "description": "Title for the automatic commit message." + }, + "commit_message": { + "type": "string", + "description": "Extra detail to append to automatic commit message." + }, + "sha": { + "type": "string", + "description": "SHA that pull request head must match to allow merge. If not provided, the current head of the PR at the time of the request will be used; if the PR is pushed in between the merge being requested and being executed, the merge will be cancelled." + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "description": "The action that will be taken to merge the pull request. `direct_merge` merges the pull request directly without using a merge queue; `merge_queue` adds the pull request to a merge queue; `default` selects the most appropriate option.", + "enum": [ + "default", + "direct_merge", + "merge_queue" + ] + } + } + }, + "examples": { + "default": { + "value": { + "commit_title": "Fix race condition", + "commit_message": "Avoids a race by trying to read the file and handling the exception if it does not exist.", + "sha": "6358cd125586d9def8c3e5943f23506202da81cc", + "merge_method": "squash", + "merge_action": "default" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "if the merge request was accepted and will run in the background", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", + "type": "object", + "additionalProperties": false, + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] + }, + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] + } + }, + "required": [ + "status", + "details" + ] + }, + "examples": { + "response-if-merge-request-was-accepted": { + "summary": "Request accepted", + "value": { + "status": "pending", + "details": { + "message": "Merge request enqueued.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "merge", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + } + } + } + } + }, + "200": { + "description": "if the pull request was already merged, or is already in a merge queue", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", + "type": "object", + "additionalProperties": false, + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] + }, + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] + } + }, + "required": [ + "status", + "details" + ] + }, + "examples": { + "response-if-pull-request-was-already-merged": { + "summary": "Already merged", + "value": { + "status": "merged", + "details": { + "message": "Pull request is already merged.", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + }, + "response-if-pull-request-is-already-enqueued": { + "summary": "Already enqueued", + "value": { + "status": "enqueued", + "details": { + "message": "Pull request is already in the merge queue." + } + } + } + } + } + } + }, + "409": { + "description": "if there is an existing merge request already enqueued for this pull request", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", + "type": "object", + "additionalProperties": false, + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] + }, + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] + } + }, + "required": [ + "status", + "details" + ] + }, + "examples": { + "response-if-a-merge-request-already-exists": { + "value": { + "status": "pending", + "details": { + "message": "A merge request already exists for this pull request.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "squash", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + } + } + } + } + }, + "400": { + "description": "if the pull request is not ready to be merged, e.g. because it is closed", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", + "type": "object", + "additionalProperties": false, + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] + }, + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] + } + }, + "required": [ + "status", + "details" + ] + }, + "examples": { + "response-if-pull-request-is-not-ready-to-be-merged": { + "value": { + "status": "failed", + "details": { + "message": "Pull request is closed." + } + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "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" + } + } + } + } + } + } + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}": { + "get": { + "summary": "Get the result of an asynchronous merge", + "description": "Fetches the current result of an asynchronous merge request, identified by the UUID that was returned when the merge was requested.\n\nWhile the merge is still queued, the response includes the UUID, merge method, and expected head SHA of the request. Once the merge has completed, the response reports whether it was merged, including the merge commit OID on success or a message describing why it could not be merged on failure.\n\nThe result of an asynchronous merge request is retained for 24 hours after its most recent update. After this window the request expires and this endpoint returns a `404` response for its UUID.", + "tags": [ + "pulls" + ], + "operationId": "pulls/get-merge-async-result", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#get-the-result-of-an-asynchronous-merge" + }, + "x-github": { + "triggersNotification": false, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "uuid", + "description": "The UUID of the asynchronous merge request, as returned when the merge was requested.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { - "description": "if merge was successful", + "description": "the current result of the asynchronous merge request", "content": { "application/json": { "schema": { - "title": "Pull Request Merge Result", - "description": "Pull Request Merge Result", + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", "type": "object", + "additionalProperties": false, "properties": { - "sha": { - "type": "string" - }, - "merged": { - "type": "boolean" + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] }, - "message": { - "type": "string" + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] } }, "required": [ - "merged", - "message", - "sha" + "status", + "details" ] }, "examples": { - "response-if-merge-was-successful": { + "response-if-the-merge-is-still-queued": { + "summary": "Still queued", "value": { - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "merged": true, - "message": "Pull Request successfully merged" - } - } - } - } - } - }, - "405": { - "description": "Method Not Allowed if merge cannot be performed", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "status": "pending", + "details": { + "message": "Merge request is in progress.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "merge", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } } - } - }, - "examples": { - "response-if-merge-cannot-be-performed": { + }, + "response-if-the-pull-request-is-enqueued": { + "summary": "Enqueued in the merge queue", "value": { - "message": "Pull Request is not mergeable" - } - } - } - } - } - }, - "409": { - "description": "Conflict if sha was provided and pull request head did not match", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "status": "enqueued", + "details": { + "message": "Pull request is in the merge queue." + } } - } - }, - "examples": { - "response-if-sha-was-provided-and-pull-request-head-did-not-match": { + }, + "response-if-the-merge-succeeded": { + "summary": "Merge succeeded", "value": { - "message": "Head branch was modified. Review and try the merge again." + "status": "merged", + "details": { + "message": "Pull request was merged.", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } + }, + "response-if-the-merge-failed": { + "summary": "Merge failed", + "value": { + "status": "failed", + "details": { + "message": "Merge conflict: the pull request could not be merged." } } } @@ -552439,13 +553706,6 @@ } } } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" } } }, @@ -626050,6 +627310,11 @@ "type": "integer", "description": "The ID of a team to set as the parent team.", "nullable": true + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided.", + "nullable": true } }, "required": [ 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 fc14a20054..12cd424f06 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 @@ -1030,7 +1030,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &718 + - &719 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -14323,7 +14323,7 @@ paths: properties: action: type: string - discussion: &815 + discussion: &816 title: Discussion description: A Discussion in a repository. type: object @@ -15068,7 +15068,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &730 + sub_issues_summary: &731 title: Sub-issues Summary type: object properties: @@ -15195,7 +15195,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &731 + issue_dependencies_summary: &732 title: Issue Dependencies Summary type: object properties: @@ -16008,7 +16008,7 @@ paths: type: string release: allOf: - - &642 + - &643 title: Release description: A release. type: object @@ -16079,7 +16079,7 @@ paths: author: *4 assets: type: array - items: &643 + items: &644 title: Release Asset description: Data related to a release. type: object @@ -16670,7 +16670,7 @@ paths: url: type: string format: uri - user: &739 + user: &740 title: Public User description: Public User type: object @@ -19734,7 +19734,7 @@ paths: 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/articles/about-github-s-ip-addresses/)." - The API's response also includes a list of GitHub's domain names. + The API's response also includes a list of GitHub's domain names, and the public keys used by GitHub to sign commits made through the web UI. The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. @@ -19888,6 +19888,12 @@ paths: type: string example: - example.com + storage: + type: array + items: + type: string + example: + - example.com actions: type: array items: @@ -22544,7 +22550,7 @@ paths: parameters: - *79 - *125 - - &791 + - &792 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 @@ -22656,7 +22662,7 @@ paths: - *125 - *126 - *127 - - &792 + - &793 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -22664,7 +22670,7 @@ paths: schema: type: string - *130 - - &793 + - &794 name: sku description: The SKU to query for usage. in: query @@ -30543,12 +30549,12 @@ paths: required: - subject_digests examples: - default: &772 + default: &773 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &773 + withPredicateType: &774 value: subject_digests: - sha256:abc123 @@ -30606,7 +30612,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &774 + default: &775 value: attestations_subject_digests: - sha256:abc: @@ -40097,6 +40103,86 @@ paths: enabledForGitHubApps: true category: interactions subcategory: orgs + "/orgs/{org}/interaction-limits/pulls/creation-cap": + patch: + summary: Update pull request creation cap for an org + description: |- + Updates the pull request creation cap for an organization. The cap limits the total number + of open pull requests a user can have across all public repositories in the organization + at one time. + + Only users with admin access to the organization can configure the cap. + tags: + - interactions + operationId: interactions/update-pull-request-creation-cap-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/interactions/orgs#update-pull-request-creation-cap-for-an-org + parameters: + - *79 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether the pull request creation cap is enabled + max_open_pull_requests: + type: integer + description: The maximum number of open pull requests a user can + have at one time + minimum: 1 + maximum: 1000 + required: + - enabled + examples: + default: + summary: Example request body + value: + enabled: true + max_open_pull_requests: 1 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether the pull request creation cap is enabled + max_open_pull_requests: + type: integer + description: The maximum number of open pull requests a user can + have at one time + minimum: 1 + maximum: 1000 + required: + - enabled + - max_open_pull_requests + examples: + default: + summary: Response + value: + enabled: true + max_open_pull_requests: 1 + '403': *29 + '404': *6 + '405': + description: Method Not Allowed + content: + application/json: + schema: *3 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: orgs "/orgs/{org}/invitations": get: summary: List pending organization invitations @@ -42616,7 +42702,7 @@ paths: parameters: - *79 - *270 - - &755 + - &756 name: repo_name description: repo_name parameter in: path @@ -43657,7 +43743,7 @@ paths: - nuget - container - *79 - - &756 + - &757 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -43698,7 +43784,7 @@ paths: default: *277 '403': *29 '401': *25 - '400': &758 + '400': &759 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -45795,7 +45881,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &846 + properties: &847 id: type: number description: The unique identifier of the status update. @@ -45843,7 +45929,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &847 + required: &848 - id - node_id - created_at @@ -46700,7 +46786,7 @@ paths: - updated_at - project_url examples: - default: &778 + default: &779 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -46877,7 +46963,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &779 + items: &780 type: object properties: name: @@ -46914,7 +47000,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &780 + iteration_configuration: &781 type: object description: The configuration for iteration fields. properties: @@ -46964,7 +47050,7 @@ paths: value: name: Due date data_type: date - single_select_field: &781 + single_select_field: &782 summary: Create a single select field value: name: Priority @@ -46991,7 +47077,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &782 + iteration_field: &783 summary: Create an iteration field value: name: Sprint @@ -47017,7 +47103,7 @@ paths: application/json: schema: *298 examples: - text_field: &783 + text_field: &784 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -47026,7 +47112,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: &784 + number_field: &785 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -47035,7 +47121,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: &785 + date_field: &786 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -47044,7 +47130,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: &786 + single_select_field: &787 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -47078,7 +47164,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &787 + iteration_field: &788 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -47124,7 +47210,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *294 - - &788 + - &789 name: field_id description: The unique identifier of the field. in: path @@ -47139,7 +47225,7 @@ paths: application/json: schema: *298 examples: - default: &789 + default: &790 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -48336,7 +48422,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &769 + schema: &770 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -48513,7 +48599,7 @@ paths: parameters: - *294 - *79 - - &790 + - &791 name: view_number description: The number that identifies the project view. in: path @@ -50480,7 +50566,7 @@ paths: - *79 - *17 - *19 - - &651 + - &652 name: targets description: | A comma-separated list of rule targets to filter by. @@ -50762,7 +50848,7 @@ paths: - repository_property rules: type: array - items: &652 + items: &653 title: Repository Rule type: object description: A repository rule. @@ -50824,7 +50910,7 @@ paths: type: string enum: - required_linear_history - - &649 + - &650 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -51463,7 +51549,7 @@ paths: type: boolean description: Copilot automatically reviews each new push to the pull request. - - &650 + - &651 title: license_compliance_scanning description: Enforce any added or changed dependencies to comply with the organization's license policy. @@ -51775,7 +51861,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *79 - - &653 + - &654 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 @@ -51790,7 +51876,7 @@ paths: in: query schema: type: string - - &654 + - &655 name: time_period description: |- The time period to filter by. @@ -51806,14 +51892,14 @@ paths: - week - month default: day - - &655 + - &656 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 - - &656 + - &657 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -51826,7 +51912,7 @@ paths: - bypass - all default: all - - &657 + - &658 name: evaluate_status description: |- The evaluate status to filter on. When specified, only rule suites resulting from rulesets with the specified evaluate status will be returned. @@ -51849,7 +51935,7 @@ paths: description: Response content: application/json: - schema: &658 + schema: &659 title: Rule Suites description: Response type: array @@ -51904,7 +51990,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &659 + default: &660 value: - id: 21 actor_id: 12 @@ -51948,7 +52034,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *79 - - &660 + - &661 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -51964,7 +52050,7 @@ paths: description: Response content: application/json: - schema: &661 + schema: &662 title: Rule Suite description: Response type: object @@ -52063,7 +52149,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &662 + default: &663 value: id: 21 actor_id: 12 @@ -52310,7 +52396,7 @@ paths: type: string format: date-time examples: - default: &664 + default: &665 value: - version_id: 3 actor: @@ -52363,7 +52449,7 @@ paths: description: Response content: application/json: - schema: &665 + schema: &666 allOf: - *343 - type: object @@ -52435,7 +52521,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *79 - - &666 + - &667 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -52446,7 +52532,7 @@ paths: enum: - open - resolved - - &667 + - &668 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -52456,7 +52542,7 @@ paths: required: false schema: type: string - - &668 + - &669 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -52467,7 +52553,7 @@ paths: required: false schema: type: string - - &669 + - &670 name: exclude_providers in: query description: |- @@ -52478,7 +52564,7 @@ paths: required: false schema: type: string - - &670 + - &671 name: providers in: query description: |- @@ -52489,7 +52575,7 @@ paths: required: false schema: type: string - - &671 + - &672 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -52498,7 +52584,7 @@ paths: required: false schema: type: string - - &672 + - &673 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -52517,7 +52603,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &673 + - &674 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. @@ -52532,7 +52618,7 @@ paths: - *63 - *19 - *17 - - &674 + - &675 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 @@ -52542,7 +52628,7 @@ paths: required: false schema: type: string - - &675 + - &676 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 @@ -52552,7 +52638,7 @@ paths: required: false schema: type: string - - &676 + - &677 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -52561,7 +52647,7 @@ paths: required: false schema: type: string - - &677 + - &678 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -52570,7 +52656,7 @@ paths: schema: type: boolean default: false - - &678 + - &679 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -52579,7 +52665,7 @@ paths: schema: type: boolean default: false - - &679 + - &680 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -52588,7 +52674,7 @@ paths: schema: type: boolean default: false - - &680 + - &681 name: is_bypassed in: query description: A boolean value (`true` or `false`) indicating whether to filter @@ -52599,7 +52685,7 @@ paths: required: false schema: type: boolean - - &681 + - &682 name: included_metadata in: query description: |- @@ -52610,7 +52696,7 @@ paths: required: false schema: type: string - - &682 + - &683 name: owner_email_hash in: query description: |- @@ -52648,14 +52734,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &683 + state: &684 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: &684 + resolution: &685 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -52772,8 +52858,8 @@ paths: pull request. ' - oneOf: &685 - - &687 + oneOf: &686 + - &688 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -52831,7 +52917,7 @@ paths: - blob_url - commit_sha - commit_url - - &688 + - &689 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. @@ -52886,7 +52972,7 @@ paths: - page_url - commit_sha - commit_url - - &689 + - &690 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -52906,7 +52992,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &690 + - &691 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -52926,7 +53012,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &691 + - &692 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -52946,7 +53032,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &692 + - &693 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -52960,7 +53046,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &693 + - &694 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -52974,7 +53060,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &694 + - &695 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -52988,7 +53074,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &695 + - &696 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. @@ -53008,7 +53094,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &696 + - &697 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. @@ -53028,7 +53114,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &697 + - &698 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. @@ -53048,7 +53134,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &698 + - &699 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. @@ -53068,7 +53154,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &699 + - &700 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. @@ -53320,7 +53406,7 @@ paths: subcategory: custom-patterns parameters: - *79 - - &700 + - &701 name: state description: Filter custom patterns by state. When absent, returns patterns in all states. @@ -53331,7 +53417,7 @@ paths: enum: - published - unpublished - - &701 + - &702 name: push_protection description: Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status. @@ -53342,7 +53428,7 @@ paths: enum: - enabled - disabled - - &702 + - &703 name: sort description: The property to sort the results by. in: query @@ -53436,7 +53522,7 @@ paths: - state - push_protection_enabled examples: - default: &703 + default: &704 value: - id: 1 name: Example Custom Pattern @@ -53499,7 +53585,7 @@ paths: patterns: type: array description: The list of custom patterns to create. - items: &704 + items: &705 title: Secret Scanning Custom Pattern To Create description: A custom pattern to create in a bulk operation. type: object @@ -53536,7 +53622,7 @@ paths: items: type: string examples: - default: &705 + default: &706 value: patterns: - name: Example Custom Pattern @@ -53562,7 +53648,7 @@ paths: description: The list of successfully created custom patterns. items: *344 examples: - default: &706 + default: &707 value: created_patterns: - id: 1 @@ -53614,7 +53700,7 @@ paths: errors: type: array description: List of validation errors for this pattern. - items: &707 + items: &708 title: Secret Scanning Custom Pattern Validation Error description: A validation error for a custom pattern in a batch operation. @@ -53668,7 +53754,7 @@ paths: type: array description: The list of custom patterns to delete. maxItems: 500 - items: &708 + items: &709 title: Secret Scanning Custom Pattern To Delete description: A custom pattern to delete in a bulk operation. type: object @@ -53691,7 +53777,7 @@ paths: - resolve_alerts default: delete_alerts examples: - default: &709 + default: &710 value: patterns: - pattern_id: 2 @@ -53737,7 +53823,7 @@ paths: required: true content: application/json: - schema: &710 + schema: &711 title: Secret Scanning Custom Pattern To Update description: Fields to update on a custom pattern. At least one updatable field (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, @@ -53778,7 +53864,7 @@ paths: type: string custom_pattern_version: *345 examples: - default: &711 + default: &712 value: pattern: updated_secret_[0-9A-Z]{16} start_delimiter: "[^0-9A-Za-z]" @@ -53795,7 +53881,7 @@ paths: application/json: schema: *344 examples: - default: &712 + default: &713 value: id: 1 name: Example Custom Pattern @@ -54099,7 +54185,7 @@ paths: application/json: schema: type: array - items: &716 + items: &717 description: A repository security advisory. type: object properties: @@ -54390,7 +54476,7 @@ paths: - private_fork additionalProperties: false examples: - default: &717 + default: &718 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -55616,6 +55702,10 @@ paths: parent_team_id: type: integer description: The ID of a team to set as the parent team. + parent_team_slug: + type: string + description: The slug of a team to set as the parent team. Ignored + when `parent_team_id` is also provided. required: - name examples: @@ -56109,6 +56199,11 @@ paths: type: integer description: The ID of a team to set as the parent team. nullable: true + parent_team_slug: + type: string + description: The slug of a team to set as the parent team. Ignored + when `parent_team_id` is also provided. + nullable: true examples: default: value: @@ -56243,7 +56338,7 @@ paths: application/json: schema: type: array - items: &733 + items: &734 title: Team Member description: A user that is a member of a team, including their role on the team and whether the membership is inherited from @@ -56362,7 +56457,7 @@ paths: - type - url examples: - default: &734 + default: &735 value: - login: octocat id: 1 @@ -56448,7 +56543,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &735 + response-if-user-is-a-team-maintainer: &736 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -56513,7 +56608,7 @@ paths: application/json: schema: *356 examples: - response-if-users-membership-with-team-is-now-pending: &736 + response-if-users-membership-with-team-is-now-pending: &737 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -56567,6 +56662,8 @@ paths: description: |- Lists a team's repositories visible to the authenticated user. + OAuth app tokens and personal access tokens (classic) need the `read:org` or `repo` scope to use this endpoint. + > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. tags: @@ -56627,7 +56724,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &737 + schema: &738 title: Team Repository description: A team's access to a repository. type: object @@ -57284,7 +57381,7 @@ paths: type: array items: *211 examples: - response-if-child-teams-exist: &738 + response-if-child-teams-exist: &739 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -62933,7 +63030,7 @@ paths: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &809 + properties: &810 url: type: string format: uri @@ -63018,7 +63115,7 @@ paths: nullable: true properties: *84 required: *85 - required: &810 + required: &811 - id - node_id - sha @@ -69113,7 +69210,7 @@ paths: check. type: array items: *94 - deployment: &802 + deployment: &803 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -70025,7 +70122,7 @@ paths: type: string format: date-time nullable: true - head_commit: &830 + head_commit: &831 title: Simple Commit description: A commit. type: object @@ -74771,14 +74868,14 @@ paths: type: integer machines: type: array - items: &744 + items: &745 type: object title: Codespace machine description: A description of the machine powering a codespace. properties: *481 required: *482 examples: - default: &745 + default: &746 value: total_count: 2 machines: @@ -77924,7 +78021,7 @@ paths: application/json: schema: type: array - items: &722 + items: &723 title: Status description: The status of a commit. type: object @@ -78893,7 +78990,7 @@ paths: - size - type - url - - &640 + - &641 title: Content File description: Content File type: object @@ -79507,7 +79604,7 @@ paths: items: type: object properties: - placeholder_id: &713 + placeholder_id: &714 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -85586,7 +85683,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &838 + last_response: &839 title: Hook Response type: object properties: @@ -86638,7 +86735,7 @@ paths: parameters: - *357 - *358 - - &767 + - &768 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -87357,7 +87454,7 @@ paths: type: array items: *559 examples: - default: &760 + default: &761 value: - id: 1 repository: @@ -89937,10 +90034,9 @@ paths: Pending suggestions for each suggestible field (`type`, `issue_field_values`, `labels`, `assignees`, `state`) the request touched. Omitted for fields not in the request or - with no pending suggestions. Items tagged `already_applied` - are echoes of the current request's inputs whose target is - already applied to the issue; they are not persisted as - pending suggestions. + with no pending or ignored suggestions. Items tagged + `ignored` are echoes of the current request's inputs that + were not persisted as pending suggestions. properties: type: type: array @@ -89959,8 +90055,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed issue_field_values: type: array items: @@ -89985,8 +90086,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed labels: type: array items: @@ -90004,8 +90110,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed assignees: type: array items: @@ -90023,8 +90134,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed state: type: array items: @@ -90046,8 +90162,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed examples: default: *571 '422': *15 @@ -99031,6 +99152,287 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async": + put: + summary: Merge a pull request asynchronously + description: |- + Merges a pull request into the base branch in the background. Merging in this way allows certain types of errors to be retried, and avoids the risk of timeouts for particularly complex merges. + + This is the required method for merging stacked PRs, but also supports unstacked PRs. When using this endpoint to merge a stacked pull request, all pull requests in the stack up to and including the requested PR will be merged into the base branch. + + The response includes a UUID that can be used to fetch the result of the merge. If another asynchronous merge request has already been made for this pull request, the UUID of that request will be returned instead with a 409 response status to indicate that the merge options may be different from those that were requested. If there isn't an existing asynchronous merge request, a 202 response status is used. + + If the pull request is already merged, the merge commit OID will be returned immediately with a 200 status. + + If the pull request cannot be merged (e.g. because it is closed, or still a draft) this result will be returned immediately with a 400 response status. Branch protection rules and repository rules are not run at this stage, only basic pull request state checks are performed. + tags: + - pulls + operationId: pulls/merge-async + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + parameters: + - *357 + - *358 + - *633 + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + commit_title: + type: string + description: Title for the automatic commit message. + commit_message: + type: string + description: Extra detail to append to automatic commit message. + sha: + type: string + description: SHA that pull request head must match to allow merge. + If not provided, the current head of the PR at the time of the + request will be used; if the PR is pushed in between the merge + being requested and being executed, the merge will be cancelled. + merge_method: + type: string + description: The merge method to use. + enum: + - merge + - squash + - rebase + merge_action: + type: string + description: The action that will be taken to merge the pull request. + `direct_merge` merges the pull request directly without using + a merge queue; `merge_queue` adds the pull request to a merge + queue; `default` selects the most appropriate option. + enum: + - default + - direct_merge + - merge_queue + examples: + default: + value: + commit_title: Fix race condition + commit_message: Avoids a race by trying to read the file and handling + the exception if it does not exist. + sha: 6358cd125586d9def8c3e5943f23506202da81cc + merge_method: squash + merge_action: default + responses: + '202': + description: if the merge request was accepted and will run in the background + content: + application/json: + schema: &636 + title: Pull Request Merge Async Result + description: Pull Request Merge Async Result + type: object + additionalProperties: false + properties: + status: + type: string + enum: + - pending + - merged + - enqueued + - failed + details: + oneOf: + - description: When an asynchronous merge request was created + or already existed + type: object + additionalProperties: false + properties: + message: + type: string + uuid: + type: string + merge_method: + type: string + enum: + - default + - merge + - squash + - rebase + merge_action: + type: string + enum: + - default + - merge_queue + - direct_merge + expected_head_sha: + type: string + description: SHA that the pull request head must match for + the enqueued merge to proceed. + required: + - message + - uuid + - merge_method + - merge_action + - expected_head_sha + - description: When the pull request cannot be merged + type: object + additionalProperties: false + properties: + message: + type: string + required: + - message + - description: When the pull request is already merged + type: object + additionalProperties: false + properties: + message: + type: string + sha: + type: string + required: + - message + - sha + required: + - status + - details + examples: + response-if-merge-request-was-accepted: + summary: Request accepted + value: + status: pending + details: + message: Merge request enqueued. + uuid: 630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42 + merge_method: merge + merge_action: default + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + '200': + description: if the pull request was already merged, or is already in a + merge queue + content: + application/json: + schema: *636 + examples: + response-if-pull-request-was-already-merged: + summary: Already merged + value: + status: merged + details: + message: Pull request is already merged. + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + response-if-pull-request-is-already-enqueued: + summary: Already enqueued + value: + status: enqueued + details: + message: Pull request is already in the merge queue. + '409': + description: if there is an existing merge request already enqueued for + this pull request + content: + application/json: + schema: *636 + examples: + response-if-a-merge-request-already-exists: + value: + status: pending + details: + message: A merge request already exists for this pull request. + uuid: 630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42 + merge_method: squash + merge_action: default + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + '400': + description: if the pull request is not ready to be merged, e.g. because + it is closed + content: + application/json: + schema: *636 + examples: + response-if-pull-request-is-not-ready-to-be-merged: + value: + status: failed + details: + message: Pull request is closed. + '422': *15 + '403': *29 + '404': *6 + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}": + get: + summary: Get the result of an asynchronous merge + description: |- + Fetches the current result of an asynchronous merge request, identified by the UUID that was returned when the merge was requested. + + While the merge is still queued, the response includes the UUID, merge method, and expected head SHA of the request. Once the merge has completed, the response reports whether it was merged, including the merge commit OID on success or a message describing why it could not be merged on failure. + + The result of an asynchronous merge request is retained for 24 hours after its most recent update. After this window the request expires and this endpoint returns a `404` response for its UUID. + tags: + - pulls + operationId: pulls/get-merge-async-result + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#get-the-result-of-an-asynchronous-merge + x-github: + triggersNotification: false + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + parameters: + - *357 + - *358 + - *633 + - name: uuid + description: The UUID of the asynchronous merge request, as returned when + the merge was requested. + in: path + required: true + schema: + type: string + responses: + '200': + description: the current result of the asynchronous merge request + content: + application/json: + schema: *636 + examples: + response-if-the-merge-is-still-queued: + summary: Still queued + value: + status: pending + details: + message: Merge request is in progress. + uuid: 630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42 + merge_method: merge + merge_action: default + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + response-if-the-pull-request-is-enqueued: + summary: Enqueued in the merge queue + value: + status: enqueued + details: + message: Pull request is in the merge queue. + response-if-the-merge-succeeded: + summary: Merge succeeded + value: + status: merged + details: + message: Pull request was merged. + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + response-if-the-merge-failed: + summary: Merge failed + value: + status: failed + details: + message: 'Merge conflict: the pull request could not be merged.' + '403': *29 + '404': *6 "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": get: summary: Get all requested reviewers for a pull request @@ -100251,7 +100653,7 @@ paths: application/json: schema: type: array - items: &636 + items: &637 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -100490,9 +100892,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *637 examples: - default: &638 + default: &639 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -100558,7 +100960,7 @@ paths: - *357 - *358 - *633 - - &637 + - &638 name: review_id description: The unique identifier of the review. in: path @@ -100570,9 +100972,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *637 examples: - default: &639 + default: &640 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -100634,7 +101036,7 @@ paths: - *357 - *358 - *633 - - *637 + - *638 requestBody: required: true content: @@ -100657,7 +101059,7 @@ paths: description: Response content: application/json: - schema: *636 + schema: *637 examples: default: value: @@ -100722,15 +101124,15 @@ paths: - *357 - *358 - *633 - - *637 + - *638 responses: '200': description: Response content: application/json: - schema: *636 + schema: *637 examples: - default: *638 + default: *639 '422': *7 '404': *6 x-github: @@ -100760,7 +101162,7 @@ paths: - *357 - *358 - *633 - - *637 + - *638 - *17 - *19 responses: @@ -100998,7 +101400,7 @@ paths: - *357 - *358 - *633 - - *637 + - *638 requestBody: required: true content: @@ -101026,7 +101428,7 @@ paths: description: Response content: application/json: - schema: *636 + schema: *637 examples: default: value: @@ -101092,7 +101494,7 @@ paths: - *357 - *358 - *633 - - *637 + - *638 requestBody: required: true content: @@ -101127,9 +101529,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *637 examples: - default: *639 + default: *640 '404': *6 '422': *7 '403': *29 @@ -101230,9 +101632,9 @@ paths: description: Response content: application/json: - schema: *640 + schema: *641 examples: - default: &641 + default: &642 value: type: file encoding: base64 @@ -101295,9 +101697,9 @@ paths: description: Response content: application/json: - schema: *640 + schema: *641 examples: - default: *641 + default: *642 '404': *6 '422': *15 x-github: @@ -101330,7 +101732,7 @@ paths: application/json: schema: type: array - items: *642 + items: *643 examples: default: value: @@ -101506,9 +101908,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: &646 + default: &647 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -101615,7 +102017,7 @@ paths: parameters: - *357 - *358 - - &644 + - &645 name: asset_id description: The unique identifier of the asset. in: path @@ -101627,9 +102029,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *644 examples: - default: &645 + default: &646 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 @@ -101682,7 +102084,7 @@ paths: parameters: - *357 - *358 - - *644 + - *645 requestBody: required: false content: @@ -101710,9 +102112,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *644 examples: - default: *645 + default: *646 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101730,7 +102132,7 @@ paths: parameters: - *357 - *358 - - *644 + - *645 responses: '204': description: Response @@ -101848,9 +102250,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: *646 + default: *647 '404': *6 x-github: githubCloudOnly: false @@ -101882,9 +102284,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: *646 + default: *647 '404': *6 x-github: githubCloudOnly: false @@ -101908,7 +102310,7 @@ paths: parameters: - *357 - *358 - - &647 + - &648 name: release_id description: The unique identifier of the release. in: path @@ -101922,9 +102324,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: *642 + schema: *643 examples: - default: *646 + default: *647 '401': description: Unauthorized x-github: @@ -101950,7 +102352,7 @@ paths: parameters: - *357 - *358 - - *647 + - *648 requestBody: required: false content: @@ -102014,9 +102416,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: *646 + default: *647 '404': description: Not Found if the discussion category name is invalid content: @@ -102039,7 +102441,7 @@ paths: parameters: - *357 - *358 - - *647 + - *648 responses: '204': description: Response @@ -102062,7 +102464,7 @@ paths: parameters: - *357 - *358 - - *647 + - *648 - *17 - *19 responses: @@ -102072,7 +102474,7 @@ paths: application/json: schema: type: array - items: *643 + items: *644 examples: default: value: @@ -102155,7 +102557,7 @@ paths: parameters: - *357 - *358 - - *647 + - *648 - name: name in: query required: true @@ -102181,7 +102583,7 @@ paths: description: Response for successful upload content: application/json: - schema: *643 + schema: *644 examples: response-for-successful-upload: value: @@ -102238,7 +102640,7 @@ paths: parameters: - *357 - *358 - - *647 + - *648 - 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. @@ -102287,7 +102689,7 @@ paths: parameters: - *357 - *358 - - *647 + - *648 requestBody: required: true content: @@ -102350,7 +102752,7 @@ paths: parameters: - *357 - *358 - - *647 + - *648 - *564 responses: '204': @@ -102394,7 +102796,7 @@ paths: oneOf: - allOf: - *319 - - &648 + - &649 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -102415,70 +102817,70 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *320 - - *648 + - *649 - allOf: - *321 - - *648 + - *649 - allOf: - *322 - - *648 + - *649 - allOf: + - *650 - *649 - - *648 - allOf: - *323 - - *648 + - *649 - allOf: - *324 - - *648 + - *649 - allOf: - *325 - - *648 + - *649 - allOf: - *326 - - *648 + - *649 - allOf: - *327 - - *648 + - *649 - allOf: - *328 - - *648 + - *649 - allOf: - *329 - - *648 + - *649 - allOf: - *330 - - *648 + - *649 - allOf: - *331 - - *648 + - *649 - allOf: - *332 - - *648 + - *649 - allOf: - *337 - - *648 + - *649 - allOf: - *338 - - *648 + - *649 - allOf: - *339 - - *648 + - *649 - allOf: - - *650 - - *648 + - *651 + - *649 - allOf: - *333 - - *648 + - *649 - allOf: - *334 - - *648 + - *649 - allOf: - *335 - - *648 + - *649 - allOf: - *336 - - *648 + - *649 examples: default: value: @@ -102529,7 +102931,7 @@ paths: schema: type: boolean default: true - - *651 + - *652 responses: '200': description: Response @@ -102614,7 +103016,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *652 + items: *653 required: - name - enforcement @@ -102647,7 +103049,7 @@ paths: application/json: schema: *340 examples: - default: &663 + default: &664 value: id: 42 name: super cool ruleset @@ -102697,11 +103099,11 @@ paths: parameters: - *357 - *358 - - *653 - *654 - *655 - *656 - *657 + - *658 - *17 - *19 responses: @@ -102709,9 +103111,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *659 examples: - default: *659 + default: *660 '404': *6 '500': *56 x-github: @@ -102734,15 +103136,15 @@ paths: parameters: - *357 - *358 - - *660 + - *661 responses: '200': description: Response content: application/json: - schema: *661 + schema: *662 examples: - default: *662 + default: *663 '404': *6 '500': *56 x-github: @@ -102793,7 +103195,7 @@ paths: application/json: schema: *340 examples: - default: *663 + default: *664 '404': *6 '500': *56 put: @@ -102846,7 +103248,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *652 + items: *653 examples: default: value: @@ -102876,7 +103278,7 @@ paths: application/json: schema: *340 examples: - default: *663 + default: *664 '404': *6 '422': *15 '500': *56 @@ -102938,7 +103340,7 @@ paths: type: array items: *343 examples: - default: *664 + default: *665 '404': *6 '500': *56 x-github: @@ -102976,7 +103378,7 @@ paths: description: Response content: application/json: - schema: *665 + schema: *666 examples: default: value: @@ -103033,7 +103435,6 @@ paths: parameters: - *357 - *358 - - *666 - *667 - *668 - *669 @@ -103041,10 +103442,10 @@ paths: - *671 - *672 - *673 + - *674 - *63 - *19 - *17 - - *674 - *675 - *676 - *677 @@ -103053,6 +103454,7 @@ paths: - *680 - *681 - *682 + - *683 responses: '200': description: Response @@ -103079,8 +103481,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *683 - resolution: *684 + state: *684 + resolution: *685 resolved_at: type: string format: date-time @@ -103186,7 +103588,7 @@ paths: pull request. ' - oneOf: *685 + oneOf: *686 nullable: true has_more_locations: type: boolean @@ -103353,13 +103755,13 @@ paths: - *357 - *358 - *457 - - *679 + - *680 responses: '200': description: Response content: application/json: - schema: &686 + schema: &687 type: object properties: number: *189 @@ -103377,8 +103779,8 @@ paths: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *683 - resolution: *684 + state: *684 + resolution: *685 resolved_at: type: string format: date-time @@ -103484,7 +103886,7 @@ paths: pull request. ' - oneOf: *685 + oneOf: *686 nullable: true has_more_locations: type: boolean @@ -103512,7 +103914,7 @@ paths: properties: *20 required: *21 nullable: true - metadata: &859 + metadata: &860 type: array description: A list of metadata key/value pairs associated with the secret scanning alert. @@ -103595,8 +103997,8 @@ paths: schema: type: object properties: - state: *683 - resolution: *684 + state: *684 + resolution: *685 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -103640,7 +104042,7 @@ paths: description: Response content: application/json: - schema: *686 + schema: *687 examples: default: value: @@ -103755,7 +104157,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &861 + items: &862 type: object properties: type: @@ -103781,7 +104183,6 @@ paths: example: commit details: oneOf: - - *687 - *688 - *689 - *690 @@ -103794,6 +104195,7 @@ paths: - *697 - *698 - *699 + - *700 examples: default: value: @@ -103884,9 +104286,9 @@ paths: parameters: - *357 - *358 - - *700 - *701 - *702 + - *703 - *63 - *19 - *17 @@ -103899,7 +104301,7 @@ paths: type: array items: *344 examples: - default: *703 + default: *704 headers: Link: *71 '403': *29 @@ -103936,9 +104338,9 @@ paths: patterns: type: array description: The list of custom patterns to create. - items: *704 + items: *705 examples: - default: *705 + default: *706 responses: '201': description: All patterns created successfully. @@ -103952,7 +104354,7 @@ paths: description: The list of successfully created custom patterns. items: *344 examples: - default: *706 + default: *707 '400': *14 '403': *29 '404': *6 @@ -103976,7 +104378,7 @@ paths: errors: type: array description: List of validation errors for this pattern. - items: *707 + items: *708 delete: summary: Bulk delete repository custom patterns description: |- @@ -104010,7 +104412,7 @@ paths: type: array description: The list of custom patterns to delete. maxItems: 500 - items: *708 + items: *709 post_delete_action: type: string description: |- @@ -104023,7 +104425,7 @@ paths: - resolve_alerts default: delete_alerts examples: - default: *709 + default: *710 responses: '204': description: All patterns deleted successfully. @@ -104062,9 +104464,9 @@ paths: required: true content: application/json: - schema: *710 + schema: *711 examples: - default: *711 + default: *712 responses: '200': description: Pattern updated successfully. @@ -104072,7 +104474,7 @@ paths: application/json: schema: *344 examples: - default: *712 + default: *713 '400': *14 '403': *29 '404': *6 @@ -104103,14 +104505,14 @@ paths: schema: type: object properties: - reason: &714 + reason: &715 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *713 + placeholder_id: *714 required: - reason - placeholder_id @@ -104127,7 +104529,7 @@ paths: schema: type: object properties: - reason: *714 + reason: *715 expire_at: type: string format: date-time @@ -104189,7 +104591,7 @@ paths: properties: incremental_scans: type: array - items: &715 + items: &716 description: Information on a single scan performed by secret scanning on the repository type: object @@ -104220,15 +104622,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *715 + items: *716 backfill_scans: type: array - items: *715 + items: *716 custom_pattern_backfill_scans: type: array items: allOf: - - *715 + - *716 - type: object properties: pattern_name: @@ -104241,7 +104643,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *715 + items: *716 examples: default: value: @@ -104351,9 +104753,9 @@ paths: application/json: schema: type: array - items: *716 + items: *717 examples: - default: *717 + default: *718 '400': *14 '404': *6 x-github: @@ -104537,9 +104939,9 @@ paths: description: Response content: application/json: - schema: *716 + schema: *717 examples: - default: &719 + default: &720 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -104877,7 +105279,7 @@ paths: description: Response content: application/json: - schema: *716 + schema: *717 examples: default: value: @@ -105026,15 +105428,15 @@ paths: parameters: - *357 - *358 - - *718 + - *719 responses: '200': description: Response content: application/json: - schema: *716 + schema: *717 examples: - default: *719 + default: *720 '403': *29 '404': *6 x-github: @@ -105060,7 +105462,7 @@ paths: parameters: - *357 - *358 - - *718 + - *719 requestBody: required: true content: @@ -105219,10 +105621,10 @@ paths: description: Response content: application/json: - schema: *716 + schema: *717 examples: - default: *719 - add_credit: *719 + default: *720 + add_credit: *720 '403': *29 '404': *6 '422': @@ -105262,7 +105664,7 @@ paths: parameters: - *357 - *358 - - *718 + - *719 responses: '202': *40 '400': *14 @@ -105291,7 +105693,7 @@ paths: parameters: - *357 - *358 - - *718 + - *719 responses: '202': description: Response @@ -105521,7 +105923,7 @@ paths: format: date-time pull_requests: type: array - items: &720 + items: &721 title: Pull Request Stack Pull Request type: object allOf: @@ -105797,7 +106199,7 @@ paths: format: date-time pull_requests: type: array - items: *720 + items: *721 examples: default: value: @@ -105990,7 +106392,7 @@ paths: format: date-time pull_requests: type: array - items: *720 + items: *721 examples: default: value: @@ -106244,7 +106646,7 @@ paths: format: date-time pull_requests: type: array - items: *720 + items: *721 examples: default: value: @@ -106460,7 +106862,7 @@ paths: application/json: schema: type: array - items: &721 + items: &722 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -106833,7 +107235,7 @@ paths: application/json: schema: type: array - items: *721 + items: *722 examples: default: value: @@ -106921,7 +107323,7 @@ paths: description: Response content: application/json: - schema: *722 + schema: *723 examples: default: value: @@ -107015,7 +107417,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &723 + schema: &724 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -107110,7 +107512,7 @@ paths: description: Response content: application/json: - schema: *723 + schema: *724 examples: default: value: @@ -107317,7 +107719,7 @@ paths: description: Response content: application/json: - schema: &724 + schema: &725 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -107329,7 +107731,7 @@ paths: required: - names examples: - default: &725 + default: &726 value: names: - octocat @@ -107384,9 +107786,9 @@ paths: description: Response content: application/json: - schema: *724 + schema: *725 examples: - default: *725 + default: *726 '404': *6 '422': *7 x-github: @@ -107409,7 +107811,7 @@ paths: parameters: - *357 - *358 - - &726 + - &727 name: per description: The time frame to display results for. in: query @@ -107438,7 +107840,7 @@ paths: example: 128 clones: type: array - items: &727 + items: &728 title: Traffic type: object properties: @@ -107679,7 +108081,7 @@ paths: parameters: - *357 - *358 - - *726 + - *727 responses: '200': description: Response @@ -107698,7 +108100,7 @@ paths: example: 3782 views: type: array - items: *727 + items: *728 required: - uniques - count @@ -108470,7 +108872,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &728 + text_matches: &729 title: Search Result Text Matches type: array items: @@ -108632,7 +109034,7 @@ paths: enum: - author-date - committer-date - - &729 + - &730 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 @@ -108760,7 +109162,7 @@ paths: type: number node_id: type: string - text_matches: *728 + text_matches: *729 required: - sha - node_id @@ -108952,7 +109354,7 @@ paths: - interactions - created - updated - - *729 + - *730 - *17 - *19 - name: advanced_search @@ -109066,8 +109468,8 @@ paths: description: type: string nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -109102,7 +109504,7 @@ paths: type: string format: date-time nullable: true - text_matches: *728 + text_matches: *729 pull_request: type: object properties: @@ -109384,7 +109786,7 @@ paths: enum: - created - updated - - *729 + - *730 - *17 - *19 responses: @@ -109428,7 +109830,7 @@ paths: nullable: true score: type: number - text_matches: *728 + text_matches: *729 required: - id - node_id @@ -109513,7 +109915,7 @@ paths: - forks - help-wanted-issues - updated - - *729 + - *730 - *17 - *19 responses: @@ -109761,7 +110163,7 @@ paths: - admin - pull - push - text_matches: *728 + text_matches: *729 temp_clone_token: type: string allow_merge_commit: @@ -110061,7 +110463,7 @@ paths: type: string format: uri nullable: true - text_matches: *728 + text_matches: *729 related: type: array nullable: true @@ -110252,7 +110654,7 @@ paths: - followers - repositories - joined - - *729 + - *730 - *17 - *19 responses: @@ -110356,7 +110758,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *728 + text_matches: *729 blog: type: string nullable: true @@ -110435,7 +110837,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &732 + - &733 name: team_id description: The unique identifier of the team. in: path @@ -110476,7 +110878,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *732 + - *733 requestBody: required: true content: @@ -110525,6 +110927,11 @@ paths: type: integer description: The ID of a team to set as the parent team. nullable: true + parent_team_slug: + type: string + description: The slug of a team to set as the parent team. Ignored + when `parent_team_id` is also provided. + nullable: true required: - name examples: @@ -110576,7 +110983,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *732 + - *733 responses: '204': description: Response @@ -110605,7 +111012,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *732 + - *733 - *17 - *19 responses: @@ -110645,7 +111052,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *732 + - *733 - name: role description: Filters members returned by their role in the team. in: query @@ -110666,9 +111073,9 @@ paths: application/json: schema: type: array - items: *733 + items: *734 examples: - default: *734 + default: *735 headers: Link: *71 '404': *6 @@ -110696,7 +111103,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *732 + - *733 - *75 responses: '204': @@ -110733,7 +111140,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *732 + - *733 - *75 responses: '204': @@ -110773,7 +111180,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *732 + - *733 - *75 responses: '204': @@ -110810,7 +111217,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *732 + - *733 - *75 responses: '200': @@ -110819,7 +111226,7 @@ paths: application/json: schema: *356 examples: - response-if-user-is-a-team-maintainer: *735 + response-if-user-is-a-team-maintainer: *736 '404': *6 x-github: githubCloudOnly: false @@ -110852,7 +111259,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *732 + - *733 - *75 requestBody: required: false @@ -110880,7 +111287,7 @@ paths: application/json: schema: *356 examples: - response-if-users-membership-with-team-is-now-pending: *736 + response-if-users-membership-with-team-is-now-pending: *737 '403': description: Forbidden if team synchronization is set up '422': @@ -110914,7 +111321,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *732 + - *733 - *75 responses: '204': @@ -110942,7 +111349,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *732 + - *733 - *17 - *19 responses: @@ -110984,7 +111391,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *732 + - *733 - *357 - *358 responses: @@ -110992,7 +111399,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *737 + schema: *738 examples: alternative-response-with-extra-repository-information: value: @@ -111143,7 +111550,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *732 + - *733 - *357 - *358 requestBody: @@ -111195,7 +111602,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *732 + - *733 - *357 - *358 responses: @@ -111222,7 +111629,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *732 + - *733 - *17 - *19 responses: @@ -111234,7 +111641,7 @@ paths: type: array items: *211 examples: - response-if-child-teams-exist: *738 + response-if-child-teams-exist: *739 headers: Link: *71 '404': *6 @@ -111267,7 +111674,7 @@ paths: application/json: schema: oneOf: - - &740 + - &741 title: Private User description: Private User type: object @@ -111470,7 +111877,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *739 + - *740 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -111623,7 +112030,7 @@ paths: description: Response content: application/json: - schema: *740 + schema: *741 examples: default: value: @@ -112021,7 +112428,7 @@ paths: type: integer secrets: type: array - items: &741 + items: &742 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -112137,7 +112544,7 @@ paths: description: Response content: application/json: - schema: *741 + schema: *742 examples: default: value: @@ -112550,7 +112957,7 @@ paths: description: Response content: application/json: - schema: &742 + schema: &743 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -112591,7 +112998,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &743 + default: &744 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -112636,9 +113043,9 @@ paths: description: Response content: application/json: - schema: *742 + schema: *743 examples: - default: *743 + default: *744 '404': *6 x-github: githubCloudOnly: false @@ -112675,9 +113082,9 @@ paths: type: integer machines: type: array - items: *744 + items: *745 examples: - default: *745 + default: *746 '304': *38 '500': *56 '401': *25 @@ -113616,7 +114023,7 @@ paths: type: array items: *276 examples: - default: &757 + default: &758 value: - id: 197 name: hello_docker @@ -113717,7 +114124,7 @@ paths: application/json: schema: type: array - items: &746 + items: &747 title: Email description: Email type: object @@ -113782,9 +114189,9 @@ paths: application/json: schema: type: array - items: *746 + items: *747 examples: - default: &759 + default: &760 value: - email: octocat@github.com verified: true @@ -113859,7 +114266,7 @@ paths: application/json: schema: type: array - items: *746 + items: *747 examples: default: value: @@ -114115,7 +114522,7 @@ paths: application/json: schema: type: array - items: &747 + items: &748 title: GPG Key description: A unique encryption key type: object @@ -114246,7 +114653,7 @@ paths: - subkeys - revoked examples: - default: &776 + default: &777 value: - id: 3 name: Octocat's GPG Key @@ -114331,9 +114738,9 @@ paths: description: Response content: application/json: - schema: *747 + schema: *748 examples: - default: &748 + default: &749 value: id: 3 name: Octocat's GPG Key @@ -114390,7 +114797,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &749 + - &750 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -114402,9 +114809,9 @@ paths: description: Response content: application/json: - schema: *747 + schema: *748 examples: - default: *748 + default: *749 '404': *6 '304': *38 '403': *29 @@ -114427,7 +114834,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *749 + - *750 responses: '204': description: Response @@ -114894,7 +115301,7 @@ paths: application/json: schema: type: array - items: &750 + items: &751 title: Key description: Key type: object @@ -114995,9 +115402,9 @@ paths: description: Response content: application/json: - schema: *750 + schema: *751 examples: - default: &751 + default: &752 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -115036,9 +115443,9 @@ paths: description: Response content: application/json: - schema: *750 + schema: *751 examples: - default: *751 + default: *752 '404': *6 '304': *38 '403': *29 @@ -115094,7 +115501,7 @@ paths: application/json: schema: type: array - items: &752 + items: &753 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -115162,7 +115569,7 @@ paths: - account - plan examples: - default: &753 + default: &754 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -115224,9 +115631,9 @@ paths: application/json: schema: type: array - items: *752 + items: *753 examples: - default: *753 + default: *754 headers: Link: *71 '304': *38 @@ -115469,7 +115876,7 @@ paths: application/json: schema: *267 examples: - default: &754 + default: &755 value: url: https://api.github.com/orgs/octocat/memberships/defunkt state: active @@ -115518,7 +115925,7 @@ paths: application/json: schema: *267 examples: - default: *754 + default: *755 '403': *29 '404': *6 '422': *15 @@ -116243,7 +116650,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *270 - - *755 + - *756 responses: '204': description: Response @@ -116358,7 +116765,7 @@ paths: - docker - nuget - container - - *756 + - *757 - *19 - *17 responses: @@ -116370,8 +116777,8 @@ paths: type: array items: *276 examples: - default: *757 - '400': *758 + default: *758 + '400': *759 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -116400,7 +116807,7 @@ paths: application/json: schema: *276 examples: - default: &777 + default: &778 value: id: 40201 name: octo-name @@ -116762,9 +117169,9 @@ paths: application/json: schema: type: array - items: *746 + items: *747 examples: - default: *759 + default: *760 headers: Link: *71 '304': *38 @@ -116877,7 +117284,7 @@ paths: type: array items: *83 examples: - default: &766 + default: &767 summary: Default response value: - id: 1296269 @@ -117223,7 +117630,7 @@ paths: type: array items: *559 examples: - default: *760 + default: *761 headers: Link: *71 '304': *38 @@ -117302,7 +117709,7 @@ paths: application/json: schema: type: array - items: &761 + items: &762 title: Social account description: Social media account type: object @@ -117317,7 +117724,7 @@ paths: - provider - url examples: - default: &762 + default: &763 value: - provider: twitter url: https://twitter.com/github @@ -117379,9 +117786,9 @@ paths: application/json: schema: type: array - items: *761 + items: *762 examples: - default: *762 + default: *763 '422': *15 '304': *38 '404': *6 @@ -117468,7 +117875,7 @@ paths: application/json: schema: type: array - items: &763 + items: &764 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -117488,7 +117895,7 @@ paths: - title - created_at examples: - default: &794 + default: &795 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -117552,9 +117959,9 @@ paths: description: Response content: application/json: - schema: *763 + schema: *764 examples: - default: &764 + default: &765 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -117584,7 +117991,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: - - &765 + - &766 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -117596,9 +118003,9 @@ paths: description: Response content: application/json: - schema: *763 + schema: *764 examples: - default: *764 + default: *765 '404': *6 '304': *38 '403': *29 @@ -117621,7 +118028,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: - - *765 + - *766 responses: '204': description: Response @@ -117650,7 +118057,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &795 + - &796 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 @@ -117675,11 +118082,11 @@ paths: type: array items: *83 examples: - default-response: *766 + default-response: *767 application/vnd.github.v3.star+json: schema: type: array - items: &796 + items: &797 title: Starred Repository description: Starred Repository type: object @@ -118048,10 +118455,10 @@ paths: application/json: schema: oneOf: + - *741 - *740 - - *739 examples: - default-response: &770 + default-response: &771 summary: Default response value: login: octocat @@ -118086,7 +118493,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &771 + response-with-git-hub-plan-information: &772 summary: Response with GitHub plan information value: login: octocat @@ -118143,7 +118550,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &768 + - &769 name: user_id description: The unique identifier of the user. in: path @@ -118209,7 +118616,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *767 + - *768 - *17 responses: '200': @@ -118244,7 +118651,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *768 + - *769 - *294 requestBody: required: true @@ -118316,7 +118723,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *769 + schema: *770 examples: table_view: summary: Response for creating a table view @@ -118368,11 +118775,11 @@ paths: application/json: schema: oneOf: + - *741 - *740 - - *739 examples: - default-response: *770 - response-with-git-hub-plan-information: *771 + default-response: *771 + response-with-git-hub-plan-information: *772 '404': *6 x-github: githubCloudOnly: false @@ -118422,8 +118829,8 @@ paths: required: - subject_digests examples: - default: *772 - withPredicateType: *773 + default: *773 + withPredicateType: *774 responses: '200': description: Response @@ -118476,7 +118883,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *774 + default: *775 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -118962,7 +119369,7 @@ paths: application/json: schema: *205 examples: - default: &775 + default: &776 summary: Example response for a user copilot space value: id: 42 @@ -119063,7 +119470,7 @@ paths: application/json: schema: *205 examples: - default: *775 + default: *776 '403': *29 '404': *6 x-github: @@ -119186,7 +119593,7 @@ paths: application/json: schema: *205 examples: - default: *775 + default: *776 '403': *29 '404': *6 '422': *15 @@ -119954,7 +120361,7 @@ paths: type: array items: *276 examples: - default: *757 + default: *758 '403': *29 '401': *25 x-github: @@ -120338,9 +120745,9 @@ paths: application/json: schema: type: array - items: *747 + items: *748 examples: - default: *776 + default: *777 headers: Link: *71 x-github: @@ -120568,7 +120975,7 @@ paths: - docker - nuget - container - - *756 + - *757 - *75 - *19 - *17 @@ -120581,10 +120988,10 @@ paths: type: array items: *276 examples: - default: *757 + default: *758 '403': *29 '401': *25 - '400': *758 + '400': *759 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120614,7 +121021,7 @@ paths: application/json: schema: *276 examples: - default: *777 + default: *778 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120963,7 +121370,7 @@ paths: type: array items: *298 examples: - default: *778 + default: *779 headers: Link: *71 '304': *38 @@ -121023,7 +121430,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *779 + items: *780 required: - name - data_type @@ -121039,7 +121446,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *780 + iteration_configuration: *781 required: - name - data_type @@ -121061,8 +121468,8 @@ paths: value: name: Due date data_type: date - single_select_field: *781 - iteration_field: *782 + single_select_field: *782 + iteration_field: *783 responses: '201': description: Response @@ -121070,11 +121477,11 @@ paths: application/json: schema: *298 examples: - text_field: *783 - number_field: *784 - date_field: *785 - single_select_field: *786 - iteration_field: *787 + text_field: *784 + number_field: *785 + date_field: *786 + single_select_field: *787 + iteration_field: *788 '304': *38 '403': *29 '401': *25 @@ -121096,7 +121503,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *294 - - *788 + - *789 - *75 responses: '200': @@ -121105,7 +121512,7 @@ paths: application/json: schema: *298 examples: - default: *789 + default: *790 headers: Link: *71 '304': *38 @@ -121459,7 +121866,7 @@ paths: parameters: - *294 - *75 - - *790 + - *791 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -121998,7 +122405,7 @@ paths: parameters: - *75 - *125 - - *791 + - *792 - *127 responses: '200': @@ -122097,9 +122504,9 @@ paths: - *125 - *126 - *127 - - *792 - - *130 - *793 + - *130 + - *794 responses: '200': description: Response when getting a billing usage summary @@ -122233,9 +122640,9 @@ paths: application/json: schema: type: array - items: *761 + items: *762 examples: - default: *762 + default: *763 headers: Link: *71 x-github: @@ -122265,9 +122672,9 @@ paths: application/json: schema: type: array - items: *763 + items: *764 examples: - default: *794 + default: *795 headers: Link: *71 x-github: @@ -122292,7 +122699,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *75 - - *795 + - *796 - *63 - *17 - *19 @@ -122304,11 +122711,11 @@ paths: schema: anyOf: - type: array - items: *796 + items: *797 - type: array items: *83 examples: - default-response: *766 + default-response: *767 headers: Link: *71 x-github: @@ -122467,7 +122874,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &797 + enterprise: &798 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -122525,7 +122932,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &798 + installation: &799 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -122544,7 +122951,7 @@ x-webhooks: required: - id - node_id - organization: &799 + organization: &800 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -122604,13 +123011,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &800 + repository: &801 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: &832 + properties: &833 id: description: Unique identifier of the repository example: 42 @@ -123305,7 +123712,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &833 + required: &834 - archive_url - assignees_url - blobs_url @@ -123456,10 +123863,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -123535,11 +123942,11 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - rule: &801 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + rule: &802 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) @@ -123762,11 +124169,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - rule: *801 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + rule: *802 sender: *4 required: - action @@ -123949,11 +124356,11 @@ x-webhooks: - everyone required: - from - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - rule: *801 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + rule: *802 sender: *4 required: - action @@ -124037,7 +124444,7 @@ x-webhooks: type: string enum: - completed - check_run: &803 + check_run: &804 title: CheckRun description: A check performed on the code of a given code change type: object @@ -124128,7 +124535,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *802 + deployment: *803 details_url: example: https://example.com type: string @@ -124213,10 +124620,10 @@ x-webhooks: - output - app - pull_requests - installation: *798 - enterprise: *797 - organization: *799 - repository: *800 + installation: *799 + enterprise: *798 + organization: *800 + repository: *801 sender: *4 required: - check_run @@ -124607,11 +125014,11 @@ x-webhooks: type: string enum: - created - check_run: *803 - installation: *798 - enterprise: *797 - organization: *799 - repository: *800 + check_run: *804 + installation: *799 + enterprise: *798 + organization: *800 + repository: *801 sender: *4 required: - check_run @@ -125005,11 +125412,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *803 - installation: *798 - enterprise: *797 - organization: *799 - repository: *800 + check_run: *804 + installation: *799 + enterprise: *798 + organization: *800 + repository: *801 requested_action: description: The action requested by the user. type: object @@ -125412,11 +125819,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *803 - installation: *798 - enterprise: *797 - organization: *799 - repository: *800 + check_run: *804 + installation: *799 + enterprise: *798 + organization: *800 + repository: *801 sender: *4 required: - check_run @@ -126386,10 +126793,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -127088,10 +127495,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -127784,10 +128191,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -128098,20 +128505,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &804 + commit_oid: &805 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: *797 - installation: *798 - organization: *799 - ref: &805 + enterprise: *798 + installation: *799 + organization: *800 + ref: &806 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: *800 + repository: *801 sender: *4 required: - action @@ -128506,12 +128913,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *804 - enterprise: *797 - installation: *798 - organization: *799 - ref: *805 - repository: *800 + commit_oid: *805 + enterprise: *798 + installation: *799 + organization: *800 + ref: *806 + repository: *801 sender: *4 required: - action @@ -128777,12 +129184,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *804 - enterprise: *797 - installation: *798 - organization: *799 - ref: *805 - repository: *800 + commit_oid: *805 + enterprise: *798 + installation: *799 + organization: *800 + ref: *806 + repository: *801 sender: *4 required: - action @@ -129114,12 +129521,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *804 - enterprise: *797 - installation: *798 - organization: *799 - ref: *805 - repository: *800 + commit_oid: *805 + enterprise: *798 + installation: *799 + organization: *800 + ref: *806 + repository: *801 sender: *4 required: - action @@ -129393,16 +129800,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 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: *800 + repository: *801 sender: *4 required: - action @@ -129639,12 +130046,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *804 - enterprise: *797 - installation: *798 - organization: *799 - ref: *805 - repository: *800 + commit_oid: *805 + enterprise: *798 + installation: *799 + organization: *800 + ref: *806 + repository: *801 sender: *4 required: - action @@ -129955,10 +130362,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -130213,10 +130620,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -130296,18 +130703,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *799 - pusher_type: &806 + organization: *800 + pusher_type: &807 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &807 + ref: &808 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -130317,7 +130724,7 @@ x-webhooks: enum: - tag - branch - repository: *800 + repository: *801 sender: *4 required: - ref @@ -130400,9 +130807,9 @@ x-webhooks: enum: - created definition: *306 - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 sender: *4 required: - action @@ -130487,9 +130894,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 sender: *4 required: - action @@ -130567,9 +130974,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *306 - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 sender: *4 required: - action @@ -130647,9 +131054,9 @@ x-webhooks: enum: - updated definition: *306 - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 sender: *4 required: - action @@ -130726,10 +131133,10 @@ x-webhooks: type: string enum: - updated - enterprise: *797 - installation: *798 - repository: *800 - organization: *799 + enterprise: *798 + installation: *799 + repository: *801 + organization: *800 sender: *4 new_property_values: type: array @@ -130814,18 +131221,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *797 - installation: *798 - organization: *799 - pusher_type: *806 - ref: *807 + enterprise: *798 + installation: *799 + organization: *800 + pusher_type: *807 + ref: *808 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *800 + repository: *801 sender: *4 required: - ref @@ -130906,10 +131313,10 @@ x-webhooks: enum: - assignees_changed alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -130990,10 +131397,10 @@ x-webhooks: enum: - auto_dismissed alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -131075,10 +131482,10 @@ x-webhooks: enum: - auto_reopened alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -131160,10 +131567,10 @@ x-webhooks: enum: - created alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -131243,10 +131650,10 @@ x-webhooks: enum: - dismissed alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -131326,10 +131733,10 @@ x-webhooks: enum: - fixed alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -131410,10 +131817,10 @@ x-webhooks: enum: - reintroduced alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -131493,10 +131900,10 @@ x-webhooks: enum: - reopened alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -131573,9 +131980,9 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - key: &808 + enterprise: *798 + installation: *799 + key: &809 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -131611,8 +132018,8 @@ x-webhooks: - verified - created_at - read_only - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -131689,11 +132096,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - key: *808 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + key: *809 + organization: *800 + repository: *801 sender: *4 required: - action @@ -132249,12 +132656,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - workflow: &814 + workflow: &815 title: Workflow type: object nullable: true @@ -132995,15 +133402,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *809 - required: *810 + properties: *810 + required: *811 nullable: true pull_requests: type: array items: *631 - repository: *800 - organization: *799 - installation: *798 + repository: *801 + organization: *800 + installation: *799 sender: *4 responses: '200': @@ -133074,7 +133481,7 @@ x-webhooks: type: string enum: - approved - approver: &811 + approver: &812 type: object properties: avatar_url: @@ -133117,11 +133524,11 @@ x-webhooks: type: string comment: type: string - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - reviewers: &812 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + reviewers: &813 type: array items: type: object @@ -133200,7 +133607,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &813 + workflow_job_run: &814 type: object properties: conclusion: @@ -133931,18 +134338,18 @@ x-webhooks: type: string enum: - rejected - approver: *811 + approver: *812 comment: type: string - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - reviewers: *812 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + reviewers: *813 sender: *4 since: type: string - workflow_job_run: *813 + workflow_job_run: *814 workflow_job_runs: type: array items: @@ -134646,13 +135053,13 @@ x-webhooks: type: string enum: - requested - enterprise: *797 + enterprise: *798 environment: type: string - installation: *798 - organization: *799 - repository: *800 - requestor: &819 + installation: *799 + organization: *800 + repository: *801 + requestor: &820 title: User type: object nullable: true @@ -136541,12 +136948,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - workflow: *814 + workflow: *815 workflow_run: title: Deployment Workflow Run type: object @@ -137226,7 +137633,7 @@ x-webhooks: type: string enum: - answered - answer: &817 + answer: &818 type: object properties: author_association: @@ -137383,11 +137790,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -137514,11 +137921,11 @@ x-webhooks: - from required: - category - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -137601,11 +138008,11 @@ x-webhooks: type: string enum: - closed - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -137687,7 +138094,7 @@ x-webhooks: type: string enum: - created - comment: &816 + comment: &817 type: object properties: author_association: @@ -137844,11 +138251,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -137931,12 +138338,12 @@ x-webhooks: type: string enum: - deleted - comment: *816 - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + comment: *817 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138031,12 +138438,12 @@ x-webhooks: - from required: - body - comment: *816 - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + comment: *817 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138120,11 +138527,11 @@ x-webhooks: type: string enum: - created - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138206,11 +138613,11 @@ x-webhooks: type: string enum: - deleted - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138310,11 +138717,11 @@ x-webhooks: type: string required: - from - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138396,10 +138803,10 @@ x-webhooks: type: string enum: - labeled - discussion: *815 - enterprise: *797 - installation: *798 - label: &818 + discussion: *816 + enterprise: *798 + installation: *799 + label: &819 title: Label type: object properties: @@ -138431,8 +138838,8 @@ x-webhooks: - color - default - description - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138515,11 +138922,11 @@ x-webhooks: type: string enum: - locked - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138601,11 +139008,11 @@ x-webhooks: type: string enum: - pinned - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138687,11 +139094,11 @@ x-webhooks: type: string enum: - reopened - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138776,16 +139183,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *815 - new_repository: *800 + new_discussion: *816 + new_repository: *801 required: - new_discussion - new_repository - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138868,10 +139275,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *815 - old_answer: *817 - organization: *799 - repository: *800 + discussion: *816 + old_answer: *818 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138953,12 +139360,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *815 - enterprise: *797 - installation: *798 - label: *818 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + label: *819 + organization: *800 + repository: *801 sender: *4 required: - action @@ -139041,11 +139448,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -139127,11 +139534,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -139204,7 +139611,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *797 + enterprise: *798 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -139864,9 +140271,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - forkee @@ -140012,9 +140419,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pages: description: The pages that were updated. type: array @@ -140051,7 +140458,7 @@ x-webhooks: - action - sha - html_url - repository: *800 + repository: *801 sender: *4 required: - pages @@ -140127,10 +140534,10 @@ x-webhooks: type: string enum: - created - enterprise: *797 + enterprise: *798 installation: *22 - organization: *799 - repositories: &820 + organization: *800 + repositories: &821 description: An array of repository objects that the installation can access. type: array @@ -140156,8 +140563,8 @@ x-webhooks: - name - full_name - private - repository: *800 - requester: *819 + repository: *801 + requester: *820 sender: *4 required: - action @@ -140232,11 +140639,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 + enterprise: *798 installation: *22 - organization: *799 - repositories: *820 - repository: *800 + organization: *800 + repositories: *821 + repository: *801 requester: nullable: true sender: *4 @@ -140312,11 +140719,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *797 + enterprise: *798 installation: *22 - organization: *799 - repositories: *820 - repository: *800 + organization: *800 + repositories: *821 + repository: *801 requester: nullable: true sender: *4 @@ -140392,10 +140799,10 @@ x-webhooks: type: string enum: - added - enterprise: *797 + enterprise: *798 installation: *22 - organization: *799 - repositories_added: &821 + organization: *800 + repositories_added: &822 description: An array of repository objects, which were added to the installation. type: array @@ -140441,15 +140848,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *800 - repository_selection: &822 + repository: *801 + repository_selection: &823 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *819 + requester: *820 sender: *4 required: - action @@ -140528,10 +140935,10 @@ x-webhooks: type: string enum: - removed - enterprise: *797 + enterprise: *798 installation: *22 - organization: *799 - repositories_added: *821 + organization: *800 + repositories_added: *822 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -140558,9 +140965,9 @@ x-webhooks: - name - full_name - private - repository: *800 - repository_selection: *822 - requester: *819 + repository: *801 + repository_selection: *823 + requester: *820 sender: *4 required: - action @@ -140639,11 +141046,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *797 + enterprise: *798 installation: *22 - organization: *799 - repositories: *820 - repository: *800 + organization: *800 + repositories: *821 + repository: *801 requester: nullable: true sender: *4 @@ -140821,10 +141228,10 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 target_type: type: string @@ -140903,11 +141310,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *797 + enterprise: *798 installation: *22 - organization: *799 - repositories: *820 - repository: *800 + organization: *800 + repositories: *821 + repository: *801 requester: nullable: true sender: *4 @@ -141174,8 +141581,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -141964,8 +142371,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142314,8 +142721,8 @@ x-webhooks: - state - locked - assignee - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -142395,7 +142802,7 @@ x-webhooks: type: string enum: - deleted - comment: &823 + comment: &824 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -142575,8 +142982,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -143361,8 +143768,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143713,8 +144120,8 @@ x-webhooks: - state - locked - assignee - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -143794,7 +144201,7 @@ x-webhooks: type: string enum: - edited - changes: &852 + changes: &853 description: The changes to the comment. type: object properties: @@ -143806,9 +144213,9 @@ x-webhooks: type: string required: - from - comment: *823 - enterprise: *797 - installation: *798 + comment: *824 + enterprise: *798 + installation: *799 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -144596,8 +145003,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144946,8 +145353,8 @@ x-webhooks: - state - locked - assignee - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -145028,9 +145435,9 @@ x-webhooks: type: string enum: - pinned - comment: *823 - enterprise: *797 - installation: *798 + comment: *824 + enterprise: *798 + installation: *799 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -145820,8 +146227,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146172,8 +146579,8 @@ x-webhooks: - state - locked - assignee - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -146253,9 +146660,9 @@ x-webhooks: type: string enum: - unpinned - comment: *823 - enterprise: *797 - installation: *798 + comment: *824 + enterprise: *798 + installation: *799 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -147045,8 +147452,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147397,8 +147804,8 @@ x-webhooks: - state - locked - assignee - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -147487,9 +147894,9 @@ x-webhooks: type: number blocking_issue: *89 blocking_issue_repo: *83 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -147578,9 +147985,9 @@ x-webhooks: type: number blocking_issue: *89 blocking_issue_repo: *83 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -147668,9 +148075,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *89 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -147759,9 +148166,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *89 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -147841,10 +148248,10 @@ x-webhooks: type: string enum: - assigned - assignee: *819 - enterprise: *797 - installation: *798 - issue: &824 + assignee: *820 + enterprise: *798 + installation: *799 + issue: &825 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -148636,8 +149043,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -148757,8 +149164,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -148838,8 +149245,8 @@ x-webhooks: type: string enum: - closed - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -149636,8 +150043,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -149892,8 +150299,8 @@ x-webhooks: required: - state - closed_at - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -149972,8 +150379,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150761,8 +151168,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -150881,8 +151288,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -150961,8 +151368,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -151772,8 +152179,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -151871,7 +152278,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &825 + milestone: &826 title: Milestone description: A collection of related issues and pull requests. type: object @@ -152009,8 +152416,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -152109,8 +152516,8 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152902,8 +153309,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -153023,9 +153430,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *818 - organization: *799 - repository: *800 + label: *819 + organization: *800 + repository: *801 sender: *4 required: - action @@ -153105,9 +153512,9 @@ x-webhooks: type: string enum: - field_added - enterprise: *797 - installation: *798 - issue: *824 + enterprise: *798 + installation: *799 + issue: *825 issue_field: type: object description: The issue field whose value was set or updated on the @@ -153261,8 +153668,8 @@ x-webhooks: - id required: - from - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -153342,9 +153749,9 @@ x-webhooks: type: string enum: - field_removed - enterprise: *797 - installation: *798 - issue: *824 + enterprise: *798 + installation: *799 + issue: *825 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -153425,8 +153832,8 @@ x-webhooks: nullable: true required: - id - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -153506,8 +153913,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -154298,8 +154705,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -154419,9 +154826,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *818 - organization: *799 - repository: *800 + label: *819 + organization: *800 + repository: *801 sender: *4 required: - action @@ -154501,8 +154908,8 @@ x-webhooks: type: string enum: - locked - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -155317,8 +155724,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -155415,8 +155822,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -155495,8 +155902,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -156305,8 +156712,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -156403,9 +156810,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *825 - organization: *799 - repository: *800 + milestone: *826 + organization: *800 + repository: *801 sender: *4 required: - action @@ -157268,8 +157675,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -157853,8 +158260,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -158638,8 +159045,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -158766,8 +159173,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -158847,9 +159254,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *797 - installation: *798 - issue: &826 + enterprise: *798 + installation: *799 + issue: &827 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -159635,8 +160042,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -159755,8 +160162,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -159835,8 +160242,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -160649,8 +161056,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -160748,8 +161155,8 @@ x-webhooks: user_view_type: type: string type: *258 - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -161618,8 +162025,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -162217,11 +162624,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *797 - installation: *798 - issue: *826 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + issue: *827 + organization: *800 + repository: *801 sender: *4 required: - action @@ -162301,12 +162708,12 @@ x-webhooks: type: string enum: - typed - enterprise: *797 - installation: *798 - issue: *824 + enterprise: *798 + installation: *799 + issue: *825 type: *258 - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -162387,7 +162794,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &855 + assignee: &856 title: User type: object nullable: true @@ -162457,11 +162864,11 @@ x-webhooks: required: - login - id - enterprise: *797 - installation: *798 - issue: *824 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + issue: *825 + organization: *800 + repository: *801 sender: *4 required: - action @@ -162540,12 +162947,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *797 - installation: *798 - issue: *824 - label: *818 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + issue: *825 + label: *819 + organization: *800 + repository: *801 sender: *4 required: - action @@ -162625,8 +163032,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -163439,8 +163846,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -163537,8 +163944,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -163618,11 +164025,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *797 - installation: *798 - issue: *826 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + issue: *827 + organization: *800 + repository: *801 sender: *4 required: - action @@ -163701,12 +164108,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *797 - installation: *798 - issue: *824 + enterprise: *798 + installation: *799 + issue: *825 type: *258 - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -163786,11 +164193,11 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - label: *818 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + label: *819 + organization: *800 + repository: *801 sender: *4 required: - action @@ -163868,11 +164275,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - label: *818 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + label: *819 + organization: *800 + repository: *801 sender: *4 required: - action @@ -163982,11 +164389,11 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - label: *818 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + label: *819 + organization: *800 + repository: *801 sender: *4 required: - action @@ -164068,9 +164475,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *797 - installation: *798 - marketplace_purchase: &827 + enterprise: *798 + installation: *799 + marketplace_purchase: &828 title: Marketplace Purchase type: object required: @@ -164153,8 +164560,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *799 - previous_marketplace_purchase: &828 + organization: *800 + previous_marketplace_purchase: &829 title: Marketplace Purchase type: object properties: @@ -164234,7 +164641,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *800 + repository: *801 sender: *4 required: - action @@ -164314,10 +164721,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *797 - installation: *798 - marketplace_purchase: *827 - organization: *799 + enterprise: *798 + installation: *799 + marketplace_purchase: *828 + organization: *800 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -164400,7 +164807,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *800 + repository: *801 sender: *4 required: - action @@ -164482,10 +164889,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *797 - installation: *798 - marketplace_purchase: *827 - organization: *799 + enterprise: *798 + installation: *799 + marketplace_purchase: *828 + organization: *800 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -164567,7 +164974,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *800 + repository: *801 sender: *4 required: - action @@ -164648,8 +165055,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 marketplace_purchase: title: Marketplace Purchase type: object @@ -164731,9 +165138,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *799 - previous_marketplace_purchase: *828 - repository: *800 + organization: *800 + previous_marketplace_purchase: *829 + repository: *801 sender: *4 required: - action @@ -164813,12 +165220,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *797 - installation: *798 - marketplace_purchase: *827 - organization: *799 - previous_marketplace_purchase: *828 - repository: *800 + enterprise: *798 + installation: *799 + marketplace_purchase: *828 + organization: *800 + previous_marketplace_purchase: *829 + repository: *801 sender: *4 required: - action @@ -164920,11 +165327,11 @@ x-webhooks: type: string required: - to - enterprise: *797 - installation: *798 - member: *819 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + member: *820 + organization: *800 + repository: *801 sender: *4 required: - action @@ -165024,11 +165431,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *797 - installation: *798 - member: *819 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + member: *820 + organization: *800 + repository: *801 sender: *4 required: - action @@ -165107,11 +165514,11 @@ x-webhooks: type: string enum: - removed - enterprise: *797 - installation: *798 - member: *819 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + member: *820 + organization: *800 + repository: *801 sender: *4 required: - action @@ -165189,11 +165596,11 @@ x-webhooks: type: string enum: - added - enterprise: *797 - installation: *798 - member: *819 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + member: *820 + organization: *800 + repository: *801 scope: description: The scope of the membership. Currently, can only be `team`. @@ -165269,7 +165676,7 @@ x-webhooks: required: - login - id - team: &829 + team: &830 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -165492,11 +165899,11 @@ x-webhooks: type: string enum: - removed - enterprise: *797 - installation: *798 - member: *819 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + member: *820 + organization: *800 + repository: *801 scope: description: The scope of the membership. Currently, can only be `team`. @@ -165573,7 +165980,7 @@ x-webhooks: required: - login - id - team: *829 + team: *830 required: - action - scope @@ -165655,8 +166062,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *798 - merge_group: &831 + installation: *799 + merge_group: &832 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -165675,15 +166082,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *830 + head_commit: *831 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -165769,10 +166176,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *798 - merge_group: *831 - organization: *799 - repository: *800 + installation: *799 + merge_group: *832 + organization: *800 + repository: *801 sender: *4 required: - action @@ -165845,7 +166252,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 + enterprise: *798 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -165954,16 +166361,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *798 - organization: *799 + installation: *799 + organization: *800 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: *832 - required: *833 + properties: *833 + required: *834 nullable: true sender: *4 required: @@ -166044,11 +166451,11 @@ x-webhooks: type: string enum: - closed - enterprise: *797 - installation: *798 - milestone: *825 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + milestone: *826 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166127,9 +166534,9 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - milestone: &834 + enterprise: *798 + installation: *799 + milestone: &835 title: Milestone description: A collection of related issues and pull requests. type: object @@ -166266,8 +166673,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166346,11 +166753,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - milestone: *825 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + milestone: *826 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166460,11 +166867,11 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - milestone: *825 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + milestone: *826 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166544,11 +166951,11 @@ x-webhooks: type: string enum: - opened - enterprise: *797 - installation: *798 - milestone: *834 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + milestone: *835 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166627,11 +167034,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *819 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + blocked_user: *820 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166710,11 +167117,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *819 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + blocked_user: *820 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166793,9 +167200,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - membership: &835 + enterprise: *798 + installation: *799 + membership: &836 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -166902,8 +167309,8 @@ x-webhooks: - role - organization_url - user - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166981,11 +167388,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *797 - installation: *798 - membership: *835 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + membership: *836 + organization: *800 + repository: *801 sender: *4 required: - action @@ -167064,8 +167471,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -167181,10 +167588,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 - user: *819 + user: *820 required: - action - invitation @@ -167262,11 +167669,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *797 - installation: *798 - membership: *835 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + membership: *836 + organization: *800 + repository: *801 sender: *4 required: - action @@ -167353,11 +167760,11 @@ x-webhooks: properties: from: type: string - enterprise: *797 - installation: *798 - membership: *835 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + membership: *836 + organization: *800 + repository: *801 sender: *4 required: - action @@ -167434,9 +167841,9 @@ x-webhooks: type: string enum: - published - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 package: description: Information about the package. type: object @@ -167935,7 +168342,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &836 + items: &837 title: Ruby Gems metadata type: object properties: @@ -168030,7 +168437,7 @@ x-webhooks: - owner - package_version - registry - repository: *800 + repository: *801 sender: *4 required: - action @@ -168106,9 +168513,9 @@ x-webhooks: type: string enum: - updated - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 package: description: Information about the package. type: object @@ -168461,7 +168868,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *836 + items: *837 source_url: type: string format: uri @@ -168531,7 +168938,7 @@ x-webhooks: - owner - package_version - registry - repository: *800 + repository: *801 sender: *4 required: - action @@ -168707,12 +169114,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *797 + enterprise: *798 id: type: integer - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - id @@ -168789,7 +169196,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &837 + personal_access_token_request: &838 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -168935,10 +169342,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *797 - organization: *799 + enterprise: *798 + organization: *800 sender: *4 - installation: *798 + installation: *799 required: - action - personal_access_token_request @@ -169015,11 +169422,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *837 - enterprise: *797 - organization: *799 + personal_access_token_request: *838 + enterprise: *798 + organization: *800 sender: *4 - installation: *798 + installation: *799 required: - action - personal_access_token_request @@ -169095,11 +169502,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *837 - enterprise: *797 - organization: *799 + personal_access_token_request: *838 + enterprise: *798 + organization: *800 sender: *4 - installation: *798 + installation: *799 required: - action - personal_access_token_request @@ -169174,11 +169581,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *837 - organization: *799 - enterprise: *797 + personal_access_token_request: *838 + organization: *800 + enterprise: *798 sender: *4 - installation: *798 + installation: *799 required: - action - personal_access_token_request @@ -169283,7 +169690,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *838 + last_response: *839 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -169315,8 +169722,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 zen: description: Random string of GitHub zen. @@ -169561,10 +169968,10 @@ x-webhooks: - from required: - note - enterprise: *797 - installation: *798 - organization: *799 - project_card: &839 + enterprise: *798 + installation: *799 + organization: *800 + project_card: &840 title: Project Card type: object properties: @@ -169683,7 +170090,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *800 + repository: *801 sender: *4 required: - action @@ -169764,11 +170171,11 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - project_card: *839 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + project_card: *840 + repository: *801 sender: *4 required: - action @@ -169848,9 +170255,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 project_card: title: Project Card type: object @@ -169978,8 +170385,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: *832 - required: *833 + properties: *833 + required: *834 nullable: true sender: *4 required: @@ -170073,11 +170480,11 @@ x-webhooks: - from required: - note - enterprise: *797 - installation: *798 - organization: *799 - project_card: *839 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + project_card: *840 + repository: *801 sender: *4 required: - action @@ -170171,9 +170578,9 @@ x-webhooks: - from required: - column_id - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 project_card: allOf: - title: Project Card @@ -170363,7 +170770,7 @@ x-webhooks: type: string required: - after_id - repository: *800 + repository: *801 sender: *4 required: - action @@ -170443,10 +170850,10 @@ x-webhooks: type: string enum: - closed - enterprise: *797 - installation: *798 - organization: *799 - project: &841 + enterprise: *798 + installation: *799 + organization: *800 + project: &842 title: Project type: object properties: @@ -170570,7 +170977,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *800 + repository: *801 sender: *4 required: - action @@ -170650,10 +171057,10 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - project_column: &840 + enterprise: *798 + installation: *799 + organization: *800 + project_column: &841 title: Project Column type: object properties: @@ -170692,7 +171099,7 @@ x-webhooks: - name - created_at - updated_at - repository: *800 + repository: *801 sender: *4 required: - action @@ -170771,18 +171178,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 - project_column: *840 + enterprise: *798 + installation: *799 + organization: *800 + project_column: *841 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: *832 - required: *833 + properties: *833 + required: *834 nullable: true sender: *4 required: @@ -170872,11 +171279,11 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - organization: *799 - project_column: *840 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + project_column: *841 + repository: *801 sender: *4 required: - action @@ -170956,11 +171363,11 @@ x-webhooks: type: string enum: - moved - enterprise: *797 - installation: *798 - organization: *799 - project_column: *840 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + project_column: *841 + repository: *801 sender: *4 required: - action @@ -171040,11 +171447,11 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - project: *841 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + project: *842 + repository: *801 sender: *4 required: - action @@ -171124,18 +171531,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 - project: *841 + enterprise: *798 + installation: *799 + organization: *800 + project: *842 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: *832 - required: *833 + properties: *833 + required: *834 nullable: true sender: *4 required: @@ -171237,11 +171644,11 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - organization: *799 - project: *841 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + project: *842 + repository: *801 sender: *4 required: - action @@ -171320,11 +171727,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *797 - installation: *798 - organization: *799 - project: *841 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + project: *842 + repository: *801 sender: *4 required: - action @@ -171405,8 +171812,8 @@ x-webhooks: type: string enum: - closed - installation: *798 - organization: *799 + installation: *799 + organization: *800 projects_v2: *292 sender: *4 required: @@ -171488,8 +171895,8 @@ x-webhooks: type: string enum: - created - installation: *798 - organization: *799 + installation: *799 + organization: *800 projects_v2: *292 sender: *4 required: @@ -171571,8 +171978,8 @@ x-webhooks: type: string enum: - deleted - installation: *798 - organization: *799 + installation: *799 + organization: *800 projects_v2: *292 sender: *4 required: @@ -171690,8 +172097,8 @@ x-webhooks: type: string to: type: string - installation: *798 - organization: *799 + installation: *799 + organization: *800 projects_v2: *292 sender: *4 required: @@ -171775,7 +172182,7 @@ x-webhooks: type: string enum: - archived - changes: &845 + changes: &846 type: object properties: archived_at: @@ -171789,9 +172196,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *798 - organization: *799 - projects_v2_item: &842 + installation: *799 + organization: *800 + projects_v2_item: &843 title: Projects v2 Item description: An item belonging to a project type: object @@ -171926,9 +172333,9 @@ x-webhooks: nullable: true to: type: string - installation: *798 - organization: *799 - projects_v2_item: *842 + installation: *799 + organization: *800 + projects_v2_item: *843 sender: *4 required: - action @@ -172010,9 +172417,9 @@ x-webhooks: type: string enum: - created - installation: *798 - organization: *799 - projects_v2_item: *842 + installation: *799 + organization: *800 + projects_v2_item: *843 sender: *4 required: - action @@ -172093,9 +172500,9 @@ x-webhooks: type: string enum: - deleted - installation: *798 - organization: *799 - projects_v2_item: *842 + installation: *799 + organization: *800 + projects_v2_item: *843 sender: *4 required: - action @@ -172201,7 +172608,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &843 + - &844 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -172223,7 +172630,7 @@ x-webhooks: required: - id - name - - &844 + - &845 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -172257,8 +172664,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *843 - *844 + - *845 required: - field_value - type: object @@ -172274,9 +172681,9 @@ x-webhooks: nullable: true required: - body - installation: *798 - organization: *799 - projects_v2_item: *842 + installation: *799 + organization: *800 + projects_v2_item: *843 sender: *4 required: - action @@ -172371,9 +172778,9 @@ x-webhooks: to: type: string nullable: true - installation: *798 - organization: *799 - projects_v2_item: *842 + installation: *799 + organization: *800 + projects_v2_item: *843 sender: *4 required: - action @@ -172456,10 +172863,10 @@ x-webhooks: type: string enum: - restored - changes: *845 - installation: *798 - organization: *799 - projects_v2_item: *842 + changes: *846 + installation: *799 + organization: *800 + projects_v2_item: *843 sender: *4 required: - action @@ -172541,8 +172948,8 @@ x-webhooks: type: string enum: - reopened - installation: *798 - organization: *799 + installation: *799 + organization: *800 projects_v2: *292 sender: *4 required: @@ -172624,14 +173031,14 @@ x-webhooks: type: string enum: - created - installation: *798 - organization: *799 - projects_v2_status_update: &848 + installation: *799 + organization: *800 + projects_v2_status_update: &849 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *846 - required: *847 + properties: *847 + required: *848 sender: *4 required: - action @@ -172712,9 +173119,9 @@ x-webhooks: type: string enum: - deleted - installation: *798 - organization: *799 - projects_v2_status_update: *848 + installation: *799 + organization: *800 + projects_v2_status_update: *849 sender: *4 required: - action @@ -172850,9 +173257,9 @@ x-webhooks: type: string format: date nullable: true - installation: *798 - organization: *799 - projects_v2_status_update: *848 + installation: *799 + organization: *800 + projects_v2_status_update: *849 sender: *4 required: - action @@ -172923,10 +173330,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - repository @@ -173003,13 +173410,13 @@ x-webhooks: type: string enum: - assigned - assignee: *819 - enterprise: *797 - installation: *798 - number: &849 + assignee: *820 + enterprise: *798 + installation: *799 + number: &850 description: The pull request number. type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -175315,7 +175722,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -175397,11 +175804,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -177702,7 +178109,7 @@ x-webhooks: - draft reason: type: string - repository: *800 + repository: *801 sender: *4 required: - action @@ -177784,11 +178191,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -180089,7 +180496,7 @@ x-webhooks: - draft reason: type: string - repository: *800 + repository: *801 sender: *4 required: - action @@ -180171,11 +180578,11 @@ x-webhooks: type: string enum: - closed - enterprise: *797 - installation: *798 - number: *849 - organization: *799 - pull_request: &850 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 + pull_request: &851 allOf: - *631 - type: object @@ -180239,7 +180646,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *800 + repository: *801 sender: *4 required: - action @@ -180320,12 +180727,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *797 - installation: *798 - number: *849 - organization: *799 - pull_request: *850 - repository: *800 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 + pull_request: *851 + repository: *801 sender: *4 required: - action @@ -180405,11 +180812,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *797 + enterprise: *798 milestone: *614 - number: *849 - organization: *799 - pull_request: &851 + number: *850 + organization: *800 + pull_request: &852 title: Pull Request type: object properties: @@ -182695,7 +183102,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -182774,11 +183181,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -185083,7 +185490,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *800 + repository: *801 sender: *4 required: - action @@ -185207,12 +185614,12 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - number: *849 - organization: *799 - pull_request: *850 - repository: *800 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 + pull_request: *851 + repository: *801 sender: *4 required: - action @@ -185292,11 +185699,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -187586,7 +187993,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -187666,11 +188073,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *797 - installation: *798 - label: *818 - number: *849 - organization: *799 + enterprise: *798 + installation: *799 + label: *819 + number: *850 + organization: *800 pull_request: title: Pull Request type: object @@ -189975,7 +190382,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -190056,10 +190463,10 @@ x-webhooks: type: string enum: - locked - enterprise: *797 - installation: *798 - number: *849 - organization: *799 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 pull_request: title: Pull Request type: object @@ -192362,7 +192769,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -192442,12 +192849,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *797 + enterprise: *798 milestone: *614 - number: *849 - organization: *799 - pull_request: *851 - repository: *800 + number: *850 + organization: *800 + pull_request: *852 + repository: *801 sender: *4 required: - action @@ -192526,12 +192933,12 @@ x-webhooks: type: string enum: - opened - enterprise: *797 - installation: *798 - number: *849 - organization: *799 - pull_request: *850 - repository: *800 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 + pull_request: *851 + repository: *801 sender: *4 required: - action @@ -192612,12 +193019,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *797 - installation: *798 - number: *849 - organization: *799 - pull_request: *850 - repository: *800 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 + pull_request: *851 + repository: *801 sender: *4 required: - action @@ -192697,12 +193104,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *797 - installation: *798 - number: *849 - organization: *799 - pull_request: *850 - repository: *800 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 + pull_request: *851 + repository: *801 sender: *4 required: - action @@ -193068,9 +193475,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pull_request: type: object properties: @@ -195263,7 +195670,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *800 + repository: *801 sender: *4 required: - action @@ -195343,7 +195750,7 @@ x-webhooks: type: string enum: - deleted - comment: &853 + comment: &854 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -195628,9 +196035,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pull_request: type: object properties: @@ -197811,7 +198218,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *800 + repository: *801 sender: *4 required: - action @@ -197891,11 +198298,11 @@ x-webhooks: type: string enum: - edited - changes: *852 - comment: *853 - enterprise: *797 - installation: *798 - organization: *799 + changes: *853 + comment: *854 + enterprise: *798 + installation: *799 + organization: *800 pull_request: type: object properties: @@ -200079,7 +200486,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *800 + repository: *801 sender: *4 required: - action @@ -200160,9 +200567,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pull_request: title: Simple Pull Request type: object @@ -202358,7 +202765,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *800 + repository: *801 review: description: The review that was affected. type: object @@ -202605,9 +203012,9 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pull_request: title: Simple Pull Request type: object @@ -204661,8 +205068,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *800 - review: &854 + repository: *801 + review: &855 description: The review that was affected. type: object properties: @@ -204895,12 +205302,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: description: The pull request number. type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -207206,7 +207613,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 requested_reviewer: title: User type: object @@ -207290,12 +207697,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: description: The pull request number. type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -209608,7 +210015,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 requested_team: title: Team description: Groups of organization members that gives permissions @@ -209800,12 +210207,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: description: The pull request number. type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -212113,7 +212520,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 requested_reviewer: title: User type: object @@ -212198,12 +212605,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: description: The pull request number. type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -214502,7 +214909,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 requested_team: title: Team description: Groups of organization members that gives permissions @@ -214683,9 +215090,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pull_request: title: Simple Pull Request type: object @@ -216883,8 +217290,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *800 - review: *854 + repository: *801 + review: *855 sender: *4 required: - action @@ -216964,9 +217371,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pull_request: title: Simple Pull Request type: object @@ -219059,7 +219466,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *800 + repository: *801 sender: *4 thread: type: object @@ -219446,9 +219853,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pull_request: title: Simple Pull Request type: object @@ -221527,7 +221934,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *800 + repository: *801 sender: *4 thread: type: object @@ -221911,11 +222318,11 @@ x-webhooks: type: string enum: - stacked - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 stack: *628 - number: *849 - organization: *799 + number: *850 + organization: *800 pull_request: title: Pull Request type: object @@ -224220,7 +224627,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -224306,10 +224713,10 @@ x-webhooks: type: string before: type: string - enterprise: *797 - installation: *798 - number: *849 - organization: *799 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 pull_request: title: Pull Request type: object @@ -226603,7 +227010,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -226685,11 +227092,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *855 - enterprise: *797 - installation: *798 - number: *849 - organization: *799 + assignee: *856 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 pull_request: title: Pull Request type: object @@ -228995,7 +229402,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -229074,11 +229481,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *797 - installation: *798 - label: *818 - number: *849 - organization: *799 + enterprise: *798 + installation: *799 + label: *819 + number: *850 + organization: *800 pull_request: title: Pull Request type: object @@ -231374,7 +231781,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -231455,10 +231862,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *797 - installation: *798 - number: *849 - organization: *799 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 pull_request: title: Pull Request type: object @@ -233746,7 +234153,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -233946,7 +234353,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *797 + enterprise: *798 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -234038,8 +234445,8 @@ x-webhooks: - url - author - committer - installation: *798 - organization: *799 + installation: *799 + organization: *800 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -234625,9 +235032,9 @@ x-webhooks: type: string enum: - published - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 registry_package: type: object properties: @@ -235073,7 +235480,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *836 + items: *837 summary: type: string tag_name: @@ -235127,7 +235534,7 @@ x-webhooks: - owner - package_version - registry - repository: *800 + repository: *801 sender: *4 required: - action @@ -235205,9 +235612,9 @@ x-webhooks: type: string enum: - updated - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 registry_package: type: object properties: @@ -235515,7 +235922,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *836 + items: *837 summary: type: string tag_name: @@ -235564,7 +235971,7 @@ x-webhooks: - owner - package_version - registry - repository: *800 + repository: *801 sender: *4 required: - action @@ -235641,10 +236048,10 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - release: &856 + enterprise: *798 + installation: *799 + organization: *800 + release: &857 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -235962,7 +236369,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *800 + repository: *801 sender: *4 required: - action @@ -236039,11 +236446,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 - release: *856 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + release: *857 + repository: *801 sender: *4 required: - action @@ -236160,11 +236567,11 @@ x-webhooks: type: boolean required: - to - enterprise: *797 - installation: *798 - organization: *799 - release: *856 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + release: *857 + repository: *801 sender: *4 required: - action @@ -236242,9 +236649,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -236566,7 +236973,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *800 + repository: *801 sender: *4 required: - action @@ -236642,10 +237049,10 @@ x-webhooks: type: string enum: - published - enterprise: *797 - installation: *798 - organization: *799 - release: &857 + enterprise: *798 + installation: *799 + organization: *800 + release: &858 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -236964,7 +237371,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *800 + repository: *801 sender: *4 required: - action @@ -237040,11 +237447,11 @@ x-webhooks: type: string enum: - released - enterprise: *797 - installation: *798 - organization: *799 - release: *856 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + release: *857 + repository: *801 sender: *4 required: - action @@ -237120,11 +237527,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *797 - installation: *798 - organization: *799 - release: *857 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + release: *858 + repository: *801 sender: *4 required: - action @@ -237200,11 +237607,11 @@ x-webhooks: type: string enum: - published - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - repository_advisory: *716 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + repository_advisory: *717 sender: *4 required: - action @@ -237280,11 +237687,11 @@ x-webhooks: type: string enum: - reported - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - repository_advisory: *716 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + repository_advisory: *717 sender: *4 required: - action @@ -237360,10 +237767,10 @@ x-webhooks: type: string enum: - archived - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -237440,10 +237847,10 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -237521,10 +237928,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -237608,10 +238015,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -237723,10 +238130,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -237798,10 +238205,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 status: type: string @@ -237882,10 +238289,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -237962,10 +238369,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -238059,10 +238466,10 @@ x-webhooks: - name required: - repository - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -238142,10 +238549,10 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 repository_ruleset: *340 sender: *4 required: @@ -238224,10 +238631,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 repository_ruleset: *340 sender: *4 required: @@ -238306,10 +238713,10 @@ x-webhooks: type: string enum: - edited - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 repository_ruleset: *340 changes: type: object @@ -238371,16 +238778,16 @@ x-webhooks: properties: added: type: array - items: *652 + items: *653 deleted: type: array - items: *652 + items: *653 updated: type: array items: type: object properties: - rule: *652 + rule: *653 changes: type: object properties: @@ -238614,10 +239021,10 @@ x-webhooks: - from required: - owner - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -238695,10 +239102,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -238776,7 +239183,7 @@ x-webhooks: type: string enum: - create - alert: &858 + alert: &859 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -238898,10 +239305,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -239107,10 +239514,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -239188,11 +239595,11 @@ x-webhooks: type: string enum: - reopen - alert: *858 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *859 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -239391,10 +239798,10 @@ x-webhooks: enum: - fixed - open - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -239472,7 +239879,7 @@ x-webhooks: type: string enum: - assigned - alert: &860 + alert: &861 type: object properties: number: *189 @@ -239622,12 +240029,12 @@ x-webhooks: properties: *20 required: *21 nullable: true - metadata: *859 + metadata: *860 assignee: *4 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -239705,11 +240112,11 @@ x-webhooks: type: string enum: - created - alert: *860 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *861 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -239790,11 +240197,11 @@ x-webhooks: type: string enum: - created - alert: *860 - installation: *798 - location: *861 - organization: *799 - repository: *800 + alert: *861 + installation: *799 + location: *862 + organization: *800 + repository: *801 sender: *4 required: - location @@ -240032,11 +240439,11 @@ x-webhooks: type: string enum: - metadata_created - alert: *860 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *861 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -240113,11 +240520,11 @@ x-webhooks: type: string enum: - metadata_removed - alert: *860 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *861 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -240194,11 +240601,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *860 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *861 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -240276,11 +240683,11 @@ x-webhooks: type: string enum: - reopened - alert: *860 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *861 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -240358,11 +240765,11 @@ x-webhooks: type: string enum: - resolved - alert: *860 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *861 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -240440,12 +240847,12 @@ x-webhooks: type: string enum: - unassigned - alert: *860 + alert: *861 assignee: *4 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -240523,11 +240930,11 @@ x-webhooks: type: string enum: - validated - alert: *860 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *861 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -240653,10 +241060,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *800 - enterprise: *797 - installation: *798 - organization: *799 + repository: *801 + enterprise: *798 + installation: *799 + organization: *800 sender: *4 required: - action @@ -240734,11 +241141,11 @@ x-webhooks: type: string enum: - published - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - security_advisory: &862 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + security_advisory: &863 description: The details of the security advisory, including summary, description, and severity. type: object @@ -240921,11 +241328,11 @@ x-webhooks: type: string enum: - updated - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - security_advisory: *862 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + security_advisory: *863 sender: *4 required: - action @@ -240998,10 +241405,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -241186,9 +241593,9 @@ x-webhooks: type: object properties: security_and_analysis: *313 - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 repository: *360 sender: *4 required: @@ -241267,12 +241674,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - sponsorship: &863 + sponsorship: &864 type: object properties: created_at: @@ -241573,12 +241980,12 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - sponsorship: *863 + sponsorship: *864 required: - action - sponsorship @@ -241666,12 +242073,12 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - sponsorship: *863 + sponsorship: *864 required: - action - changes @@ -241748,17 +242155,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &864 + effective_date: &865 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: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - sponsorship: *863 + sponsorship: *864 required: - action - sponsorship @@ -241832,7 +242239,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &865 + changes: &866 type: object properties: tier: @@ -241876,13 +242283,13 @@ x-webhooks: - from required: - tier - effective_date: *864 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + effective_date: *865 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - sponsorship: *863 + sponsorship: *864 required: - action - changes @@ -241959,13 +242366,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *865 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + changes: *866 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - sponsorship: *863 + sponsorship: *864 required: - action - changes @@ -242039,10 +242446,10 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -242125,10 +242532,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -242548,15 +242955,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *797 + enterprise: *798 id: description: The unique identifier of the status. type: integer - installation: *798 + installation: *799 name: type: string - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 sha: description: The Commit SHA. @@ -242671,9 +243078,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *89 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -242762,9 +243169,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *89 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -242853,9 +243260,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *89 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -242944,9 +243351,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *89 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -243022,12 +243429,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - team: &866 + team: &867 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -243250,9 +243657,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 repository: title: Repository description: A git repository @@ -243710,7 +244117,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *867 required: - action - team @@ -243786,9 +244193,9 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 repository: title: Repository description: A git repository @@ -244246,7 +244653,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *867 required: - action - team @@ -244323,9 +244730,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 repository: title: Repository description: A git repository @@ -244783,7 +245190,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *867 required: - action - team @@ -244927,9 +245334,9 @@ x-webhooks: - from required: - permissions - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 repository: title: Repository description: A git repository @@ -245387,7 +245794,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *867 required: - action - changes @@ -245465,9 +245872,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 repository: title: Repository description: A git repository @@ -245925,7 +246332,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *867 required: - action - team @@ -246001,10 +246408,10 @@ x-webhooks: type: string enum: - started - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -246077,16 +246484,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *797 + enterprise: *798 inputs: type: object nullable: true additionalProperties: true - installation: *798 - organization: *799 + installation: *799 + organization: *800 ref: type: string - repository: *800 + repository: *801 sender: *4 workflow: type: string @@ -246168,10 +246575,10 @@ x-webhooks: type: string enum: - completed - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 workflow_job: allOf: @@ -246487,10 +246894,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 workflow_job: allOf: @@ -246829,10 +247236,10 @@ x-webhooks: type: string enum: - queued - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 workflow_job: type: object @@ -247046,10 +247453,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 workflow_job: type: object @@ -247265,12 +247672,12 @@ x-webhooks: type: string enum: - completed - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - workflow: *814 + workflow: *815 workflow_run: title: Workflow Run type: object @@ -248269,12 +248676,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - workflow: *814 + workflow: *815 workflow_run: title: Workflow Run type: object @@ -249258,12 +249665,12 @@ x-webhooks: type: string enum: - requested - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - workflow: *814 + workflow: *815 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 185814be0a..73ea1166d0 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 @@ -58458,7 +58458,7 @@ "/meta": { "get": { "summary": "Get GitHub 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/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/articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names, and the public keys used by GitHub to sign commits made through the web UI.\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" ], @@ -58673,6 +58673,15 @@ ] } }, + "storage": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, "actions": { "type": "array", "items": { @@ -147679,6 +147688,255 @@ } } }, + "/orgs/{org}/interaction-limits/pulls/creation-cap": { + "patch": { + "summary": "Update pull request creation cap for an org", + "description": "Updates the pull request creation cap for an organization. The cap limits the total number\nof open pull requests a user can have across all public repositories in the organization\nat one time.\n\nOnly users with admin access to the organization can configure the cap.", + "tags": [ + "interactions" + ], + "operationId": "interactions/update-pull-request-creation-cap-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/orgs#update-pull-request-creation-cap-for-an-org" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pull request creation cap is enabled" + }, + "max_open_pull_requests": { + "type": "integer", + "description": "The maximum number of open pull requests a user can have at one time", + "minimum": 1, + "maximum": 1000 + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "enabled": true, + "max_open_pull_requests": 1 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pull request creation cap is enabled" + }, + "max_open_pull_requests": { + "type": "integer", + "description": "The maximum number of open pull requests a user can have at one time", + "minimum": 1, + "maximum": 1000 + } + }, + "required": [ + "enabled", + "max_open_pull_requests" + ] + }, + "examples": { + "default": { + "summary": "Response", + "value": { + "enabled": true, + "max_open_pull_requests": 1 + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "405": { + "description": "Method Not Allowed", + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/invitations": { "get": { "summary": "List pending organization invitations", @@ -225864,6 +226122,10 @@ "parent_team_id": { "type": "integer", "description": "The ID of a team to set as the parent team." + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided." } }, "required": [ @@ -227256,6 +227518,11 @@ "type": "integer", "description": "The ID of a team to set as the parent team.", "nullable": true + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided.", + "nullable": true } } }, @@ -229433,7 +229700,7 @@ "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", - "description": "Lists a team's repositories 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}/repos`.", + "description": "Lists a team's repositories visible to the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` or `repo` scope to use this endpoint.\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`.", "tags": [ "teams" ], @@ -423100,7 +423367,7 @@ "properties": { "suggestions": { "type": "object", - "description": "Pending suggestions for each suggestible field (`type`,\n`issue_field_values`, `labels`, `assignees`, `state`) the\nrequest touched. Omitted for fields not in the request or\nwith no pending suggestions. Items tagged `already_applied`\nare echoes of the current request's inputs whose target is\nalready applied to the issue; they are not persisted as\npending suggestions.\n", + "description": "Pending suggestions for each suggestible field (`type`,\n`issue_field_values`, `labels`, `assignees`, `state`) the\nrequest touched. Omitted for fields not in the request or\nwith no pending or ignored suggestions. Items tagged\n`ignored` are echoes of the current request's inputs that\nwere not persisted as pending suggestions.\n", "properties": { "type": { "type": "array", @@ -423124,8 +423391,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -423168,8 +423442,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -423196,8 +423477,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -423224,8 +423512,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -423258,8 +423553,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -541543,200 +541845,1165 @@ "schema": { "type": "integer" } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "nullable": true, - "properties": { - "commit_title": { - "type": "string", - "description": "Title for the automatic commit message." - }, - "commit_message": { - "type": "string", - "description": "Extra detail to append to automatic commit message." - }, - "sha": { - "type": "string", - "description": "SHA that pull request head must match to allow merge." - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - } - }, - "examples": { - "response-if-merge-was-successful": { - "value": { - "commit_title": "Expand enum", - "commit_message": "Add a new value to the merge_method enum" - } - } - } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "commit_title": { + "type": "string", + "description": "Title for the automatic commit message." + }, + "commit_message": { + "type": "string", + "description": "Extra detail to append to automatic commit message." + }, + "sha": { + "type": "string", + "description": "SHA that pull request head must match to allow merge." + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + } + }, + "examples": { + "response-if-merge-was-successful": { + "value": { + "commit_title": "Expand enum", + "commit_message": "Add a new value to the merge_method enum" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "if merge was successful", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Result", + "description": "Pull Request Merge Result", + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "merged": { + "type": "boolean" + }, + "message": { + "type": "string" + } + }, + "required": [ + "merged", + "message", + "sha" + ] + }, + "examples": { + "response-if-merge-was-successful": { + "value": { + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "merged": true, + "message": "Pull Request successfully merged" + } + } + } + } + } + }, + "405": { + "description": "Method Not Allowed if merge cannot be performed", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-merge-cannot-be-performed": { + "value": { + "message": "Pull Request is not mergeable" + } + } + } + } + } + }, + "409": { + "description": "Conflict if sha was provided and pull request head did not match", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-sha-was-provided-and-pull-request-head-did-not-match": { + "value": { + "message": "Head branch was modified. Review and try the merge again." + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "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": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async": { + "put": { + "summary": "Merge a pull request asynchronously", + "description": "Merges a pull request into the base branch in the background. Merging in this way allows certain types of errors to be retried, and avoids the risk of timeouts for particularly complex merges.\n\nThis is the required method for merging stacked PRs, but also supports unstacked PRs. When using this endpoint to merge a stacked pull request, all pull requests in the stack up to and including the requested PR will be merged into the base branch.\n\nThe response includes a UUID that can be used to fetch the result of the merge. If another asynchronous merge request has already been made for this pull request, the UUID of that request will be returned instead with a 409 response status to indicate that the merge options may be different from those that were requested. If there isn't an existing asynchronous merge request, a 202 response status is used.\n\nIf the pull request is already merged, the merge commit OID will be returned immediately with a 200 status.\n\nIf the pull request cannot be merged (e.g. because it is closed, or still a draft) this result will be returned immediately with a 400 response status. Branch protection rules and repository rules are not run at this stage, only basic pull request state checks are performed.", + "tags": [ + "pulls" + ], + "operationId": "pulls/merge-async", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously" + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "commit_title": { + "type": "string", + "description": "Title for the automatic commit message." + }, + "commit_message": { + "type": "string", + "description": "Extra detail to append to automatic commit message." + }, + "sha": { + "type": "string", + "description": "SHA that pull request head must match to allow merge. If not provided, the current head of the PR at the time of the request will be used; if the PR is pushed in between the merge being requested and being executed, the merge will be cancelled." + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "description": "The action that will be taken to merge the pull request. `direct_merge` merges the pull request directly without using a merge queue; `merge_queue` adds the pull request to a merge queue; `default` selects the most appropriate option.", + "enum": [ + "default", + "direct_merge", + "merge_queue" + ] + } + } + }, + "examples": { + "default": { + "value": { + "commit_title": "Fix race condition", + "commit_message": "Avoids a race by trying to read the file and handling the exception if it does not exist.", + "sha": "6358cd125586d9def8c3e5943f23506202da81cc", + "merge_method": "squash", + "merge_action": "default" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "if the merge request was accepted and will run in the background", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", + "type": "object", + "additionalProperties": false, + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] + }, + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] + } + }, + "required": [ + "status", + "details" + ] + }, + "examples": { + "response-if-merge-request-was-accepted": { + "summary": "Request accepted", + "value": { + "status": "pending", + "details": { + "message": "Merge request enqueued.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "merge", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + } + } + } + } + }, + "200": { + "description": "if the pull request was already merged, or is already in a merge queue", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", + "type": "object", + "additionalProperties": false, + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] + }, + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] + } + }, + "required": [ + "status", + "details" + ] + }, + "examples": { + "response-if-pull-request-was-already-merged": { + "summary": "Already merged", + "value": { + "status": "merged", + "details": { + "message": "Pull request is already merged.", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + }, + "response-if-pull-request-is-already-enqueued": { + "summary": "Already enqueued", + "value": { + "status": "enqueued", + "details": { + "message": "Pull request is already in the merge queue." + } + } + } + } + } + } + }, + "409": { + "description": "if there is an existing merge request already enqueued for this pull request", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", + "type": "object", + "additionalProperties": false, + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] + }, + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] + } + }, + "required": [ + "status", + "details" + ] + }, + "examples": { + "response-if-a-merge-request-already-exists": { + "value": { + "status": "pending", + "details": { + "message": "A merge request already exists for this pull request.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "squash", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + } + } + } + } + }, + "400": { + "description": "if the pull request is not ready to be merged, e.g. because it is closed", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", + "type": "object", + "additionalProperties": false, + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] + }, + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] + } + }, + "required": [ + "status", + "details" + ] + }, + "examples": { + "response-if-pull-request-is-not-ready-to-be-merged": { + "value": { + "status": "failed", + "details": { + "message": "Pull request is closed." + } + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "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" + } + } + } + } + } + } + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}": { + "get": { + "summary": "Get the result of an asynchronous merge", + "description": "Fetches the current result of an asynchronous merge request, identified by the UUID that was returned when the merge was requested.\n\nWhile the merge is still queued, the response includes the UUID, merge method, and expected head SHA of the request. Once the merge has completed, the response reports whether it was merged, including the merge commit OID on success or a message describing why it could not be merged on failure.\n\nThe result of an asynchronous merge request is retained for 24 hours after its most recent update. After this window the request expires and this endpoint returns a `404` response for its UUID.", + "tags": [ + "pulls" + ], + "operationId": "pulls/get-merge-async-result", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#get-the-result-of-an-asynchronous-merge" + }, + "x-github": { + "triggersNotification": false, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "uuid", + "description": "The UUID of the asynchronous merge request, as returned when the merge was requested.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { - "description": "if merge was successful", + "description": "the current result of the asynchronous merge request", "content": { "application/json": { "schema": { - "title": "Pull Request Merge Result", - "description": "Pull Request Merge Result", + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", "type": "object", + "additionalProperties": false, "properties": { - "sha": { - "type": "string" - }, - "merged": { - "type": "boolean" + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] }, - "message": { - "type": "string" + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] } }, "required": [ - "merged", - "message", - "sha" + "status", + "details" ] }, "examples": { - "response-if-merge-was-successful": { + "response-if-the-merge-is-still-queued": { + "summary": "Still queued", "value": { - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "merged": true, - "message": "Pull Request successfully merged" - } - } - } - } - } - }, - "405": { - "description": "Method Not Allowed if merge cannot be performed", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "status": "pending", + "details": { + "message": "Merge request is in progress.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "merge", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } } - } - }, - "examples": { - "response-if-merge-cannot-be-performed": { + }, + "response-if-the-pull-request-is-enqueued": { + "summary": "Enqueued in the merge queue", "value": { - "message": "Pull Request is not mergeable" - } - } - } - } - } - }, - "409": { - "description": "Conflict if sha was provided and pull request head did not match", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "status": "enqueued", + "details": { + "message": "Pull request is in the merge queue." + } } - } - }, - "examples": { - "response-if-sha-was-provided-and-pull-request-head-did-not-match": { + }, + "response-if-the-merge-succeeded": { + "summary": "Merge succeeded", "value": { - "message": "Head branch was modified. Review and try the merge again." + "status": "merged", + "details": { + "message": "Pull request was merged.", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } + }, + "response-if-the-merge-failed": { + "summary": "Merge failed", + "value": { + "status": "failed", + "details": { + "message": "Merge conflict: the pull request could not be merged." } } } @@ -541796,13 +543063,6 @@ } } } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" } } }, @@ -614640,6 +615900,11 @@ "type": "integer", "description": "The ID of a team to set as the parent team.", "nullable": true + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided.", + "nullable": true } }, "required": [ 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 a0e2f2d125..c05be4a93b 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 @@ -1001,7 +1001,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &718 + - &719 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -14253,7 +14253,7 @@ paths: properties: action: type: string - discussion: &815 + discussion: &816 title: Discussion description: A Discussion in a repository. type: object @@ -14991,7 +14991,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &730 + sub_issues_summary: &731 title: Sub-issues Summary type: object properties: @@ -15118,7 +15118,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &731 + issue_dependencies_summary: &732 title: Issue Dependencies Summary type: object properties: @@ -15930,7 +15930,7 @@ paths: type: string release: allOf: - - &642 + - &643 title: Release description: A release. type: object @@ -16001,7 +16001,7 @@ paths: author: *4 assets: type: array - items: &643 + items: &644 title: Release Asset description: Data related to a release. type: object @@ -19430,7 +19430,7 @@ paths: 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/articles/about-github-s-ip-addresses/)." - The API's response also includes a list of GitHub's domain names. + The API's response also includes a list of GitHub's domain names, and the public keys used by GitHub to sign commits made through the web UI. The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. @@ -19584,6 +19584,12 @@ paths: type: string example: - example.com + storage: + type: array + items: + type: string + example: + - example.com actions: type: array items: @@ -22238,7 +22244,7 @@ paths: parameters: - *79 - *125 - - &791 + - &792 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 @@ -22350,7 +22356,7 @@ paths: - *125 - *126 - *127 - - &792 + - &793 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -22358,7 +22364,7 @@ paths: schema: type: string - *130 - - &793 + - &794 name: sku description: The SKU to query for usage. in: query @@ -30228,12 +30234,12 @@ paths: required: - subject_digests examples: - default: &772 + default: &773 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &773 + withPredicateType: &774 value: subject_digests: - sha256:abc123 @@ -30277,7 +30283,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &774 + default: &775 value: attestations_subject_digests: - sha256:abc: @@ -39749,6 +39755,86 @@ paths: enabledForGitHubApps: true category: interactions subcategory: orgs + "/orgs/{org}/interaction-limits/pulls/creation-cap": + patch: + summary: Update pull request creation cap for an org + description: |- + Updates the pull request creation cap for an organization. The cap limits the total number + of open pull requests a user can have across all public repositories in the organization + at one time. + + Only users with admin access to the organization can configure the cap. + tags: + - interactions + operationId: interactions/update-pull-request-creation-cap-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/interactions/orgs#update-pull-request-creation-cap-for-an-org + parameters: + - *79 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether the pull request creation cap is enabled + max_open_pull_requests: + type: integer + description: The maximum number of open pull requests a user can + have at one time + minimum: 1 + maximum: 1000 + required: + - enabled + examples: + default: + summary: Example request body + value: + enabled: true + max_open_pull_requests: 1 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether the pull request creation cap is enabled + max_open_pull_requests: + type: integer + description: The maximum number of open pull requests a user can + have at one time + minimum: 1 + maximum: 1000 + required: + - enabled + - max_open_pull_requests + examples: + default: + summary: Response + value: + enabled: true + max_open_pull_requests: 1 + '403': *29 + '404': *6 + '405': + description: Method Not Allowed + content: + application/json: + schema: *3 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: orgs "/orgs/{org}/invitations": get: summary: List pending organization invitations @@ -42270,7 +42356,7 @@ paths: parameters: - *79 - *270 - - &754 + - &755 name: repo_name description: repo_name parameter in: path @@ -43198,7 +43284,7 @@ paths: - nuget - container - *79 - - &755 + - &756 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -43239,7 +43325,7 @@ paths: default: *277 '403': *29 '401': *25 - '400': &757 + '400': &758 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -45447,7 +45533,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &846 + properties: &847 id: type: number description: The unique identifier of the status update. @@ -45495,7 +45581,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &847 + required: &848 - id - node_id - created_at @@ -46339,7 +46425,7 @@ paths: - updated_at - project_url examples: - default: &778 + default: &779 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -46516,7 +46602,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &779 + items: &780 type: object properties: name: @@ -46553,7 +46639,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &780 + iteration_configuration: &781 type: object description: The configuration for iteration fields. properties: @@ -46603,7 +46689,7 @@ paths: value: name: Due date data_type: date - single_select_field: &781 + single_select_field: &782 summary: Create a single select field value: name: Priority @@ -46630,7 +46716,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &782 + iteration_field: &783 summary: Create an iteration field value: name: Sprint @@ -46656,7 +46742,7 @@ paths: application/json: schema: *298 examples: - text_field: &783 + text_field: &784 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -46665,7 +46751,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: &784 + number_field: &785 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -46674,7 +46760,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: &785 + date_field: &786 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -46683,7 +46769,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: &786 + single_select_field: &787 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -46717,7 +46803,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &787 + iteration_field: &788 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -46763,7 +46849,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *294 - - &788 + - &789 name: field_id description: The unique identifier of the field. in: path @@ -46778,7 +46864,7 @@ paths: application/json: schema: *298 examples: - default: &789 + default: &790 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -47975,7 +48061,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &769 + schema: &770 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -48152,7 +48238,7 @@ paths: parameters: - *294 - *79 - - &790 + - &791 name: view_number description: The number that identifies the project view. in: path @@ -50113,7 +50199,7 @@ paths: - *79 - *17 - *19 - - &651 + - &652 name: targets description: | A comma-separated list of rule targets to filter by. @@ -50395,7 +50481,7 @@ paths: - repository_property rules: type: array - items: &652 + items: &653 title: Repository Rule type: object description: A repository rule. @@ -50457,7 +50543,7 @@ paths: type: string enum: - required_linear_history - - &649 + - &650 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -51096,7 +51182,7 @@ paths: type: boolean description: Copilot automatically reviews each new push to the pull request. - - &650 + - &651 title: license_compliance_scanning description: Enforce any added or changed dependencies to comply with the organization's license policy. @@ -51408,7 +51494,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *79 - - &653 + - &654 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 @@ -51423,7 +51509,7 @@ paths: in: query schema: type: string - - &654 + - &655 name: time_period description: |- The time period to filter by. @@ -51439,14 +51525,14 @@ paths: - week - month default: day - - &655 + - &656 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 - - &656 + - &657 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -51459,7 +51545,7 @@ paths: - bypass - all default: all - - &657 + - &658 name: evaluate_status description: |- The evaluate status to filter on. When specified, only rule suites resulting from rulesets with the specified evaluate status will be returned. @@ -51482,7 +51568,7 @@ paths: description: Response content: application/json: - schema: &658 + schema: &659 title: Rule Suites description: Response type: array @@ -51537,7 +51623,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &659 + default: &660 value: - id: 21 actor_id: 12 @@ -51581,7 +51667,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *79 - - &660 + - &661 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -51597,7 +51683,7 @@ paths: description: Response content: application/json: - schema: &661 + schema: &662 title: Rule Suite description: Response type: object @@ -51696,7 +51782,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &662 + default: &663 value: id: 21 actor_id: 12 @@ -51943,7 +52029,7 @@ paths: type: string format: date-time examples: - default: &664 + default: &665 value: - version_id: 3 actor: @@ -51996,7 +52082,7 @@ paths: description: Response content: application/json: - schema: &665 + schema: &666 allOf: - *343 - type: object @@ -52068,7 +52154,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *79 - - &666 + - &667 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -52079,7 +52165,7 @@ paths: enum: - open - resolved - - &667 + - &668 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -52089,7 +52175,7 @@ paths: required: false schema: type: string - - &668 + - &669 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -52100,7 +52186,7 @@ paths: required: false schema: type: string - - &669 + - &670 name: exclude_providers in: query description: |- @@ -52111,7 +52197,7 @@ paths: required: false schema: type: string - - &670 + - &671 name: providers in: query description: |- @@ -52122,7 +52208,7 @@ paths: required: false schema: type: string - - &671 + - &672 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -52131,7 +52217,7 @@ paths: required: false schema: type: string - - &672 + - &673 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -52150,7 +52236,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &673 + - &674 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. @@ -52165,7 +52251,7 @@ paths: - *63 - *19 - *17 - - &674 + - &675 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 @@ -52175,7 +52261,7 @@ paths: required: false schema: type: string - - &675 + - &676 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 @@ -52185,7 +52271,7 @@ paths: required: false schema: type: string - - &676 + - &677 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -52194,7 +52280,7 @@ paths: required: false schema: type: string - - &677 + - &678 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -52203,7 +52289,7 @@ paths: schema: type: boolean default: false - - &678 + - &679 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -52212,7 +52298,7 @@ paths: schema: type: boolean default: false - - &679 + - &680 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -52221,7 +52307,7 @@ paths: schema: type: boolean default: false - - &680 + - &681 name: is_bypassed in: query description: A boolean value (`true` or `false`) indicating whether to filter @@ -52232,7 +52318,7 @@ paths: required: false schema: type: boolean - - &681 + - &682 name: included_metadata in: query description: |- @@ -52243,7 +52329,7 @@ paths: required: false schema: type: string - - &682 + - &683 name: owner_email_hash in: query description: |- @@ -52281,14 +52367,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &683 + state: &684 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: &684 + resolution: &685 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -52405,8 +52491,8 @@ paths: pull request. ' - oneOf: &685 - - &687 + oneOf: &686 + - &688 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -52464,7 +52550,7 @@ paths: - blob_url - commit_sha - commit_url - - &688 + - &689 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. @@ -52519,7 +52605,7 @@ paths: - page_url - commit_sha - commit_url - - &689 + - &690 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -52539,7 +52625,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &690 + - &691 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -52559,7 +52645,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &691 + - &692 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -52579,7 +52665,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &692 + - &693 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -52593,7 +52679,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &693 + - &694 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -52607,7 +52693,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &694 + - &695 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -52621,7 +52707,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &695 + - &696 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. @@ -52641,7 +52727,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &696 + - &697 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. @@ -52661,7 +52747,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &697 + - &698 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. @@ -52681,7 +52767,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &698 + - &699 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. @@ -52701,7 +52787,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &699 + - &700 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. @@ -52953,7 +53039,7 @@ paths: subcategory: custom-patterns parameters: - *79 - - &700 + - &701 name: state description: Filter custom patterns by state. When absent, returns patterns in all states. @@ -52964,7 +53050,7 @@ paths: enum: - published - unpublished - - &701 + - &702 name: push_protection description: Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status. @@ -52975,7 +53061,7 @@ paths: enum: - enabled - disabled - - &702 + - &703 name: sort description: The property to sort the results by. in: query @@ -53069,7 +53155,7 @@ paths: - state - push_protection_enabled examples: - default: &703 + default: &704 value: - id: 1 name: Example Custom Pattern @@ -53132,7 +53218,7 @@ paths: patterns: type: array description: The list of custom patterns to create. - items: &704 + items: &705 title: Secret Scanning Custom Pattern To Create description: A custom pattern to create in a bulk operation. type: object @@ -53169,7 +53255,7 @@ paths: items: type: string examples: - default: &705 + default: &706 value: patterns: - name: Example Custom Pattern @@ -53195,7 +53281,7 @@ paths: description: The list of successfully created custom patterns. items: *344 examples: - default: &706 + default: &707 value: created_patterns: - id: 1 @@ -53247,7 +53333,7 @@ paths: errors: type: array description: List of validation errors for this pattern. - items: &707 + items: &708 title: Secret Scanning Custom Pattern Validation Error description: A validation error for a custom pattern in a batch operation. @@ -53301,7 +53387,7 @@ paths: type: array description: The list of custom patterns to delete. maxItems: 500 - items: &708 + items: &709 title: Secret Scanning Custom Pattern To Delete description: A custom pattern to delete in a bulk operation. type: object @@ -53324,7 +53410,7 @@ paths: - resolve_alerts default: delete_alerts examples: - default: &709 + default: &710 value: patterns: - pattern_id: 2 @@ -53370,7 +53456,7 @@ paths: required: true content: application/json: - schema: &710 + schema: &711 title: Secret Scanning Custom Pattern To Update description: Fields to update on a custom pattern. At least one updatable field (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, @@ -53411,7 +53497,7 @@ paths: type: string custom_pattern_version: *345 examples: - default: &711 + default: &712 value: pattern: updated_secret_[0-9A-Z]{16} start_delimiter: "[^0-9A-Za-z]" @@ -53428,7 +53514,7 @@ paths: application/json: schema: *344 examples: - default: &712 + default: &713 value: id: 1 name: Example Custom Pattern @@ -53732,7 +53818,7 @@ paths: application/json: schema: type: array - items: &716 + items: &717 description: A repository security advisory. type: object properties: @@ -54004,7 +54090,7 @@ paths: - private_fork additionalProperties: false examples: - default: &717 + default: &718 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -55222,6 +55308,10 @@ paths: parent_team_id: type: integer description: The ID of a team to set as the parent team. + parent_team_slug: + type: string + description: The slug of a team to set as the parent team. Ignored + when `parent_team_id` is also provided. required: - name examples: @@ -55715,6 +55805,11 @@ paths: type: integer description: The ID of a team to set as the parent team. nullable: true + parent_team_slug: + type: string + description: The slug of a team to set as the parent team. Ignored + when `parent_team_id` is also provided. + nullable: true examples: default: value: @@ -55849,7 +55944,7 @@ paths: application/json: schema: type: array - items: &733 + items: &734 title: Team Member description: A user that is a member of a team, including their role on the team and whether the membership is inherited from @@ -55968,7 +56063,7 @@ paths: - type - url examples: - default: &734 + default: &735 value: - login: octocat id: 1 @@ -56054,7 +56149,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &735 + response-if-user-is-a-team-maintainer: &736 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -56119,7 +56214,7 @@ paths: application/json: schema: *356 examples: - response-if-users-membership-with-team-is-now-pending: &736 + response-if-users-membership-with-team-is-now-pending: &737 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -56173,6 +56268,8 @@ paths: description: |- Lists a team's repositories visible to the authenticated user. + OAuth app tokens and personal access tokens (classic) need the `read:org` or `repo` scope to use this endpoint. + > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. tags: @@ -56233,7 +56330,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &737 + schema: &738 title: Team Repository description: A team's access to a repository. type: object @@ -56883,7 +56980,7 @@ paths: type: array items: *211 examples: - response-if-child-teams-exist: &738 + response-if-child-teams-exist: &739 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -62524,7 +62621,7 @@ paths: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &809 + properties: &810 url: type: string format: uri @@ -62609,7 +62706,7 @@ paths: nullable: true properties: *84 required: *85 - required: &810 + required: &811 - id - node_id - sha @@ -68681,7 +68778,7 @@ paths: check. type: array items: *94 - deployment: &802 + deployment: &803 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -69593,7 +69690,7 @@ paths: type: string format: date-time nullable: true - head_commit: &830 + head_commit: &831 title: Simple Commit description: A commit. type: object @@ -74337,14 +74434,14 @@ paths: type: integer machines: type: array - items: &743 + items: &744 type: object title: Codespace machine description: A description of the machine powering a codespace. properties: *481 required: *482 examples: - default: &744 + default: &745 value: total_count: 2 machines: @@ -77490,7 +77587,7 @@ paths: application/json: schema: type: array - items: &722 + items: &723 title: Status description: The status of a commit. type: object @@ -78459,7 +78556,7 @@ paths: - size - type - url - - &640 + - &641 title: Content File description: Content File type: object @@ -79073,7 +79170,7 @@ paths: items: type: object properties: - placeholder_id: &713 + placeholder_id: &714 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -85152,7 +85249,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &838 + last_response: &839 title: Hook Response type: object properties: @@ -86204,7 +86301,7 @@ paths: parameters: - *357 - *358 - - &767 + - &768 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -86923,7 +87020,7 @@ paths: type: array items: *559 examples: - default: &759 + default: &760 value: - id: 1 repository: @@ -89453,10 +89550,9 @@ paths: Pending suggestions for each suggestible field (`type`, `issue_field_values`, `labels`, `assignees`, `state`) the request touched. Omitted for fields not in the request or - with no pending suggestions. Items tagged `already_applied` - are echoes of the current request's inputs whose target is - already applied to the issue; they are not persisted as - pending suggestions. + with no pending or ignored suggestions. Items tagged + `ignored` are echoes of the current request's inputs that + were not persisted as pending suggestions. properties: type: type: array @@ -89475,8 +89571,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed issue_field_values: type: array items: @@ -89501,8 +89602,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed labels: type: array items: @@ -89520,8 +89626,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed assignees: type: array items: @@ -89539,8 +89650,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed state: type: array items: @@ -89562,8 +89678,13 @@ paths: - low - medium - high - already_applied: + ignored: type: boolean + ignored_reason: + type: string + enum: + - already_applied + - issue_already_closed examples: default: *571 '422': *15 @@ -98514,6 +98635,287 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async": + put: + summary: Merge a pull request asynchronously + description: |- + Merges a pull request into the base branch in the background. Merging in this way allows certain types of errors to be retried, and avoids the risk of timeouts for particularly complex merges. + + This is the required method for merging stacked PRs, but also supports unstacked PRs. When using this endpoint to merge a stacked pull request, all pull requests in the stack up to and including the requested PR will be merged into the base branch. + + The response includes a UUID that can be used to fetch the result of the merge. If another asynchronous merge request has already been made for this pull request, the UUID of that request will be returned instead with a 409 response status to indicate that the merge options may be different from those that were requested. If there isn't an existing asynchronous merge request, a 202 response status is used. + + If the pull request is already merged, the merge commit OID will be returned immediately with a 200 status. + + If the pull request cannot be merged (e.g. because it is closed, or still a draft) this result will be returned immediately with a 400 response status. Branch protection rules and repository rules are not run at this stage, only basic pull request state checks are performed. + tags: + - pulls + operationId: pulls/merge-async + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + parameters: + - *357 + - *358 + - *633 + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + commit_title: + type: string + description: Title for the automatic commit message. + commit_message: + type: string + description: Extra detail to append to automatic commit message. + sha: + type: string + description: SHA that pull request head must match to allow merge. + If not provided, the current head of the PR at the time of the + request will be used; if the PR is pushed in between the merge + being requested and being executed, the merge will be cancelled. + merge_method: + type: string + description: The merge method to use. + enum: + - merge + - squash + - rebase + merge_action: + type: string + description: The action that will be taken to merge the pull request. + `direct_merge` merges the pull request directly without using + a merge queue; `merge_queue` adds the pull request to a merge + queue; `default` selects the most appropriate option. + enum: + - default + - direct_merge + - merge_queue + examples: + default: + value: + commit_title: Fix race condition + commit_message: Avoids a race by trying to read the file and handling + the exception if it does not exist. + sha: 6358cd125586d9def8c3e5943f23506202da81cc + merge_method: squash + merge_action: default + responses: + '202': + description: if the merge request was accepted and will run in the background + content: + application/json: + schema: &636 + title: Pull Request Merge Async Result + description: Pull Request Merge Async Result + type: object + additionalProperties: false + properties: + status: + type: string + enum: + - pending + - merged + - enqueued + - failed + details: + oneOf: + - description: When an asynchronous merge request was created + or already existed + type: object + additionalProperties: false + properties: + message: + type: string + uuid: + type: string + merge_method: + type: string + enum: + - default + - merge + - squash + - rebase + merge_action: + type: string + enum: + - default + - merge_queue + - direct_merge + expected_head_sha: + type: string + description: SHA that the pull request head must match for + the enqueued merge to proceed. + required: + - message + - uuid + - merge_method + - merge_action + - expected_head_sha + - description: When the pull request cannot be merged + type: object + additionalProperties: false + properties: + message: + type: string + required: + - message + - description: When the pull request is already merged + type: object + additionalProperties: false + properties: + message: + type: string + sha: + type: string + required: + - message + - sha + required: + - status + - details + examples: + response-if-merge-request-was-accepted: + summary: Request accepted + value: + status: pending + details: + message: Merge request enqueued. + uuid: 630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42 + merge_method: merge + merge_action: default + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + '200': + description: if the pull request was already merged, or is already in a + merge queue + content: + application/json: + schema: *636 + examples: + response-if-pull-request-was-already-merged: + summary: Already merged + value: + status: merged + details: + message: Pull request is already merged. + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + response-if-pull-request-is-already-enqueued: + summary: Already enqueued + value: + status: enqueued + details: + message: Pull request is already in the merge queue. + '409': + description: if there is an existing merge request already enqueued for + this pull request + content: + application/json: + schema: *636 + examples: + response-if-a-merge-request-already-exists: + value: + status: pending + details: + message: A merge request already exists for this pull request. + uuid: 630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42 + merge_method: squash + merge_action: default + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + '400': + description: if the pull request is not ready to be merged, e.g. because + it is closed + content: + application/json: + schema: *636 + examples: + response-if-pull-request-is-not-ready-to-be-merged: + value: + status: failed + details: + message: Pull request is closed. + '422': *15 + '403': *29 + '404': *6 + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}": + get: + summary: Get the result of an asynchronous merge + description: |- + Fetches the current result of an asynchronous merge request, identified by the UUID that was returned when the merge was requested. + + While the merge is still queued, the response includes the UUID, merge method, and expected head SHA of the request. Once the merge has completed, the response reports whether it was merged, including the merge commit OID on success or a message describing why it could not be merged on failure. + + The result of an asynchronous merge request is retained for 24 hours after its most recent update. After this window the request expires and this endpoint returns a `404` response for its UUID. + tags: + - pulls + operationId: pulls/get-merge-async-result + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#get-the-result-of-an-asynchronous-merge + x-github: + triggersNotification: false + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + parameters: + - *357 + - *358 + - *633 + - name: uuid + description: The UUID of the asynchronous merge request, as returned when + the merge was requested. + in: path + required: true + schema: + type: string + responses: + '200': + description: the current result of the asynchronous merge request + content: + application/json: + schema: *636 + examples: + response-if-the-merge-is-still-queued: + summary: Still queued + value: + status: pending + details: + message: Merge request is in progress. + uuid: 630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42 + merge_method: merge + merge_action: default + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + response-if-the-pull-request-is-enqueued: + summary: Enqueued in the merge queue + value: + status: enqueued + details: + message: Pull request is in the merge queue. + response-if-the-merge-succeeded: + summary: Merge succeeded + value: + status: merged + details: + message: Pull request was merged. + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + response-if-the-merge-failed: + summary: Merge failed + value: + status: failed + details: + message: 'Merge conflict: the pull request could not be merged.' + '403': *29 + '404': *6 "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": get: summary: Get all requested reviewers for a pull request @@ -99714,7 +100116,7 @@ paths: application/json: schema: type: array - items: &636 + items: &637 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -99953,9 +100355,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *637 examples: - default: &638 + default: &639 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -100021,7 +100423,7 @@ paths: - *357 - *358 - *633 - - &637 + - &638 name: review_id description: The unique identifier of the review. in: path @@ -100033,9 +100435,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *637 examples: - default: &639 + default: &640 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -100097,7 +100499,7 @@ paths: - *357 - *358 - *633 - - *637 + - *638 requestBody: required: true content: @@ -100120,7 +100522,7 @@ paths: description: Response content: application/json: - schema: *636 + schema: *637 examples: default: value: @@ -100185,15 +100587,15 @@ paths: - *357 - *358 - *633 - - *637 + - *638 responses: '200': description: Response content: application/json: - schema: *636 + schema: *637 examples: - default: *638 + default: *639 '422': *7 '404': *6 x-github: @@ -100223,7 +100625,7 @@ paths: - *357 - *358 - *633 - - *637 + - *638 - *17 - *19 responses: @@ -100461,7 +100863,7 @@ paths: - *357 - *358 - *633 - - *637 + - *638 requestBody: required: true content: @@ -100489,7 +100891,7 @@ paths: description: Response content: application/json: - schema: *636 + schema: *637 examples: default: value: @@ -100555,7 +100957,7 @@ paths: - *357 - *358 - *633 - - *637 + - *638 requestBody: required: true content: @@ -100590,9 +100992,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *637 examples: - default: *639 + default: *640 '404': *6 '422': *7 '403': *29 @@ -100693,9 +101095,9 @@ paths: description: Response content: application/json: - schema: *640 + schema: *641 examples: - default: &641 + default: &642 value: type: file encoding: base64 @@ -100758,9 +101160,9 @@ paths: description: Response content: application/json: - schema: *640 + schema: *641 examples: - default: *641 + default: *642 '404': *6 '422': *15 x-github: @@ -100793,7 +101195,7 @@ paths: application/json: schema: type: array - items: *642 + items: *643 examples: default: value: @@ -100969,9 +101371,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: &646 + default: &647 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -101078,7 +101480,7 @@ paths: parameters: - *357 - *358 - - &644 + - &645 name: asset_id description: The unique identifier of the asset. in: path @@ -101090,9 +101492,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *644 examples: - default: &645 + default: &646 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 @@ -101145,7 +101547,7 @@ paths: parameters: - *357 - *358 - - *644 + - *645 requestBody: required: false content: @@ -101173,9 +101575,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *644 examples: - default: *645 + default: *646 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101193,7 +101595,7 @@ paths: parameters: - *357 - *358 - - *644 + - *645 responses: '204': description: Response @@ -101311,9 +101713,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: *646 + default: *647 '404': *6 x-github: githubCloudOnly: false @@ -101345,9 +101747,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: *646 + default: *647 '404': *6 x-github: githubCloudOnly: false @@ -101371,7 +101773,7 @@ paths: parameters: - *357 - *358 - - &647 + - &648 name: release_id description: The unique identifier of the release. in: path @@ -101385,9 +101787,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: *642 + schema: *643 examples: - default: *646 + default: *647 '401': description: Unauthorized x-github: @@ -101413,7 +101815,7 @@ paths: parameters: - *357 - *358 - - *647 + - *648 requestBody: required: false content: @@ -101477,9 +101879,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: - default: *646 + default: *647 '404': description: Not Found if the discussion category name is invalid content: @@ -101502,7 +101904,7 @@ paths: parameters: - *357 - *358 - - *647 + - *648 responses: '204': description: Response @@ -101525,7 +101927,7 @@ paths: parameters: - *357 - *358 - - *647 + - *648 - *17 - *19 responses: @@ -101535,7 +101937,7 @@ paths: application/json: schema: type: array - items: *643 + items: *644 examples: default: value: @@ -101618,7 +102020,7 @@ paths: parameters: - *357 - *358 - - *647 + - *648 - name: name in: query required: true @@ -101644,7 +102046,7 @@ paths: description: Response for successful upload content: application/json: - schema: *643 + schema: *644 examples: response-for-successful-upload: value: @@ -101701,7 +102103,7 @@ paths: parameters: - *357 - *358 - - *647 + - *648 - 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. @@ -101750,7 +102152,7 @@ paths: parameters: - *357 - *358 - - *647 + - *648 requestBody: required: true content: @@ -101813,7 +102215,7 @@ paths: parameters: - *357 - *358 - - *647 + - *648 - *564 responses: '204': @@ -101857,7 +102259,7 @@ paths: oneOf: - allOf: - *319 - - &648 + - &649 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -101878,70 +102280,70 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *320 - - *648 + - *649 - allOf: - *321 - - *648 + - *649 - allOf: - *322 - - *648 + - *649 - allOf: + - *650 - *649 - - *648 - allOf: - *323 - - *648 + - *649 - allOf: - *324 - - *648 + - *649 - allOf: - *325 - - *648 + - *649 - allOf: - *326 - - *648 + - *649 - allOf: - *327 - - *648 + - *649 - allOf: - *328 - - *648 + - *649 - allOf: - *329 - - *648 + - *649 - allOf: - *330 - - *648 + - *649 - allOf: - *331 - - *648 + - *649 - allOf: - *332 - - *648 + - *649 - allOf: - *337 - - *648 + - *649 - allOf: - *338 - - *648 + - *649 - allOf: - *339 - - *648 + - *649 - allOf: - - *650 - - *648 + - *651 + - *649 - allOf: - *333 - - *648 + - *649 - allOf: - *334 - - *648 + - *649 - allOf: - *335 - - *648 + - *649 - allOf: - *336 - - *648 + - *649 examples: default: value: @@ -101992,7 +102394,7 @@ paths: schema: type: boolean default: true - - *651 + - *652 responses: '200': description: Response @@ -102077,7 +102479,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *652 + items: *653 required: - name - enforcement @@ -102110,7 +102512,7 @@ paths: application/json: schema: *340 examples: - default: &663 + default: &664 value: id: 42 name: super cool ruleset @@ -102160,11 +102562,11 @@ paths: parameters: - *357 - *358 - - *653 - *654 - *655 - *656 - *657 + - *658 - *17 - *19 responses: @@ -102172,9 +102574,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *659 examples: - default: *659 + default: *660 '404': *6 '500': *56 x-github: @@ -102197,15 +102599,15 @@ paths: parameters: - *357 - *358 - - *660 + - *661 responses: '200': description: Response content: application/json: - schema: *661 + schema: *662 examples: - default: *662 + default: *663 '404': *6 '500': *56 x-github: @@ -102256,7 +102658,7 @@ paths: application/json: schema: *340 examples: - default: *663 + default: *664 '404': *6 '500': *56 put: @@ -102309,7 +102711,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *652 + items: *653 examples: default: value: @@ -102339,7 +102741,7 @@ paths: application/json: schema: *340 examples: - default: *663 + default: *664 '404': *6 '422': *15 '500': *56 @@ -102401,7 +102803,7 @@ paths: type: array items: *343 examples: - default: *664 + default: *665 '404': *6 '500': *56 x-github: @@ -102439,7 +102841,7 @@ paths: description: Response content: application/json: - schema: *665 + schema: *666 examples: default: value: @@ -102496,7 +102898,6 @@ paths: parameters: - *357 - *358 - - *666 - *667 - *668 - *669 @@ -102504,10 +102905,10 @@ paths: - *671 - *672 - *673 + - *674 - *63 - *19 - *17 - - *674 - *675 - *676 - *677 @@ -102516,6 +102917,7 @@ paths: - *680 - *681 - *682 + - *683 responses: '200': description: Response @@ -102542,8 +102944,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *683 - resolution: *684 + state: *684 + resolution: *685 resolved_at: type: string format: date-time @@ -102649,7 +103051,7 @@ paths: pull request. ' - oneOf: *685 + oneOf: *686 nullable: true has_more_locations: type: boolean @@ -102816,13 +103218,13 @@ paths: - *357 - *358 - *457 - - *679 + - *680 responses: '200': description: Response content: application/json: - schema: &686 + schema: &687 type: object properties: number: *189 @@ -102840,8 +103242,8 @@ paths: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *683 - resolution: *684 + state: *684 + resolution: *685 resolved_at: type: string format: date-time @@ -102947,7 +103349,7 @@ paths: pull request. ' - oneOf: *685 + oneOf: *686 nullable: true has_more_locations: type: boolean @@ -102975,7 +103377,7 @@ paths: properties: *20 required: *21 nullable: true - metadata: &859 + metadata: &860 type: array description: A list of metadata key/value pairs associated with the secret scanning alert. @@ -103058,8 +103460,8 @@ paths: schema: type: object properties: - state: *683 - resolution: *684 + state: *684 + resolution: *685 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -103103,7 +103505,7 @@ paths: description: Response content: application/json: - schema: *686 + schema: *687 examples: default: value: @@ -103218,7 +103620,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &861 + items: &862 type: object properties: type: @@ -103244,7 +103646,6 @@ paths: example: commit details: oneOf: - - *687 - *688 - *689 - *690 @@ -103257,6 +103658,7 @@ paths: - *697 - *698 - *699 + - *700 examples: default: value: @@ -103347,9 +103749,9 @@ paths: parameters: - *357 - *358 - - *700 - *701 - *702 + - *703 - *63 - *19 - *17 @@ -103362,7 +103764,7 @@ paths: type: array items: *344 examples: - default: *703 + default: *704 headers: Link: *71 '403': *29 @@ -103399,9 +103801,9 @@ paths: patterns: type: array description: The list of custom patterns to create. - items: *704 + items: *705 examples: - default: *705 + default: *706 responses: '201': description: All patterns created successfully. @@ -103415,7 +103817,7 @@ paths: description: The list of successfully created custom patterns. items: *344 examples: - default: *706 + default: *707 '400': *14 '403': *29 '404': *6 @@ -103439,7 +103841,7 @@ paths: errors: type: array description: List of validation errors for this pattern. - items: *707 + items: *708 delete: summary: Bulk delete repository custom patterns description: |- @@ -103473,7 +103875,7 @@ paths: type: array description: The list of custom patterns to delete. maxItems: 500 - items: *708 + items: *709 post_delete_action: type: string description: |- @@ -103486,7 +103888,7 @@ paths: - resolve_alerts default: delete_alerts examples: - default: *709 + default: *710 responses: '204': description: All patterns deleted successfully. @@ -103525,9 +103927,9 @@ paths: required: true content: application/json: - schema: *710 + schema: *711 examples: - default: *711 + default: *712 responses: '200': description: Pattern updated successfully. @@ -103535,7 +103937,7 @@ paths: application/json: schema: *344 examples: - default: *712 + default: *713 '400': *14 '403': *29 '404': *6 @@ -103566,14 +103968,14 @@ paths: schema: type: object properties: - reason: &714 + reason: &715 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *713 + placeholder_id: *714 required: - reason - placeholder_id @@ -103590,7 +103992,7 @@ paths: schema: type: object properties: - reason: *714 + reason: *715 expire_at: type: string format: date-time @@ -103652,7 +104054,7 @@ paths: properties: incremental_scans: type: array - items: &715 + items: &716 description: Information on a single scan performed by secret scanning on the repository type: object @@ -103683,15 +104085,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *715 + items: *716 backfill_scans: type: array - items: *715 + items: *716 custom_pattern_backfill_scans: type: array items: allOf: - - *715 + - *716 - type: object properties: pattern_name: @@ -103704,7 +104106,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *715 + items: *716 examples: default: value: @@ -103814,9 +104216,9 @@ paths: application/json: schema: type: array - items: *716 + items: *717 examples: - default: *717 + default: *718 '400': *14 '404': *6 x-github: @@ -104000,9 +104402,9 @@ paths: description: Response content: application/json: - schema: *716 + schema: *717 examples: - default: &719 + default: &720 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -104337,7 +104739,7 @@ paths: description: Response content: application/json: - schema: *716 + schema: *717 examples: default: value: @@ -104485,15 +104887,15 @@ paths: parameters: - *357 - *358 - - *718 + - *719 responses: '200': description: Response content: application/json: - schema: *716 + schema: *717 examples: - default: *719 + default: *720 '403': *29 '404': *6 x-github: @@ -104519,7 +104921,7 @@ paths: parameters: - *357 - *358 - - *718 + - *719 requestBody: required: true content: @@ -104678,10 +105080,10 @@ paths: description: Response content: application/json: - schema: *716 + schema: *717 examples: - default: *719 - add_credit: *719 + default: *720 + add_credit: *720 '403': *29 '404': *6 '422': @@ -104721,7 +105123,7 @@ paths: parameters: - *357 - *358 - - *718 + - *719 responses: '202': *40 '400': *14 @@ -104750,7 +105152,7 @@ paths: parameters: - *357 - *358 - - *718 + - *719 responses: '202': description: Response @@ -104980,7 +105382,7 @@ paths: format: date-time pull_requests: type: array - items: &720 + items: &721 title: Pull Request Stack Pull Request type: object allOf: @@ -105256,7 +105658,7 @@ paths: format: date-time pull_requests: type: array - items: *720 + items: *721 examples: default: value: @@ -105449,7 +105851,7 @@ paths: format: date-time pull_requests: type: array - items: *720 + items: *721 examples: default: value: @@ -105703,7 +106105,7 @@ paths: format: date-time pull_requests: type: array - items: *720 + items: *721 examples: default: value: @@ -105919,7 +106321,7 @@ paths: application/json: schema: type: array - items: &721 + items: &722 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -106292,7 +106694,7 @@ paths: application/json: schema: type: array - items: *721 + items: *722 examples: default: value: @@ -106380,7 +106782,7 @@ paths: description: Response content: application/json: - schema: *722 + schema: *723 examples: default: value: @@ -106474,7 +106876,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &723 + schema: &724 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -106569,7 +106971,7 @@ paths: description: Response content: application/json: - schema: *723 + schema: *724 examples: default: value: @@ -106776,7 +107178,7 @@ paths: description: Response content: application/json: - schema: &724 + schema: &725 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -106788,7 +107190,7 @@ paths: required: - names examples: - default: &725 + default: &726 value: names: - octocat @@ -106843,9 +107245,9 @@ paths: description: Response content: application/json: - schema: *724 + schema: *725 examples: - default: *725 + default: *726 '404': *6 '422': *7 x-github: @@ -106868,7 +107270,7 @@ paths: parameters: - *357 - *358 - - &726 + - &727 name: per description: The time frame to display results for. in: query @@ -106897,7 +107299,7 @@ paths: example: 128 clones: type: array - items: &727 + items: &728 title: Traffic type: object properties: @@ -107138,7 +107540,7 @@ paths: parameters: - *357 - *358 - - *726 + - *727 responses: '200': description: Response @@ -107157,7 +107559,7 @@ paths: example: 3782 views: type: array - items: *727 + items: *728 required: - uniques - count @@ -107928,7 +108330,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &728 + text_matches: &729 title: Search Result Text Matches type: array items: @@ -108090,7 +108492,7 @@ paths: enum: - author-date - committer-date - - &729 + - &730 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 @@ -108218,7 +108620,7 @@ paths: type: number node_id: type: string - text_matches: *728 + text_matches: *729 required: - sha - node_id @@ -108410,7 +108812,7 @@ paths: - interactions - created - updated - - *729 + - *730 - *17 - *19 - name: advanced_search @@ -108524,8 +108926,8 @@ paths: description: type: string nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -108553,7 +108955,7 @@ paths: type: string format: date-time nullable: true - text_matches: *728 + text_matches: *729 pull_request: type: object properties: @@ -108833,7 +109235,7 @@ paths: enum: - created - updated - - *729 + - *730 - *17 - *19 responses: @@ -108877,7 +109279,7 @@ paths: nullable: true score: type: number - text_matches: *728 + text_matches: *729 required: - id - node_id @@ -108962,7 +109364,7 @@ paths: - forks - help-wanted-issues - updated - - *729 + - *730 - *17 - *19 responses: @@ -109210,7 +109612,7 @@ paths: - admin - pull - push - text_matches: *728 + text_matches: *729 temp_clone_token: type: string allow_merge_commit: @@ -109510,7 +109912,7 @@ paths: type: string format: uri nullable: true - text_matches: *728 + text_matches: *729 related: type: array nullable: true @@ -109701,7 +110103,7 @@ paths: - followers - repositories - joined - - *729 + - *730 - *17 - *19 responses: @@ -109805,7 +110207,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *728 + text_matches: *729 blog: type: string nullable: true @@ -109884,7 +110286,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &732 + - &733 name: team_id description: The unique identifier of the team. in: path @@ -109925,7 +110327,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *732 + - *733 requestBody: required: true content: @@ -109974,6 +110376,11 @@ paths: type: integer description: The ID of a team to set as the parent team. nullable: true + parent_team_slug: + type: string + description: The slug of a team to set as the parent team. Ignored + when `parent_team_id` is also provided. + nullable: true required: - name examples: @@ -110025,7 +110432,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *732 + - *733 responses: '204': description: Response @@ -110054,7 +110461,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *732 + - *733 - *17 - *19 responses: @@ -110094,7 +110501,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *732 + - *733 - name: role description: Filters members returned by their role in the team. in: query @@ -110115,9 +110522,9 @@ paths: application/json: schema: type: array - items: *733 + items: *734 examples: - default: *734 + default: *735 headers: Link: *71 '404': *6 @@ -110145,7 +110552,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *732 + - *733 - *75 responses: '204': @@ -110182,7 +110589,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *732 + - *733 - *75 responses: '204': @@ -110222,7 +110629,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *732 + - *733 - *75 responses: '204': @@ -110259,7 +110666,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *732 + - *733 - *75 responses: '200': @@ -110268,7 +110675,7 @@ paths: application/json: schema: *356 examples: - response-if-user-is-a-team-maintainer: *735 + response-if-user-is-a-team-maintainer: *736 '404': *6 x-github: githubCloudOnly: false @@ -110301,7 +110708,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *732 + - *733 - *75 requestBody: required: false @@ -110329,7 +110736,7 @@ paths: application/json: schema: *356 examples: - response-if-users-membership-with-team-is-now-pending: *736 + response-if-users-membership-with-team-is-now-pending: *737 '403': description: Forbidden if team synchronization is set up '422': @@ -110363,7 +110770,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *732 + - *733 - *75 responses: '204': @@ -110391,7 +110798,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *732 + - *733 - *17 - *19 responses: @@ -110433,7 +110840,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *732 + - *733 - *357 - *358 responses: @@ -110441,7 +110848,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *737 + schema: *738 examples: alternative-response-with-extra-repository-information: value: @@ -110591,7 +110998,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *732 + - *733 - *357 - *358 requestBody: @@ -110643,7 +111050,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *732 + - *733 - *357 - *358 responses: @@ -110670,7 +111077,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *732 + - *733 - *17 - *19 responses: @@ -110682,7 +111089,7 @@ paths: type: array items: *211 examples: - response-if-child-teams-exist: *738 + response-if-child-teams-exist: *739 headers: Link: *71 '404': *6 @@ -110715,7 +111122,7 @@ paths: application/json: schema: oneOf: - - &739 + - &740 title: Private User description: Private User type: object @@ -110918,7 +111325,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - &766 + - &767 title: Public User description: Public User type: object @@ -111230,7 +111637,7 @@ paths: description: Response content: application/json: - schema: *739 + schema: *740 examples: default: value: @@ -111628,7 +112035,7 @@ paths: type: integer secrets: type: array - items: &740 + items: &741 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -111744,7 +112151,7 @@ paths: description: Response content: application/json: - schema: *740 + schema: *741 examples: default: value: @@ -112157,7 +112564,7 @@ paths: description: Response content: application/json: - schema: &741 + schema: &742 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -112198,7 +112605,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &742 + default: &743 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -112243,9 +112650,9 @@ paths: description: Response content: application/json: - schema: *741 + schema: *742 examples: - default: *742 + default: *743 '404': *6 x-github: githubCloudOnly: false @@ -112282,9 +112689,9 @@ paths: type: integer machines: type: array - items: *743 + items: *744 examples: - default: *744 + default: *745 '304': *38 '500': *56 '401': *25 @@ -113223,7 +113630,7 @@ paths: type: array items: *276 examples: - default: &756 + default: &757 value: - id: 197 name: hello_docker @@ -113324,7 +113731,7 @@ paths: application/json: schema: type: array - items: &745 + items: &746 title: Email description: Email type: object @@ -113389,9 +113796,9 @@ paths: application/json: schema: type: array - items: *745 + items: *746 examples: - default: &758 + default: &759 value: - email: octocat@github.com verified: true @@ -113466,7 +113873,7 @@ paths: application/json: schema: type: array - items: *745 + items: *746 examples: default: value: @@ -113722,7 +114129,7 @@ paths: application/json: schema: type: array - items: &746 + items: &747 title: GPG Key description: A unique encryption key type: object @@ -113853,7 +114260,7 @@ paths: - subkeys - revoked examples: - default: &776 + default: &777 value: - id: 3 name: Octocat's GPG Key @@ -113938,9 +114345,9 @@ paths: description: Response content: application/json: - schema: *746 + schema: *747 examples: - default: &747 + default: &748 value: id: 3 name: Octocat's GPG Key @@ -113997,7 +114404,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &748 + - &749 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -114009,9 +114416,9 @@ paths: description: Response content: application/json: - schema: *746 + schema: *747 examples: - default: *747 + default: *748 '404': *6 '304': *38 '403': *29 @@ -114034,7 +114441,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *748 + - *749 responses: '204': description: Response @@ -114501,7 +114908,7 @@ paths: application/json: schema: type: array - items: &749 + items: &750 title: Key description: Key type: object @@ -114602,9 +115009,9 @@ paths: description: Response content: application/json: - schema: *749 + schema: *750 examples: - default: &750 + default: &751 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -114643,9 +115050,9 @@ paths: description: Response content: application/json: - schema: *749 + schema: *750 examples: - default: *750 + default: *751 '404': *6 '304': *38 '403': *29 @@ -114701,7 +115108,7 @@ paths: application/json: schema: type: array - items: &751 + items: &752 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -114769,7 +115176,7 @@ paths: - account - plan examples: - default: &752 + default: &753 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -114831,9 +115238,9 @@ paths: application/json: schema: type: array - items: *751 + items: *752 examples: - default: *752 + default: *753 headers: Link: *71 '304': *38 @@ -115076,7 +115483,7 @@ paths: application/json: schema: *267 examples: - default: &753 + default: &754 value: url: https://api.github.com/orgs/octocat/memberships/defunkt state: active @@ -115125,7 +115532,7 @@ paths: application/json: schema: *267 examples: - default: *753 + default: *754 '403': *29 '404': *6 '422': *15 @@ -115850,7 +116257,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *270 - - *754 + - *755 responses: '204': description: Response @@ -115963,7 +116370,7 @@ paths: - docker - nuget - container - - *755 + - *756 - *19 - *17 responses: @@ -115975,8 +116382,8 @@ paths: type: array items: *276 examples: - default: *756 - '400': *757 + default: *757 + '400': *758 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -116005,7 +116412,7 @@ paths: application/json: schema: *276 examples: - default: &777 + default: &778 value: id: 40201 name: octo-name @@ -116367,9 +116774,9 @@ paths: application/json: schema: type: array - items: *745 + items: *746 examples: - default: *758 + default: *759 headers: Link: *71 '304': *38 @@ -116482,7 +116889,7 @@ paths: type: array items: *83 examples: - default: &765 + default: &766 summary: Default response value: - id: 1296269 @@ -116829,7 +117236,7 @@ paths: type: array items: *559 examples: - default: *759 + default: *760 headers: Link: *71 '304': *38 @@ -116909,7 +117316,7 @@ paths: application/json: schema: type: array - items: &760 + items: &761 title: Social account description: Social media account type: object @@ -116924,7 +117331,7 @@ paths: - provider - url examples: - default: &761 + default: &762 value: - provider: twitter url: https://twitter.com/github @@ -116986,9 +117393,9 @@ paths: application/json: schema: type: array - items: *760 + items: *761 examples: - default: *761 + default: *762 '422': *15 '304': *38 '404': *6 @@ -117075,7 +117482,7 @@ paths: application/json: schema: type: array - items: &762 + items: &763 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -117095,7 +117502,7 @@ paths: - title - created_at examples: - default: &794 + default: &795 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -117159,9 +117566,9 @@ paths: description: Response content: application/json: - schema: *762 + schema: *763 examples: - default: &763 + default: &764 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -117191,7 +117598,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: - - &764 + - &765 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -117203,9 +117610,9 @@ paths: description: Response content: application/json: - schema: *762 + schema: *763 examples: - default: *763 + default: *764 '404': *6 '304': *38 '403': *29 @@ -117228,7 +117635,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: - - *764 + - *765 responses: '204': description: Response @@ -117257,7 +117664,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &795 + - &796 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 @@ -117282,11 +117689,11 @@ paths: type: array items: *83 examples: - default-response: *765 + default-response: *766 application/vnd.github.v3.star+json: schema: type: array - items: &796 + items: &797 title: Starred Repository description: Starred Repository type: object @@ -117655,10 +118062,10 @@ paths: application/json: schema: oneOf: - - *739 - - *766 + - *740 + - *767 examples: - default-response: &770 + default-response: &771 summary: Default response value: login: octocat @@ -117693,7 +118100,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &771 + response-with-git-hub-plan-information: &772 summary: Response with GitHub plan information value: login: octocat @@ -117750,7 +118157,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &768 + - &769 name: user_id description: The unique identifier of the user. in: path @@ -117816,7 +118223,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *767 + - *768 - *17 responses: '200': @@ -117851,7 +118258,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *768 + - *769 - *294 requestBody: required: true @@ -117923,7 +118330,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *769 + schema: *770 examples: table_view: summary: Response for creating a table view @@ -117975,11 +118382,11 @@ paths: application/json: schema: oneOf: - - *739 - - *766 + - *740 + - *767 examples: - default-response: *770 - response-with-git-hub-plan-information: *771 + default-response: *771 + response-with-git-hub-plan-information: *772 '404': *6 x-github: githubCloudOnly: false @@ -118029,8 +118436,8 @@ paths: required: - subject_digests examples: - default: *772 - withPredicateType: *773 + default: *773 + withPredicateType: *774 responses: '200': description: Response @@ -118069,7 +118476,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *774 + default: *775 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -118539,7 +118946,7 @@ paths: application/json: schema: *205 examples: - default: &775 + default: &776 summary: Example response for a user copilot space value: id: 42 @@ -118640,7 +119047,7 @@ paths: application/json: schema: *205 examples: - default: *775 + default: *776 '403': *29 '404': *6 x-github: @@ -118763,7 +119170,7 @@ paths: application/json: schema: *205 examples: - default: *775 + default: *776 '403': *29 '404': *6 '422': *15 @@ -119531,7 +119938,7 @@ paths: type: array items: *276 examples: - default: *756 + default: *757 '403': *29 '401': *25 x-github: @@ -119915,9 +120322,9 @@ paths: application/json: schema: type: array - items: *746 + items: *747 examples: - default: *776 + default: *777 headers: Link: *71 x-github: @@ -120145,7 +120552,7 @@ paths: - docker - nuget - container - - *755 + - *756 - *75 - *19 - *17 @@ -120158,10 +120565,10 @@ paths: type: array items: *276 examples: - default: *756 + default: *757 '403': *29 '401': *25 - '400': *757 + '400': *758 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120191,7 +120598,7 @@ paths: application/json: schema: *276 examples: - default: *777 + default: *778 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120540,7 +120947,7 @@ paths: type: array items: *298 examples: - default: *778 + default: *779 headers: Link: *71 '304': *38 @@ -120600,7 +121007,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *779 + items: *780 required: - name - data_type @@ -120616,7 +121023,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *780 + iteration_configuration: *781 required: - name - data_type @@ -120638,8 +121045,8 @@ paths: value: name: Due date data_type: date - single_select_field: *781 - iteration_field: *782 + single_select_field: *782 + iteration_field: *783 responses: '201': description: Response @@ -120647,11 +121054,11 @@ paths: application/json: schema: *298 examples: - text_field: *783 - number_field: *784 - date_field: *785 - single_select_field: *786 - iteration_field: *787 + text_field: *784 + number_field: *785 + date_field: *786 + single_select_field: *787 + iteration_field: *788 '304': *38 '403': *29 '401': *25 @@ -120673,7 +121080,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *294 - - *788 + - *789 - *75 responses: '200': @@ -120682,7 +121089,7 @@ paths: application/json: schema: *298 examples: - default: *789 + default: *790 headers: Link: *71 '304': *38 @@ -121036,7 +121443,7 @@ paths: parameters: - *294 - *75 - - *790 + - *791 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -121575,7 +121982,7 @@ paths: parameters: - *75 - *125 - - *791 + - *792 - *127 responses: '200': @@ -121674,9 +122081,9 @@ paths: - *125 - *126 - *127 - - *792 - - *130 - *793 + - *130 + - *794 responses: '200': description: Response when getting a billing usage summary @@ -121810,9 +122217,9 @@ paths: application/json: schema: type: array - items: *760 + items: *761 examples: - default: *761 + default: *762 headers: Link: *71 x-github: @@ -121842,9 +122249,9 @@ paths: application/json: schema: type: array - items: *762 + items: *763 examples: - default: *794 + default: *795 headers: Link: *71 x-github: @@ -121869,7 +122276,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *75 - - *795 + - *796 - *63 - *17 - *19 @@ -121881,11 +122288,11 @@ paths: schema: anyOf: - type: array - items: *796 + items: *797 - type: array items: *83 examples: - default-response: *765 + default-response: *766 headers: Link: *71 x-github: @@ -122044,7 +122451,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &797 + enterprise: &798 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -122102,7 +122509,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &798 + installation: &799 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -122121,7 +122528,7 @@ x-webhooks: required: - id - node_id - organization: &799 + organization: &800 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -122181,13 +122588,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &800 + repository: &801 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: &832 + properties: &833 id: description: Unique identifier of the repository example: 42 @@ -122871,7 +123278,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &833 + required: &834 - archive_url - assignees_url - blobs_url @@ -123022,10 +123429,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -123101,11 +123508,11 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - rule: &801 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + rule: &802 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) @@ -123328,11 +123735,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - rule: *801 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + rule: *802 sender: *4 required: - action @@ -123515,11 +123922,11 @@ x-webhooks: - everyone required: - from - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - rule: *801 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + rule: *802 sender: *4 required: - action @@ -123603,7 +124010,7 @@ x-webhooks: type: string enum: - completed - check_run: &803 + check_run: &804 title: CheckRun description: A check performed on the code of a given code change type: object @@ -123694,7 +124101,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *802 + deployment: *803 details_url: example: https://example.com type: string @@ -123779,10 +124186,10 @@ x-webhooks: - output - app - pull_requests - installation: *798 - enterprise: *797 - organization: *799 - repository: *800 + installation: *799 + enterprise: *798 + organization: *800 + repository: *801 sender: *4 required: - check_run @@ -124173,11 +124580,11 @@ x-webhooks: type: string enum: - created - check_run: *803 - installation: *798 - enterprise: *797 - organization: *799 - repository: *800 + check_run: *804 + installation: *799 + enterprise: *798 + organization: *800 + repository: *801 sender: *4 required: - check_run @@ -124571,11 +124978,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *803 - installation: *798 - enterprise: *797 - organization: *799 - repository: *800 + check_run: *804 + installation: *799 + enterprise: *798 + organization: *800 + repository: *801 requested_action: description: The action requested by the user. type: object @@ -124978,11 +125385,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *803 - installation: *798 - enterprise: *797 - organization: *799 - repository: *800 + check_run: *804 + installation: *799 + enterprise: *798 + organization: *800 + repository: *801 sender: *4 required: - check_run @@ -125952,10 +126359,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -126654,10 +127061,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -127350,10 +127757,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -127664,20 +128071,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &804 + commit_oid: &805 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: *797 - installation: *798 - organization: *799 - ref: &805 + enterprise: *798 + installation: *799 + organization: *800 + ref: &806 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: *800 + repository: *801 sender: *4 required: - action @@ -128072,12 +128479,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *804 - enterprise: *797 - installation: *798 - organization: *799 - ref: *805 - repository: *800 + commit_oid: *805 + enterprise: *798 + installation: *799 + organization: *800 + ref: *806 + repository: *801 sender: *4 required: - action @@ -128343,12 +128750,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *804 - enterprise: *797 - installation: *798 - organization: *799 - ref: *805 - repository: *800 + commit_oid: *805 + enterprise: *798 + installation: *799 + organization: *800 + ref: *806 + repository: *801 sender: *4 required: - action @@ -128680,12 +129087,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *804 - enterprise: *797 - installation: *798 - organization: *799 - ref: *805 - repository: *800 + commit_oid: *805 + enterprise: *798 + installation: *799 + organization: *800 + ref: *806 + repository: *801 sender: *4 required: - action @@ -128959,16 +129366,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 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: *800 + repository: *801 sender: *4 required: - action @@ -129205,12 +129612,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *804 - enterprise: *797 - installation: *798 - organization: *799 - ref: *805 - repository: *800 + commit_oid: *805 + enterprise: *798 + installation: *799 + organization: *800 + ref: *806 + repository: *801 sender: *4 required: - action @@ -129521,10 +129928,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -129779,10 +130186,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -129862,18 +130269,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *799 - pusher_type: &806 + organization: *800 + pusher_type: &807 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &807 + ref: &808 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -129883,7 +130290,7 @@ x-webhooks: enum: - tag - branch - repository: *800 + repository: *801 sender: *4 required: - ref @@ -129966,9 +130373,9 @@ x-webhooks: enum: - created definition: *306 - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 sender: *4 required: - action @@ -130053,9 +130460,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 sender: *4 required: - action @@ -130133,9 +130540,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *306 - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 sender: *4 required: - action @@ -130213,9 +130620,9 @@ x-webhooks: enum: - updated definition: *306 - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 sender: *4 required: - action @@ -130292,10 +130699,10 @@ x-webhooks: type: string enum: - updated - enterprise: *797 - installation: *798 - repository: *800 - organization: *799 + enterprise: *798 + installation: *799 + repository: *801 + organization: *800 sender: *4 new_property_values: type: array @@ -130380,18 +130787,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *797 - installation: *798 - organization: *799 - pusher_type: *806 - ref: *807 + enterprise: *798 + installation: *799 + organization: *800 + pusher_type: *807 + ref: *808 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *800 + repository: *801 sender: *4 required: - ref @@ -130472,10 +130879,10 @@ x-webhooks: enum: - assignees_changed alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -130556,10 +130963,10 @@ x-webhooks: enum: - auto_dismissed alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -130641,10 +131048,10 @@ x-webhooks: enum: - auto_reopened alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -130726,10 +131133,10 @@ x-webhooks: enum: - created alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -130809,10 +131216,10 @@ x-webhooks: enum: - dismissed alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -130892,10 +131299,10 @@ x-webhooks: enum: - fixed alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -130976,10 +131383,10 @@ x-webhooks: enum: - reintroduced alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -131059,10 +131466,10 @@ x-webhooks: enum: - reopened alert: *515 - installation: *798 - organization: *799 - enterprise: *797 - repository: *800 + installation: *799 + organization: *800 + enterprise: *798 + repository: *801 sender: *4 required: - action @@ -131139,9 +131546,9 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - key: &808 + enterprise: *798 + installation: *799 + key: &809 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -131177,8 +131584,8 @@ x-webhooks: - verified - created_at - read_only - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -131255,11 +131662,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - key: *808 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + key: *809 + organization: *800 + repository: *801 sender: *4 required: - action @@ -131815,12 +132222,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - workflow: &814 + workflow: &815 title: Workflow type: object nullable: true @@ -132561,15 +132968,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *809 - required: *810 + properties: *810 + required: *811 nullable: true pull_requests: type: array items: *631 - repository: *800 - organization: *799 - installation: *798 + repository: *801 + organization: *800 + installation: *799 sender: *4 responses: '200': @@ -132640,7 +133047,7 @@ x-webhooks: type: string enum: - approved - approver: &811 + approver: &812 type: object properties: avatar_url: @@ -132683,11 +133090,11 @@ x-webhooks: type: string comment: type: string - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - reviewers: &812 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + reviewers: &813 type: array items: type: object @@ -132766,7 +133173,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &813 + workflow_job_run: &814 type: object properties: conclusion: @@ -133497,18 +133904,18 @@ x-webhooks: type: string enum: - rejected - approver: *811 + approver: *812 comment: type: string - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - reviewers: *812 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + reviewers: *813 sender: *4 since: type: string - workflow_job_run: *813 + workflow_job_run: *814 workflow_job_runs: type: array items: @@ -134212,13 +134619,13 @@ x-webhooks: type: string enum: - requested - enterprise: *797 + enterprise: *798 environment: type: string - installation: *798 - organization: *799 - repository: *800 - requestor: &819 + installation: *799 + organization: *800 + repository: *801 + requestor: &820 title: User type: object nullable: true @@ -136107,12 +136514,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - workflow: *814 + workflow: *815 workflow_run: title: Deployment Workflow Run type: object @@ -136792,7 +137199,7 @@ x-webhooks: type: string enum: - answered - answer: &817 + answer: &818 type: object properties: author_association: @@ -136949,11 +137356,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -137080,11 +137487,11 @@ x-webhooks: - from required: - category - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -137167,11 +137574,11 @@ x-webhooks: type: string enum: - closed - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -137253,7 +137660,7 @@ x-webhooks: type: string enum: - created - comment: &816 + comment: &817 type: object properties: author_association: @@ -137410,11 +137817,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -137497,12 +137904,12 @@ x-webhooks: type: string enum: - deleted - comment: *816 - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + comment: *817 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -137597,12 +138004,12 @@ x-webhooks: - from required: - body - comment: *816 - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + comment: *817 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -137686,11 +138093,11 @@ x-webhooks: type: string enum: - created - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -137772,11 +138179,11 @@ x-webhooks: type: string enum: - deleted - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -137876,11 +138283,11 @@ x-webhooks: type: string required: - from - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -137962,10 +138369,10 @@ x-webhooks: type: string enum: - labeled - discussion: *815 - enterprise: *797 - installation: *798 - label: &818 + discussion: *816 + enterprise: *798 + installation: *799 + label: &819 title: Label type: object properties: @@ -137997,8 +138404,8 @@ x-webhooks: - color - default - description - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138081,11 +138488,11 @@ x-webhooks: type: string enum: - locked - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138167,11 +138574,11 @@ x-webhooks: type: string enum: - pinned - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138253,11 +138660,11 @@ x-webhooks: type: string enum: - reopened - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138342,16 +138749,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *815 - new_repository: *800 + new_discussion: *816 + new_repository: *801 required: - new_discussion - new_repository - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138434,10 +138841,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *815 - old_answer: *817 - organization: *799 - repository: *800 + discussion: *816 + old_answer: *818 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138519,12 +138926,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *815 - enterprise: *797 - installation: *798 - label: *818 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + label: *819 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138607,11 +139014,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138693,11 +139100,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *815 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + discussion: *816 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -138770,7 +139177,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *797 + enterprise: *798 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -139430,9 +139837,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - forkee @@ -139578,9 +139985,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pages: description: The pages that were updated. type: array @@ -139617,7 +140024,7 @@ x-webhooks: - action - sha - html_url - repository: *800 + repository: *801 sender: *4 required: - pages @@ -139693,10 +140100,10 @@ x-webhooks: type: string enum: - created - enterprise: *797 + enterprise: *798 installation: *22 - organization: *799 - repositories: &820 + organization: *800 + repositories: &821 description: An array of repository objects that the installation can access. type: array @@ -139722,8 +140129,8 @@ x-webhooks: - name - full_name - private - repository: *800 - requester: *819 + repository: *801 + requester: *820 sender: *4 required: - action @@ -139798,11 +140205,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 + enterprise: *798 installation: *22 - organization: *799 - repositories: *820 - repository: *800 + organization: *800 + repositories: *821 + repository: *801 requester: nullable: true sender: *4 @@ -139878,11 +140285,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *797 + enterprise: *798 installation: *22 - organization: *799 - repositories: *820 - repository: *800 + organization: *800 + repositories: *821 + repository: *801 requester: nullable: true sender: *4 @@ -139958,10 +140365,10 @@ x-webhooks: type: string enum: - added - enterprise: *797 + enterprise: *798 installation: *22 - organization: *799 - repositories_added: &821 + organization: *800 + repositories_added: &822 description: An array of repository objects, which were added to the installation. type: array @@ -140007,15 +140414,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *800 - repository_selection: &822 + repository: *801 + repository_selection: &823 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *819 + requester: *820 sender: *4 required: - action @@ -140094,10 +140501,10 @@ x-webhooks: type: string enum: - removed - enterprise: *797 + enterprise: *798 installation: *22 - organization: *799 - repositories_added: *821 + organization: *800 + repositories_added: *822 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -140124,9 +140531,9 @@ x-webhooks: - name - full_name - private - repository: *800 - repository_selection: *822 - requester: *819 + repository: *801 + repository_selection: *823 + requester: *820 sender: *4 required: - action @@ -140205,11 +140612,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *797 + enterprise: *798 installation: *22 - organization: *799 - repositories: *820 - repository: *800 + organization: *800 + repositories: *821 + repository: *801 requester: nullable: true sender: *4 @@ -140387,10 +140794,10 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 target_type: type: string @@ -140469,11 +140876,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *797 + enterprise: *798 installation: *22 - organization: *799 - repositories: *820 - repository: *800 + organization: *800 + repositories: *821 + repository: *801 requester: nullable: true sender: *4 @@ -140740,8 +141147,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -141530,8 +141937,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141880,8 +142287,8 @@ x-webhooks: - state - locked - assignee - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -141961,7 +142368,7 @@ x-webhooks: type: string enum: - deleted - comment: &823 + comment: &824 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -142141,8 +142548,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -142927,8 +143334,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143279,8 +143686,8 @@ x-webhooks: - state - locked - assignee - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -143360,7 +143767,7 @@ x-webhooks: type: string enum: - edited - changes: &852 + changes: &853 description: The changes to the comment. type: object properties: @@ -143372,9 +143779,9 @@ x-webhooks: type: string required: - from - comment: *823 - enterprise: *797 - installation: *798 + comment: *824 + enterprise: *798 + installation: *799 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -144162,8 +144569,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144512,8 +144919,8 @@ x-webhooks: - state - locked - assignee - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -144594,9 +145001,9 @@ x-webhooks: type: string enum: - pinned - comment: *823 - enterprise: *797 - installation: *798 + comment: *824 + enterprise: *798 + installation: *799 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -145386,8 +145793,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145738,8 +146145,8 @@ x-webhooks: - state - locked - assignee - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -145819,9 +146226,9 @@ x-webhooks: type: string enum: - unpinned - comment: *823 - enterprise: *797 - installation: *798 + comment: *824 + enterprise: *798 + installation: *799 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -146611,8 +147018,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146963,8 +147370,8 @@ x-webhooks: - state - locked - assignee - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -147053,9 +147460,9 @@ x-webhooks: type: number blocking_issue: *89 blocking_issue_repo: *83 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -147144,9 +147551,9 @@ x-webhooks: type: number blocking_issue: *89 blocking_issue_repo: *83 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -147234,9 +147641,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *89 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -147325,9 +147732,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *89 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -147407,10 +147814,10 @@ x-webhooks: type: string enum: - assigned - assignee: *819 - enterprise: *797 - installation: *798 - issue: &824 + assignee: *820 + enterprise: *798 + installation: *799 + issue: &825 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -148202,8 +148609,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -148323,8 +148730,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -148404,8 +148811,8 @@ x-webhooks: type: string enum: - closed - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -149202,8 +149609,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -149458,8 +149865,8 @@ x-webhooks: required: - state - closed_at - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -149538,8 +149945,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150327,8 +150734,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -150447,8 +150854,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -150527,8 +150934,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -151338,8 +151745,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -151437,7 +151844,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &825 + milestone: &826 title: Milestone description: A collection of related issues and pull requests. type: object @@ -151575,8 +151982,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -151675,8 +152082,8 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152468,8 +152875,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -152589,9 +152996,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *818 - organization: *799 - repository: *800 + label: *819 + organization: *800 + repository: *801 sender: *4 required: - action @@ -152671,9 +153078,9 @@ x-webhooks: type: string enum: - field_added - enterprise: *797 - installation: *798 - issue: *824 + enterprise: *798 + installation: *799 + issue: *825 issue_field: type: object description: The issue field whose value was set or updated on the @@ -152827,8 +153234,8 @@ x-webhooks: - id required: - from - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -152908,9 +153315,9 @@ x-webhooks: type: string enum: - field_removed - enterprise: *797 - installation: *798 - issue: *824 + enterprise: *798 + installation: *799 + issue: *825 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -152991,8 +153398,8 @@ x-webhooks: nullable: true required: - id - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -153072,8 +153479,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -153864,8 +154271,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -153985,9 +154392,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *818 - organization: *799 - repository: *800 + label: *819 + organization: *800 + repository: *801 sender: *4 required: - action @@ -154067,8 +154474,8 @@ x-webhooks: type: string enum: - locked - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -154883,8 +155290,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -154981,8 +155388,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -155061,8 +155468,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -155871,8 +156278,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -155969,9 +156376,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *825 - organization: *799 - repository: *800 + milestone: *826 + organization: *800 + repository: *801 sender: *4 required: - action @@ -156834,8 +157241,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -157419,8 +157826,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -158204,8 +158611,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -158332,8 +158739,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -158413,9 +158820,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *797 - installation: *798 - issue: &826 + enterprise: *798 + installation: *799 + issue: &827 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -159201,8 +159608,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -159321,8 +159728,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -159401,8 +159808,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -160215,8 +160622,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -160314,8 +160721,8 @@ x-webhooks: user_view_type: type: string type: *258 - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -161184,8 +161591,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -161783,11 +162190,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *797 - installation: *798 - issue: *826 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + issue: *827 + organization: *800 + repository: *801 sender: *4 required: - action @@ -161867,12 +162274,12 @@ x-webhooks: type: string enum: - typed - enterprise: *797 - installation: *798 - issue: *824 + enterprise: *798 + installation: *799 + issue: *825 type: *258 - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -161953,7 +162360,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &855 + assignee: &856 title: User type: object nullable: true @@ -162023,11 +162430,11 @@ x-webhooks: required: - login - id - enterprise: *797 - installation: *798 - issue: *824 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + issue: *825 + organization: *800 + repository: *801 sender: *4 required: - action @@ -162106,12 +162513,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *797 - installation: *798 - issue: *824 - label: *818 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + issue: *825 + label: *819 + organization: *800 + repository: *801 sender: *4 required: - action @@ -162191,8 +162598,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -163005,8 +163412,8 @@ x-webhooks: properties: *90 required: *91 nullable: true - sub_issues_summary: *730 - issue_dependencies_summary: *731 + sub_issues_summary: *731 + issue_dependencies_summary: *732 issue_field_values: type: array items: *576 @@ -163103,8 +163510,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -163184,11 +163591,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *797 - installation: *798 - issue: *826 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + issue: *827 + organization: *800 + repository: *801 sender: *4 required: - action @@ -163267,12 +163674,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *797 - installation: *798 - issue: *824 + enterprise: *798 + installation: *799 + issue: *825 type: *258 - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -163352,11 +163759,11 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - label: *818 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + label: *819 + organization: *800 + repository: *801 sender: *4 required: - action @@ -163434,11 +163841,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - label: *818 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + label: *819 + organization: *800 + repository: *801 sender: *4 required: - action @@ -163548,11 +163955,11 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - label: *818 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + label: *819 + organization: *800 + repository: *801 sender: *4 required: - action @@ -163634,9 +164041,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *797 - installation: *798 - marketplace_purchase: &827 + enterprise: *798 + installation: *799 + marketplace_purchase: &828 title: Marketplace Purchase type: object required: @@ -163719,8 +164126,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *799 - previous_marketplace_purchase: &828 + organization: *800 + previous_marketplace_purchase: &829 title: Marketplace Purchase type: object properties: @@ -163800,7 +164207,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *800 + repository: *801 sender: *4 required: - action @@ -163880,10 +164287,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *797 - installation: *798 - marketplace_purchase: *827 - organization: *799 + enterprise: *798 + installation: *799 + marketplace_purchase: *828 + organization: *800 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -163966,7 +164373,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *800 + repository: *801 sender: *4 required: - action @@ -164048,10 +164455,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *797 - installation: *798 - marketplace_purchase: *827 - organization: *799 + enterprise: *798 + installation: *799 + marketplace_purchase: *828 + organization: *800 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -164133,7 +164540,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *800 + repository: *801 sender: *4 required: - action @@ -164214,8 +164621,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 marketplace_purchase: title: Marketplace Purchase type: object @@ -164297,9 +164704,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *799 - previous_marketplace_purchase: *828 - repository: *800 + organization: *800 + previous_marketplace_purchase: *829 + repository: *801 sender: *4 required: - action @@ -164379,12 +164786,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *797 - installation: *798 - marketplace_purchase: *827 - organization: *799 - previous_marketplace_purchase: *828 - repository: *800 + enterprise: *798 + installation: *799 + marketplace_purchase: *828 + organization: *800 + previous_marketplace_purchase: *829 + repository: *801 sender: *4 required: - action @@ -164486,11 +164893,11 @@ x-webhooks: type: string required: - to - enterprise: *797 - installation: *798 - member: *819 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + member: *820 + organization: *800 + repository: *801 sender: *4 required: - action @@ -164590,11 +164997,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *797 - installation: *798 - member: *819 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + member: *820 + organization: *800 + repository: *801 sender: *4 required: - action @@ -164673,11 +165080,11 @@ x-webhooks: type: string enum: - removed - enterprise: *797 - installation: *798 - member: *819 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + member: *820 + organization: *800 + repository: *801 sender: *4 required: - action @@ -164755,11 +165162,11 @@ x-webhooks: type: string enum: - added - enterprise: *797 - installation: *798 - member: *819 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + member: *820 + organization: *800 + repository: *801 scope: description: The scope of the membership. Currently, can only be `team`. @@ -164835,7 +165242,7 @@ x-webhooks: required: - login - id - team: &829 + team: &830 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -165058,11 +165465,11 @@ x-webhooks: type: string enum: - removed - enterprise: *797 - installation: *798 - member: *819 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + member: *820 + organization: *800 + repository: *801 scope: description: The scope of the membership. Currently, can only be `team`. @@ -165139,7 +165546,7 @@ x-webhooks: required: - login - id - team: *829 + team: *830 required: - action - scope @@ -165221,8 +165628,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *798 - merge_group: &831 + installation: *799 + merge_group: &832 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -165241,15 +165648,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *830 + head_commit: *831 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -165335,10 +165742,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *798 - merge_group: *831 - organization: *799 - repository: *800 + installation: *799 + merge_group: *832 + organization: *800 + repository: *801 sender: *4 required: - action @@ -165411,7 +165818,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 + enterprise: *798 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -165520,16 +165927,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *798 - organization: *799 + installation: *799 + organization: *800 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: *832 - required: *833 + properties: *833 + required: *834 nullable: true sender: *4 required: @@ -165610,11 +166017,11 @@ x-webhooks: type: string enum: - closed - enterprise: *797 - installation: *798 - milestone: *825 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + milestone: *826 + organization: *800 + repository: *801 sender: *4 required: - action @@ -165693,9 +166100,9 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - milestone: &834 + enterprise: *798 + installation: *799 + milestone: &835 title: Milestone description: A collection of related issues and pull requests. type: object @@ -165832,8 +166239,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -165912,11 +166319,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - milestone: *825 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + milestone: *826 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166026,11 +166433,11 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - milestone: *825 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + milestone: *826 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166110,11 +166517,11 @@ x-webhooks: type: string enum: - opened - enterprise: *797 - installation: *798 - milestone: *834 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + milestone: *835 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166193,11 +166600,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *819 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + blocked_user: *820 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166276,11 +166683,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *819 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + blocked_user: *820 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166359,9 +166766,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - membership: &835 + enterprise: *798 + installation: *799 + membership: &836 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -166468,8 +166875,8 @@ x-webhooks: - role - organization_url - user - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166547,11 +166954,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *797 - installation: *798 - membership: *835 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + membership: *836 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166630,8 +167037,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -166747,10 +167154,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 - user: *819 + user: *820 required: - action - invitation @@ -166828,11 +167235,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *797 - installation: *798 - membership: *835 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + membership: *836 + organization: *800 + repository: *801 sender: *4 required: - action @@ -166919,11 +167326,11 @@ x-webhooks: properties: from: type: string - enterprise: *797 - installation: *798 - membership: *835 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + membership: *836 + organization: *800 + repository: *801 sender: *4 required: - action @@ -167000,9 +167407,9 @@ x-webhooks: type: string enum: - published - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 package: description: Information about the package. type: object @@ -167501,7 +167908,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &836 + items: &837 title: Ruby Gems metadata type: object properties: @@ -167596,7 +168003,7 @@ x-webhooks: - owner - package_version - registry - repository: *800 + repository: *801 sender: *4 required: - action @@ -167672,9 +168079,9 @@ x-webhooks: type: string enum: - updated - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 package: description: Information about the package. type: object @@ -168027,7 +168434,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *836 + items: *837 source_url: type: string format: uri @@ -168097,7 +168504,7 @@ x-webhooks: - owner - package_version - registry - repository: *800 + repository: *801 sender: *4 required: - action @@ -168273,12 +168680,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *797 + enterprise: *798 id: type: integer - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - id @@ -168355,7 +168762,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &837 + personal_access_token_request: &838 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -168501,10 +168908,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *797 - organization: *799 + enterprise: *798 + organization: *800 sender: *4 - installation: *798 + installation: *799 required: - action - personal_access_token_request @@ -168581,11 +168988,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *837 - enterprise: *797 - organization: *799 + personal_access_token_request: *838 + enterprise: *798 + organization: *800 sender: *4 - installation: *798 + installation: *799 required: - action - personal_access_token_request @@ -168661,11 +169068,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *837 - enterprise: *797 - organization: *799 + personal_access_token_request: *838 + enterprise: *798 + organization: *800 sender: *4 - installation: *798 + installation: *799 required: - action - personal_access_token_request @@ -168740,11 +169147,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *837 - organization: *799 - enterprise: *797 + personal_access_token_request: *838 + organization: *800 + enterprise: *798 sender: *4 - installation: *798 + installation: *799 required: - action - personal_access_token_request @@ -168849,7 +169256,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *838 + last_response: *839 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -168881,8 +169288,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 zen: description: Random string of GitHub zen. @@ -169127,10 +169534,10 @@ x-webhooks: - from required: - note - enterprise: *797 - installation: *798 - organization: *799 - project_card: &839 + enterprise: *798 + installation: *799 + organization: *800 + project_card: &840 title: Project Card type: object properties: @@ -169249,7 +169656,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *800 + repository: *801 sender: *4 required: - action @@ -169330,11 +169737,11 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - project_card: *839 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + project_card: *840 + repository: *801 sender: *4 required: - action @@ -169414,9 +169821,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 project_card: title: Project Card type: object @@ -169544,8 +169951,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: *832 - required: *833 + properties: *833 + required: *834 nullable: true sender: *4 required: @@ -169639,11 +170046,11 @@ x-webhooks: - from required: - note - enterprise: *797 - installation: *798 - organization: *799 - project_card: *839 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + project_card: *840 + repository: *801 sender: *4 required: - action @@ -169737,9 +170144,9 @@ x-webhooks: - from required: - column_id - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 project_card: allOf: - title: Project Card @@ -169929,7 +170336,7 @@ x-webhooks: type: string required: - after_id - repository: *800 + repository: *801 sender: *4 required: - action @@ -170009,10 +170416,10 @@ x-webhooks: type: string enum: - closed - enterprise: *797 - installation: *798 - organization: *799 - project: &841 + enterprise: *798 + installation: *799 + organization: *800 + project: &842 title: Project type: object properties: @@ -170136,7 +170543,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *800 + repository: *801 sender: *4 required: - action @@ -170216,10 +170623,10 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - project_column: &840 + enterprise: *798 + installation: *799 + organization: *800 + project_column: &841 title: Project Column type: object properties: @@ -170258,7 +170665,7 @@ x-webhooks: - name - created_at - updated_at - repository: *800 + repository: *801 sender: *4 required: - action @@ -170337,18 +170744,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 - project_column: *840 + enterprise: *798 + installation: *799 + organization: *800 + project_column: *841 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: *832 - required: *833 + properties: *833 + required: *834 nullable: true sender: *4 required: @@ -170438,11 +170845,11 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - organization: *799 - project_column: *840 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + project_column: *841 + repository: *801 sender: *4 required: - action @@ -170522,11 +170929,11 @@ x-webhooks: type: string enum: - moved - enterprise: *797 - installation: *798 - organization: *799 - project_column: *840 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + project_column: *841 + repository: *801 sender: *4 required: - action @@ -170606,11 +171013,11 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - project: *841 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + project: *842 + repository: *801 sender: *4 required: - action @@ -170690,18 +171097,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 - project: *841 + enterprise: *798 + installation: *799 + organization: *800 + project: *842 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: *832 - required: *833 + properties: *833 + required: *834 nullable: true sender: *4 required: @@ -170803,11 +171210,11 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - organization: *799 - project: *841 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + project: *842 + repository: *801 sender: *4 required: - action @@ -170886,11 +171293,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *797 - installation: *798 - organization: *799 - project: *841 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + project: *842 + repository: *801 sender: *4 required: - action @@ -170971,8 +171378,8 @@ x-webhooks: type: string enum: - closed - installation: *798 - organization: *799 + installation: *799 + organization: *800 projects_v2: *292 sender: *4 required: @@ -171054,8 +171461,8 @@ x-webhooks: type: string enum: - created - installation: *798 - organization: *799 + installation: *799 + organization: *800 projects_v2: *292 sender: *4 required: @@ -171137,8 +171544,8 @@ x-webhooks: type: string enum: - deleted - installation: *798 - organization: *799 + installation: *799 + organization: *800 projects_v2: *292 sender: *4 required: @@ -171256,8 +171663,8 @@ x-webhooks: type: string to: type: string - installation: *798 - organization: *799 + installation: *799 + organization: *800 projects_v2: *292 sender: *4 required: @@ -171341,7 +171748,7 @@ x-webhooks: type: string enum: - archived - changes: &845 + changes: &846 type: object properties: archived_at: @@ -171355,9 +171762,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *798 - organization: *799 - projects_v2_item: &842 + installation: *799 + organization: *800 + projects_v2_item: &843 title: Projects v2 Item description: An item belonging to a project type: object @@ -171492,9 +171899,9 @@ x-webhooks: nullable: true to: type: string - installation: *798 - organization: *799 - projects_v2_item: *842 + installation: *799 + organization: *800 + projects_v2_item: *843 sender: *4 required: - action @@ -171576,9 +171983,9 @@ x-webhooks: type: string enum: - created - installation: *798 - organization: *799 - projects_v2_item: *842 + installation: *799 + organization: *800 + projects_v2_item: *843 sender: *4 required: - action @@ -171659,9 +172066,9 @@ x-webhooks: type: string enum: - deleted - installation: *798 - organization: *799 - projects_v2_item: *842 + installation: *799 + organization: *800 + projects_v2_item: *843 sender: *4 required: - action @@ -171767,7 +172174,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &843 + - &844 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -171789,7 +172196,7 @@ x-webhooks: required: - id - name - - &844 + - &845 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -171823,8 +172230,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *843 - *844 + - *845 required: - field_value - type: object @@ -171840,9 +172247,9 @@ x-webhooks: nullable: true required: - body - installation: *798 - organization: *799 - projects_v2_item: *842 + installation: *799 + organization: *800 + projects_v2_item: *843 sender: *4 required: - action @@ -171937,9 +172344,9 @@ x-webhooks: to: type: string nullable: true - installation: *798 - organization: *799 - projects_v2_item: *842 + installation: *799 + organization: *800 + projects_v2_item: *843 sender: *4 required: - action @@ -172022,10 +172429,10 @@ x-webhooks: type: string enum: - restored - changes: *845 - installation: *798 - organization: *799 - projects_v2_item: *842 + changes: *846 + installation: *799 + organization: *800 + projects_v2_item: *843 sender: *4 required: - action @@ -172107,8 +172514,8 @@ x-webhooks: type: string enum: - reopened - installation: *798 - organization: *799 + installation: *799 + organization: *800 projects_v2: *292 sender: *4 required: @@ -172190,14 +172597,14 @@ x-webhooks: type: string enum: - created - installation: *798 - organization: *799 - projects_v2_status_update: &848 + installation: *799 + organization: *800 + projects_v2_status_update: &849 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *846 - required: *847 + properties: *847 + required: *848 sender: *4 required: - action @@ -172278,9 +172685,9 @@ x-webhooks: type: string enum: - deleted - installation: *798 - organization: *799 - projects_v2_status_update: *848 + installation: *799 + organization: *800 + projects_v2_status_update: *849 sender: *4 required: - action @@ -172416,9 +172823,9 @@ x-webhooks: type: string format: date nullable: true - installation: *798 - organization: *799 - projects_v2_status_update: *848 + installation: *799 + organization: *800 + projects_v2_status_update: *849 sender: *4 required: - action @@ -172489,10 +172896,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - repository @@ -172569,13 +172976,13 @@ x-webhooks: type: string enum: - assigned - assignee: *819 - enterprise: *797 - installation: *798 - number: &849 + assignee: *820 + enterprise: *798 + installation: *799 + number: &850 description: The pull request number. type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -174863,7 +175270,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -174945,11 +175352,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -177232,7 +177639,7 @@ x-webhooks: - draft reason: type: string - repository: *800 + repository: *801 sender: *4 required: - action @@ -177314,11 +177721,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -179601,7 +180008,7 @@ x-webhooks: - draft reason: type: string - repository: *800 + repository: *801 sender: *4 required: - action @@ -179683,11 +180090,11 @@ x-webhooks: type: string enum: - closed - enterprise: *797 - installation: *798 - number: *849 - organization: *799 - pull_request: &850 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 + pull_request: &851 allOf: - *631 - type: object @@ -179751,7 +180158,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *800 + repository: *801 sender: *4 required: - action @@ -179832,12 +180239,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *797 - installation: *798 - number: *849 - organization: *799 - pull_request: *850 - repository: *800 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 + pull_request: *851 + repository: *801 sender: *4 required: - action @@ -179917,11 +180324,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *797 + enterprise: *798 milestone: *614 - number: *849 - organization: *799 - pull_request: &851 + number: *850 + organization: *800 + pull_request: &852 title: Pull Request type: object properties: @@ -182203,7 +182610,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -182282,11 +182689,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -184587,7 +184994,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *800 + repository: *801 sender: *4 required: - action @@ -184711,12 +185118,12 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - number: *849 - organization: *799 - pull_request: *850 - repository: *800 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 + pull_request: *851 + repository: *801 sender: *4 required: - action @@ -184796,11 +185203,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -187086,7 +187493,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -187166,11 +187573,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *797 - installation: *798 - label: *818 - number: *849 - organization: *799 + enterprise: *798 + installation: *799 + label: *819 + number: *850 + organization: *800 pull_request: title: Pull Request type: object @@ -189457,7 +189864,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -189538,10 +189945,10 @@ x-webhooks: type: string enum: - locked - enterprise: *797 - installation: *798 - number: *849 - organization: *799 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 pull_request: title: Pull Request type: object @@ -191826,7 +192233,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -191906,12 +192313,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *797 + enterprise: *798 milestone: *614 - number: *849 - organization: *799 - pull_request: *851 - repository: *800 + number: *850 + organization: *800 + pull_request: *852 + repository: *801 sender: *4 required: - action @@ -191990,12 +192397,12 @@ x-webhooks: type: string enum: - opened - enterprise: *797 - installation: *798 - number: *849 - organization: *799 - pull_request: *850 - repository: *800 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 + pull_request: *851 + repository: *801 sender: *4 required: - action @@ -192076,12 +192483,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *797 - installation: *798 - number: *849 - organization: *799 - pull_request: *850 - repository: *800 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 + pull_request: *851 + repository: *801 sender: *4 required: - action @@ -192161,12 +192568,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *797 - installation: *798 - number: *849 - organization: *799 - pull_request: *850 - repository: *800 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 + pull_request: *851 + repository: *801 sender: *4 required: - action @@ -192532,9 +192939,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pull_request: type: object properties: @@ -194709,7 +195116,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *800 + repository: *801 sender: *4 required: - action @@ -194789,7 +195196,7 @@ x-webhooks: type: string enum: - deleted - comment: &853 + comment: &854 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -195074,9 +195481,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pull_request: type: object properties: @@ -197239,7 +197646,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *800 + repository: *801 sender: *4 required: - action @@ -197319,11 +197726,11 @@ x-webhooks: type: string enum: - edited - changes: *852 - comment: *853 - enterprise: *797 - installation: *798 - organization: *799 + changes: *853 + comment: *854 + enterprise: *798 + installation: *799 + organization: *800 pull_request: type: object properties: @@ -199489,7 +199896,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *800 + repository: *801 sender: *4 required: - action @@ -199570,9 +199977,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pull_request: title: Simple Pull Request type: object @@ -201750,7 +202157,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *800 + repository: *801 review: description: The review that was affected. type: object @@ -201997,9 +202404,9 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pull_request: title: Simple Pull Request type: object @@ -204049,8 +204456,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *800 - review: &854 + repository: *801 + review: &855 description: The review that was affected. type: object properties: @@ -204283,12 +204690,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: description: The pull request number. type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -206576,7 +206983,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 requested_reviewer: title: User type: object @@ -206660,12 +207067,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: description: The pull request number. type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -208960,7 +209367,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 requested_team: title: Team description: Groups of organization members that gives permissions @@ -209152,12 +209559,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: description: The pull request number. type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -211447,7 +211854,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 requested_reviewer: title: User type: object @@ -211532,12 +211939,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 number: description: The pull request number. type: integer - organization: *799 + organization: *800 pull_request: title: Pull Request type: object @@ -213818,7 +214225,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 requested_team: title: Team description: Groups of organization members that gives permissions @@ -213999,9 +214406,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pull_request: title: Simple Pull Request type: object @@ -216181,8 +216588,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *800 - review: *854 + repository: *801 + review: *855 sender: *4 required: - action @@ -216262,9 +216669,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pull_request: title: Simple Pull Request type: object @@ -218353,7 +218760,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *800 + repository: *801 sender: *4 thread: type: object @@ -218740,9 +219147,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 pull_request: title: Simple Pull Request type: object @@ -220817,7 +221224,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *800 + repository: *801 sender: *4 thread: type: object @@ -221201,11 +221608,11 @@ x-webhooks: type: string enum: - stacked - enterprise: *797 - installation: *798 + enterprise: *798 + installation: *799 stack: *628 - number: *849 - organization: *799 + number: *850 + organization: *800 pull_request: title: Pull Request type: object @@ -223492,7 +223899,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -223578,10 +223985,10 @@ x-webhooks: type: string before: type: string - enterprise: *797 - installation: *798 - number: *849 - organization: *799 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 pull_request: title: Pull Request type: object @@ -225857,7 +226264,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -225939,11 +226346,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *855 - enterprise: *797 - installation: *798 - number: *849 - organization: *799 + assignee: *856 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 pull_request: title: Pull Request type: object @@ -228231,7 +228638,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -228310,11 +228717,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *797 - installation: *798 - label: *818 - number: *849 - organization: *799 + enterprise: *798 + installation: *799 + label: *819 + number: *850 + organization: *800 pull_request: title: Pull Request type: object @@ -230592,7 +230999,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -230673,10 +231080,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *797 - installation: *798 - number: *849 - organization: *799 + enterprise: *798 + installation: *799 + number: *850 + organization: *800 pull_request: title: Pull Request type: object @@ -232946,7 +233353,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *800 + repository: *801 sender: *4 required: - action @@ -233146,7 +233553,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *797 + enterprise: *798 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -233238,8 +233645,8 @@ x-webhooks: - url - author - committer - installation: *798 - organization: *799 + installation: *799 + organization: *800 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -233825,9 +234232,9 @@ x-webhooks: type: string enum: - published - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 registry_package: type: object properties: @@ -234273,7 +234680,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *836 + items: *837 summary: type: string tag_name: @@ -234327,7 +234734,7 @@ x-webhooks: - owner - package_version - registry - repository: *800 + repository: *801 sender: *4 required: - action @@ -234405,9 +234812,9 @@ x-webhooks: type: string enum: - updated - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 registry_package: type: object properties: @@ -234715,7 +235122,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *836 + items: *837 summary: type: string tag_name: @@ -234764,7 +235171,7 @@ x-webhooks: - owner - package_version - registry - repository: *800 + repository: *801 sender: *4 required: - action @@ -234841,10 +235248,10 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - release: &856 + enterprise: *798 + installation: *799 + organization: *800 + release: &857 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -235162,7 +235569,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *800 + repository: *801 sender: *4 required: - action @@ -235239,11 +235646,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 - release: *856 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + release: *857 + repository: *801 sender: *4 required: - action @@ -235360,11 +235767,11 @@ x-webhooks: type: boolean required: - to - enterprise: *797 - installation: *798 - organization: *799 - release: *856 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + release: *857 + repository: *801 sender: *4 required: - action @@ -235442,9 +235849,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -235766,7 +236173,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *800 + repository: *801 sender: *4 required: - action @@ -235842,10 +236249,10 @@ x-webhooks: type: string enum: - published - enterprise: *797 - installation: *798 - organization: *799 - release: &857 + enterprise: *798 + installation: *799 + organization: *800 + release: &858 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -236164,7 +236571,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *800 + repository: *801 sender: *4 required: - action @@ -236240,11 +236647,11 @@ x-webhooks: type: string enum: - released - enterprise: *797 - installation: *798 - organization: *799 - release: *856 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + release: *857 + repository: *801 sender: *4 required: - action @@ -236320,11 +236727,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *797 - installation: *798 - organization: *799 - release: *857 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + release: *858 + repository: *801 sender: *4 required: - action @@ -236400,11 +236807,11 @@ x-webhooks: type: string enum: - published - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - repository_advisory: *716 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + repository_advisory: *717 sender: *4 required: - action @@ -236480,11 +236887,11 @@ x-webhooks: type: string enum: - reported - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - repository_advisory: *716 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + repository_advisory: *717 sender: *4 required: - action @@ -236560,10 +236967,10 @@ x-webhooks: type: string enum: - archived - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -236640,10 +237047,10 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -236721,10 +237128,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -236808,10 +237215,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -236923,10 +237330,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -236998,10 +237405,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 status: type: string @@ -237082,10 +237489,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -237162,10 +237569,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -237259,10 +237666,10 @@ x-webhooks: - name required: - repository - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -237342,10 +237749,10 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 repository_ruleset: *340 sender: *4 required: @@ -237424,10 +237831,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 repository_ruleset: *340 sender: *4 required: @@ -237506,10 +237913,10 @@ x-webhooks: type: string enum: - edited - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 repository_ruleset: *340 changes: type: object @@ -237571,16 +237978,16 @@ x-webhooks: properties: added: type: array - items: *652 + items: *653 deleted: type: array - items: *652 + items: *653 updated: type: array items: type: object properties: - rule: *652 + rule: *653 changes: type: object properties: @@ -237814,10 +238221,10 @@ x-webhooks: - from required: - owner - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -237895,10 +238302,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -237976,7 +238383,7 @@ x-webhooks: type: string enum: - create - alert: &858 + alert: &859 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -238098,10 +238505,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -238307,10 +238714,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -238388,11 +238795,11 @@ x-webhooks: type: string enum: - reopen - alert: *858 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *859 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -238591,10 +238998,10 @@ x-webhooks: enum: - fixed - open - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -238672,7 +239079,7 @@ x-webhooks: type: string enum: - assigned - alert: &860 + alert: &861 type: object properties: number: *189 @@ -238822,12 +239229,12 @@ x-webhooks: properties: *20 required: *21 nullable: true - metadata: *859 + metadata: *860 assignee: *4 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -238905,11 +239312,11 @@ x-webhooks: type: string enum: - created - alert: *860 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *861 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -238990,11 +239397,11 @@ x-webhooks: type: string enum: - created - alert: *860 - installation: *798 - location: *861 - organization: *799 - repository: *800 + alert: *861 + installation: *799 + location: *862 + organization: *800 + repository: *801 sender: *4 required: - location @@ -239232,11 +239639,11 @@ x-webhooks: type: string enum: - metadata_created - alert: *860 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *861 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -239313,11 +239720,11 @@ x-webhooks: type: string enum: - metadata_removed - alert: *860 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *861 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -239394,11 +239801,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *860 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *861 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -239476,11 +239883,11 @@ x-webhooks: type: string enum: - reopened - alert: *860 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *861 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -239558,11 +239965,11 @@ x-webhooks: type: string enum: - resolved - alert: *860 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *861 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -239640,12 +240047,12 @@ x-webhooks: type: string enum: - unassigned - alert: *860 + alert: *861 assignee: *4 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -239723,11 +240130,11 @@ x-webhooks: type: string enum: - validated - alert: *860 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + alert: *861 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -239853,10 +240260,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *800 - enterprise: *797 - installation: *798 - organization: *799 + repository: *801 + enterprise: *798 + installation: *799 + organization: *800 sender: *4 required: - action @@ -239934,11 +240341,11 @@ x-webhooks: type: string enum: - published - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - security_advisory: &862 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + security_advisory: &863 description: The details of the security advisory, including summary, description, and severity. type: object @@ -240109,11 +240516,11 @@ x-webhooks: type: string enum: - updated - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 - security_advisory: *862 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 + security_advisory: *863 sender: *4 required: - action @@ -240186,10 +240593,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -240362,9 +240769,9 @@ x-webhooks: type: object properties: security_and_analysis: *313 - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 repository: *360 sender: *4 required: @@ -240443,12 +240850,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - sponsorship: &863 + sponsorship: &864 type: object properties: created_at: @@ -240749,12 +241156,12 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - sponsorship: *863 + sponsorship: *864 required: - action - sponsorship @@ -240842,12 +241249,12 @@ x-webhooks: type: string required: - from - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - sponsorship: *863 + sponsorship: *864 required: - action - changes @@ -240924,17 +241331,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &864 + effective_date: &865 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: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - sponsorship: *863 + sponsorship: *864 required: - action - sponsorship @@ -241008,7 +241415,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &865 + changes: &866 type: object properties: tier: @@ -241052,13 +241459,13 @@ x-webhooks: - from required: - tier - effective_date: *864 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + effective_date: *865 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - sponsorship: *863 + sponsorship: *864 required: - action - changes @@ -241135,13 +241542,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *865 - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + changes: *866 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - sponsorship: *863 + sponsorship: *864 required: - action - changes @@ -241215,10 +241622,10 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -241301,10 +241708,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -241724,15 +242131,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *797 + enterprise: *798 id: description: The unique identifier of the status. type: integer - installation: *798 + installation: *799 name: type: string - organization: *799 - repository: *800 + organization: *800 + repository: *801 sender: *4 sha: description: The Commit SHA. @@ -241847,9 +242254,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *89 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -241938,9 +242345,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *89 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -242029,9 +242436,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *89 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -242120,9 +242527,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *89 - installation: *798 - organization: *799 - repository: *800 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -242198,12 +242605,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - team: &866 + team: &867 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -242426,9 +242833,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 repository: title: Repository description: A git repository @@ -242886,7 +243293,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *867 required: - action - team @@ -242962,9 +243369,9 @@ x-webhooks: type: string enum: - created - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 repository: title: Repository description: A git repository @@ -243422,7 +243829,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *867 required: - action - team @@ -243499,9 +243906,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 repository: title: Repository description: A git repository @@ -243959,7 +244366,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *867 required: - action - team @@ -244103,9 +244510,9 @@ x-webhooks: - from required: - permissions - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 repository: title: Repository description: A git repository @@ -244563,7 +244970,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *867 required: - action - changes @@ -244641,9 +245048,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *797 - installation: *798 - organization: *799 + enterprise: *798 + installation: *799 + organization: *800 repository: title: Repository description: A git repository @@ -245101,7 +245508,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *867 required: - action - team @@ -245177,10 +245584,10 @@ x-webhooks: type: string enum: - started - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 required: - action @@ -245253,16 +245660,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *797 + enterprise: *798 inputs: type: object nullable: true additionalProperties: true - installation: *798 - organization: *799 + installation: *799 + organization: *800 ref: type: string - repository: *800 + repository: *801 sender: *4 workflow: type: string @@ -245344,10 +245751,10 @@ x-webhooks: type: string enum: - completed - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 workflow_job: allOf: @@ -245663,10 +246070,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 workflow_job: allOf: @@ -246005,10 +246412,10 @@ x-webhooks: type: string enum: - queued - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 workflow_job: type: object @@ -246222,10 +246629,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 workflow_job: type: object @@ -246441,12 +246848,12 @@ x-webhooks: type: string enum: - completed - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - workflow: *814 + workflow: *815 workflow_run: title: Workflow Run type: object @@ -247445,12 +247852,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - workflow: *814 + workflow: *815 workflow_run: title: Workflow Run type: object @@ -248434,12 +248841,12 @@ x-webhooks: type: string enum: - requested - enterprise: *797 - installation: *798 - organization: *799 - repository: *800 + enterprise: *798 + installation: *799 + organization: *800 + repository: *801 sender: *4 - workflow: *814 + workflow: *815 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 d8f77feb89..81be79d78f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -62645,7 +62645,7 @@ "/meta": { "get": { "summary": "Get GitHub 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/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/articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names, and the public keys used by GitHub to sign commits made through the web UI.\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" ], @@ -62860,6 +62860,15 @@ ] } }, + "storage": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, "actions": { "type": "array", "items": { @@ -153999,6 +154008,255 @@ } } }, + "/orgs/{org}/interaction-limits/pulls/creation-cap": { + "patch": { + "summary": "Update pull request creation cap for an org", + "description": "Updates the pull request creation cap for an organization. The cap limits the total number\nof open pull requests a user can have across all public repositories in the organization\nat one time.\n\nOnly users with admin access to the organization can configure the cap.", + "tags": [ + "interactions" + ], + "operationId": "interactions/update-pull-request-creation-cap-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/orgs#update-pull-request-creation-cap-for-an-org" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pull request creation cap is enabled" + }, + "max_open_pull_requests": { + "type": "integer", + "description": "The maximum number of open pull requests a user can have at one time", + "minimum": 1, + "maximum": 1000 + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "enabled": true, + "max_open_pull_requests": 1 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pull request creation cap is enabled" + }, + "max_open_pull_requests": { + "type": "integer", + "description": "The maximum number of open pull requests a user can have at one time", + "minimum": 1, + "maximum": 1000 + } + }, + "required": [ + "enabled", + "max_open_pull_requests" + ] + }, + "examples": { + "default": { + "summary": "Response", + "value": { + "enabled": true, + "max_open_pull_requests": 1 + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "405": { + "description": "Method Not Allowed", + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/invitations": { "get": { "summary": "List pending organization invitations", @@ -238141,6 +238399,10 @@ "parent_team_id": { "type": "integer", "description": "The ID of a team to set as the parent team." + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided." } }, "required": [ @@ -239553,6 +239815,11 @@ "type": "integer", "description": "The ID of a team to set as the parent team.", "nullable": true + }, + "parent_team_slug": { + "type": "string", + "description": "The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided.", + "nullable": true } } }, @@ -241730,7 +241997,7 @@ "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", - "description": "Lists a team's repositories 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}/repos`.", + "description": "Lists a team's repositories visible to the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` or `repo` scope to use this endpoint.\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`.", "tags": [ "teams" ], @@ -441511,7 +441778,7 @@ "properties": { "suggestions": { "type": "object", - "description": "Pending suggestions for each suggestible field (`type`,\n`issue_field_values`, `labels`, `assignees`, `state`) the\nrequest touched. Omitted for fields not in the request or\nwith no pending suggestions. Items tagged `already_applied`\nare echoes of the current request's inputs whose target is\nalready applied to the issue; they are not persisted as\npending suggestions.\n", + "description": "Pending suggestions for each suggestible field (`type`,\n`issue_field_values`, `labels`, `assignees`, `state`) the\nrequest touched. Omitted for fields not in the request or\nwith no pending or ignored suggestions. Items tagged\n`ignored` are echoes of the current request's inputs that\nwere not persisted as pending suggestions.\n", "properties": { "type": { "type": "array", @@ -441535,8 +441802,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -441579,8 +441853,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -441607,8 +441888,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -441635,8 +441923,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -441669,8 +441964,15 @@ "high" ] }, - "already_applied": { + "ignored": { "type": "boolean" + }, + "ignored_reason": { + "type": "string", + "enum": [ + "already_applied", + "issue_already_closed" + ] } } } @@ -565990,200 +566292,1165 @@ "schema": { "type": "integer" } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "nullable": true, - "properties": { - "commit_title": { - "type": "string", - "description": "Title for the automatic commit message." - }, - "commit_message": { - "type": "string", - "description": "Extra detail to append to automatic commit message." - }, - "sha": { - "type": "string", - "description": "SHA that pull request head must match to allow merge." - }, - "merge_method": { - "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - } - }, - "examples": { - "response-if-merge-was-successful": { - "value": { - "commit_title": "Expand enum", - "commit_message": "Add a new value to the merge_method enum" - } - } - } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "commit_title": { + "type": "string", + "description": "Title for the automatic commit message." + }, + "commit_message": { + "type": "string", + "description": "Extra detail to append to automatic commit message." + }, + "sha": { + "type": "string", + "description": "SHA that pull request head must match to allow merge." + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + } + }, + "examples": { + "response-if-merge-was-successful": { + "value": { + "commit_title": "Expand enum", + "commit_message": "Add a new value to the merge_method enum" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "if merge was successful", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Result", + "description": "Pull Request Merge Result", + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "merged": { + "type": "boolean" + }, + "message": { + "type": "string" + } + }, + "required": [ + "merged", + "message", + "sha" + ] + }, + "examples": { + "response-if-merge-was-successful": { + "value": { + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "merged": true, + "message": "Pull Request successfully merged" + } + } + } + } + } + }, + "405": { + "description": "Method Not Allowed if merge cannot be performed", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-merge-cannot-be-performed": { + "value": { + "message": "Pull Request is not mergeable" + } + } + } + } + } + }, + "409": { + "description": "Conflict if sha was provided and pull request head did not match", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-sha-was-provided-and-pull-request-head-did-not-match": { + "value": { + "message": "Head branch was modified. Review and try the merge again." + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "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": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async": { + "put": { + "summary": "Merge a pull request asynchronously", + "description": "Merges a pull request into the base branch in the background. Merging in this way allows certain types of errors to be retried, and avoids the risk of timeouts for particularly complex merges.\n\nThis is the required method for merging stacked PRs, but also supports unstacked PRs. When using this endpoint to merge a stacked pull request, all pull requests in the stack up to and including the requested PR will be merged into the base branch.\n\nThe response includes a UUID that can be used to fetch the result of the merge. If another asynchronous merge request has already been made for this pull request, the UUID of that request will be returned instead with a 409 response status to indicate that the merge options may be different from those that were requested. If there isn't an existing asynchronous merge request, a 202 response status is used.\n\nIf the pull request is already merged, the merge commit OID will be returned immediately with a 200 status.\n\nIf the pull request cannot be merged (e.g. because it is closed, or still a draft) this result will be returned immediately with a 400 response status. Branch protection rules and repository rules are not run at this stage, only basic pull request state checks are performed.", + "tags": [ + "pulls" + ], + "operationId": "pulls/merge-async", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously" + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "commit_title": { + "type": "string", + "description": "Title for the automatic commit message." + }, + "commit_message": { + "type": "string", + "description": "Extra detail to append to automatic commit message." + }, + "sha": { + "type": "string", + "description": "SHA that pull request head must match to allow merge. If not provided, the current head of the PR at the time of the request will be used; if the PR is pushed in between the merge being requested and being executed, the merge will be cancelled." + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "description": "The action that will be taken to merge the pull request. `direct_merge` merges the pull request directly without using a merge queue; `merge_queue` adds the pull request to a merge queue; `default` selects the most appropriate option.", + "enum": [ + "default", + "direct_merge", + "merge_queue" + ] + } + } + }, + "examples": { + "default": { + "value": { + "commit_title": "Fix race condition", + "commit_message": "Avoids a race by trying to read the file and handling the exception if it does not exist.", + "sha": "6358cd125586d9def8c3e5943f23506202da81cc", + "merge_method": "squash", + "merge_action": "default" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "if the merge request was accepted and will run in the background", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", + "type": "object", + "additionalProperties": false, + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] + }, + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] + } + }, + "required": [ + "status", + "details" + ] + }, + "examples": { + "response-if-merge-request-was-accepted": { + "summary": "Request accepted", + "value": { + "status": "pending", + "details": { + "message": "Merge request enqueued.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "merge", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + } + } + } + } + }, + "200": { + "description": "if the pull request was already merged, or is already in a merge queue", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", + "type": "object", + "additionalProperties": false, + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] + }, + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] + } + }, + "required": [ + "status", + "details" + ] + }, + "examples": { + "response-if-pull-request-was-already-merged": { + "summary": "Already merged", + "value": { + "status": "merged", + "details": { + "message": "Pull request is already merged.", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + }, + "response-if-pull-request-is-already-enqueued": { + "summary": "Already enqueued", + "value": { + "status": "enqueued", + "details": { + "message": "Pull request is already in the merge queue." + } + } + } + } + } + } + }, + "409": { + "description": "if there is an existing merge request already enqueued for this pull request", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", + "type": "object", + "additionalProperties": false, + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] + }, + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] + } + }, + "required": [ + "status", + "details" + ] + }, + "examples": { + "response-if-a-merge-request-already-exists": { + "value": { + "status": "pending", + "details": { + "message": "A merge request already exists for this pull request.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "squash", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + } + } + } + } + }, + "400": { + "description": "if the pull request is not ready to be merged, e.g. because it is closed", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", + "type": "object", + "additionalProperties": false, + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] + }, + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] + } + }, + "required": [ + "status", + "details" + ] + }, + "examples": { + "response-if-pull-request-is-not-ready-to-be-merged": { + "value": { + "status": "failed", + "details": { + "message": "Pull request is closed." + } + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "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" + } + } + } + } + } + } + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}": { + "get": { + "summary": "Get the result of an asynchronous merge", + "description": "Fetches the current result of an asynchronous merge request, identified by the UUID that was returned when the merge was requested.\n\nWhile the merge is still queued, the response includes the UUID, merge method, and expected head SHA of the request. Once the merge has completed, the response reports whether it was merged, including the merge commit OID on success or a message describing why it could not be merged on failure.\n\nThe result of an asynchronous merge request is retained for 24 hours after its most recent update. After this window the request expires and this endpoint returns a `404` response for its UUID.", + "tags": [ + "pulls" + ], + "operationId": "pulls/get-merge-async-result", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#get-the-result-of-an-asynchronous-merge" + }, + "x-github": { + "triggersNotification": false, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "uuid", + "description": "The UUID of the asynchronous merge request, as returned when the merge was requested.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { - "description": "if merge was successful", + "description": "the current result of the asynchronous merge request", "content": { "application/json": { "schema": { - "title": "Pull Request Merge Result", - "description": "Pull Request Merge Result", + "title": "Pull Request Merge Async Result", + "description": "Pull Request Merge Async Result", "type": "object", + "additionalProperties": false, "properties": { - "sha": { - "type": "string" - }, - "merged": { - "type": "boolean" + "status": { + "type": "string", + "enum": [ + "pending", + "merged", + "enqueued", + "failed" + ] }, - "message": { - "type": "string" + "details": { + "oneOf": [ + { + "description": "When an asynchronous merge request was created or already existed", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "merge_method": { + "type": "string", + "enum": [ + "default", + "merge", + "squash", + "rebase" + ] + }, + "merge_action": { + "type": "string", + "enum": [ + "default", + "merge_queue", + "direct_merge" + ] + }, + "expected_head_sha": { + "type": "string", + "description": "SHA that the pull request head must match for the enqueued merge to proceed." + } + }, + "required": [ + "message", + "uuid", + "merge_method", + "merge_action", + "expected_head_sha" + ] + }, + { + "description": "When the pull request cannot be merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + { + "description": "When the pull request is already merged", + "type": "object", + "additionalProperties": false, + "properties": { + "message": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "message", + "sha" + ] + } + ] } }, "required": [ - "merged", - "message", - "sha" + "status", + "details" ] }, "examples": { - "response-if-merge-was-successful": { + "response-if-the-merge-is-still-queued": { + "summary": "Still queued", "value": { - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "merged": true, - "message": "Pull Request successfully merged" - } - } - } - } - } - }, - "405": { - "description": "Method Not Allowed if merge cannot be performed", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "status": "pending", + "details": { + "message": "Merge request is in progress.", + "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42", + "merge_method": "merge", + "merge_action": "default", + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } } - } - }, - "examples": { - "response-if-merge-cannot-be-performed": { + }, + "response-if-the-pull-request-is-enqueued": { + "summary": "Enqueued in the merge queue", "value": { - "message": "Pull Request is not mergeable" - } - } - } - } - } - }, - "409": { - "description": "Conflict if sha was provided and pull request head did not match", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "status": "enqueued", + "details": { + "message": "Pull request is in the merge queue." + } } - } - }, - "examples": { - "response-if-sha-was-provided-and-pull-request-head-did-not-match": { + }, + "response-if-the-merge-succeeded": { + "summary": "Merge succeeded", "value": { - "message": "Head branch was modified. Review and try the merge again." + "status": "merged", + "details": { + "message": "Pull request was merged.", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description{"code":"deadline_exceeded","msg":"operation timed out"}