From c3f173096096706bb049e4e705626745641787ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=98=99=E2=97=A6=20The=20Tablet=20=E2=9D=80=20GamerGirla?= =?UTF-8?q?ndCo=20=E2=97=A6=E2=9D=A7?= Date: Mon, 4 May 2026 17:36:15 -0400 Subject: [PATCH] update swagger definitions --- templates/swagger/v1_groups.json | 685 ++++++++++++++++++++++++++++--- 1 file changed, 633 insertions(+), 52 deletions(-) diff --git a/templates/swagger/v1_groups.json b/templates/swagger/v1_groups.json index d9d9806585..88933d9516 100644 --- a/templates/swagger/v1_groups.json +++ b/templates/swagger/v1_groups.json @@ -556,6 +556,12 @@ "in": "path", "required": true }, + { + "type": "boolean", + "description": "filter by disabled status (true or false)", + "name": "disabled", + "in": "query" + }, { "description": "group ID of the repo", "name": "group_id", @@ -567,7 +573,7 @@ ], "responses": { "200": { - "$ref": "#/definitions/ActionRunnersResponse" + "$ref": "#/responses/RunnerList" }, "400": { "$ref": "#/responses/error" @@ -579,45 +585,6 @@ } }, "/repos/{owner}/group/{group_id}/{repo}/actions/runners/registration-token": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a repository's actions runner registration token", - "operationId": "repoGetRunnerRegistrationToken", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/RegistrationToken" - } - } - }, "post": { "produces": [ "application/json" @@ -666,7 +633,7 @@ "tags": [ "repository" ], - "summary": "Get an repo-level runner", + "summary": "Get a repo-level runner", "operationId": "getRepoRunner", "parameters": [ { @@ -701,7 +668,7 @@ ], "responses": { "200": { - "$ref": "#/definitions/ActionRunner" + "$ref": "#/responses/Runner" }, "400": { "$ref": "#/responses/error" @@ -718,7 +685,7 @@ "tags": [ "repository" ], - "summary": "Delete an repo-level runner", + "summary": "Delete a repo-level runner", "operationId": "deleteRepoRunner", "parameters": [ { @@ -762,6 +729,71 @@ "$ref": "#/responses/notFound" } } + }, + "patch": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Update a repo-level runner", + "operationId": "updateRepoRunner", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "id of the runner", + "name": "runner_id", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/EditActionRunnerOption" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/Runner" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + } + } } }, "/repos/{owner}/group/{group_id}/{repo}/actions/runs": { @@ -879,7 +911,7 @@ "required": true }, { - "type": "string", + "type": "integer", "description": "id of the run", "name": "run", "in": "path", @@ -1019,6 +1051,146 @@ } } }, + "/repos/{owner}/group/{group_id}/{repo}/actions/runs/{run}/attempts/{attempt}": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Gets a specific workflow run attempt", + "operationId": "getWorkflowRunAttempt", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of the repository", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "integer", + "description": "id of the run", + "name": "run", + "in": "path", + "required": true + }, + { + "type": "integer", + "description": "logical attempt number of the run", + "name": "attempt", + "in": "path", + "required": true + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/WorkflowRun" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/runs/{run}/attempts/{attempt}/jobs": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Lists all jobs for a workflow run attempt", + "operationId": "listWorkflowRunAttemptJobs", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of the repository", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "integer", + "description": "id of the workflow run", + "name": "run", + "in": "path", + "required": true + }, + { + "type": "integer", + "description": "logical attempt number of the run", + "name": "attempt", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "workflow status (pending, queued, in_progress, failure, success, skipped)", + "name": "status", + "in": "query" + }, + { + "type": "integer", + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query" + }, + { + "type": "integer", + "description": "page size of results", + "name": "limit", + "in": "query" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/WorkflowJobsList" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, "/repos/{owner}/group/{group_id}/{repo}/actions/runs/{run}/jobs": { "get": { "produces": [ @@ -1091,6 +1263,199 @@ } } }, + "/repos/{owner}/group/{group_id}/{repo}/actions/runs/{run}/jobs/{job_id}/rerun": { + "post": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Reruns a specific workflow job in a run", + "operationId": "rerunWorkflowJob", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of the repository", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "integer", + "description": "id of the run", + "name": "run", + "in": "path", + "required": true + }, + { + "type": "integer", + "description": "id of the job", + "name": "job_id", + "in": "path", + "required": true + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "201": { + "$ref": "#/responses/WorkflowJob" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "409": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/runs/{run}/rerun": { + "post": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Reruns an entire workflow run", + "operationId": "rerunWorkflowRun", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of the repository", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "integer", + "description": "id of the run", + "name": "run", + "in": "path", + "required": true + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "201": { + "$ref": "#/responses/WorkflowRun" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "409": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/runs/{run}/rerun-failed-jobs": { + "post": { + "tags": [ + "repository" + ], + "summary": "Reruns all failed jobs in a workflow run", + "operationId": "rerunFailedWorkflowRun", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of the repository", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "integer", + "description": "id of the run", + "name": "run", + "in": "path", + "required": true + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "201": { + "$ref": "#/responses/empty" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "409": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" + } + } + } + }, "/repos/{owner}/group/{group_id}/{repo}/actions/secrets": { "get": { "produces": [ @@ -1850,6 +2215,12 @@ "$ref": "#/definitions/CreateActionWorkflowDispatch" } }, + { + "type": "boolean", + "description": "Whether the response should include the workflow run ID and URLs.", + "name": "return_run_details", + "in": "query" + }, { "description": "group ID of the repo", "name": "group_id", @@ -1860,8 +2231,11 @@ } ], "responses": { + "200": { + "$ref": "#/responses/RunDetails" + }, "204": { - "description": "No Content" + "description": "No Content, if return_run_details is missing or false" }, "400": { "$ref": "#/responses/error" @@ -2036,6 +2410,16 @@ "in": "path", "required": true }, + { + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "description": "subpath of the repository to download", + "name": "path", + "in": "query" + }, { "description": "group ID of the repo", "name": "group_id", @@ -4140,7 +4524,7 @@ } }, "post": { - "description": "Uses automatic pagination based on default page size and max response size and returns the maximum allowed number of files. Files which could not be retrieved are null. Files which are too large are being returned with `encoding == null`, `content == null` and `size > 0`, they can be requested separately by using the `download_url`.", + "description": "Uses automatic pagination based on default page size and max response size and returns the maximum allowed number of files. Files which could not be retrieved are null. Files which are too large are being returned with `encoding == null`, `content == null` and `size \u003e 0`, they can be requested separately by using the `download_url`.", "produces": [ "application/json" ], @@ -6387,7 +6771,7 @@ } ], "responses": { - "200": { + "204": { "$ref": "#/responses/empty" }, "403": { @@ -6545,6 +6929,7 @@ } }, "patch": { + "description": "Pass `content_version` to enable optimistic locking on body edits.\nIf the version doesn't match the current value, the request fails with 409 Conflict.\n", "consumes": [ "application/json" ], @@ -8390,7 +8775,7 @@ } ], "responses": { - "200": { + "204": { "$ref": "#/responses/empty" }, "403": { @@ -10304,7 +10689,7 @@ "type": "string" }, "collectionFormat": "multi", - "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned", + "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned", "name": "status-types", "in": "query" }, @@ -10620,6 +11005,122 @@ } } }, + "/repos/{owner}/group/{group_id}/{repo}/pulls/comments/{id}/resolve": { + "post": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Resolve a pull request review comment", + "operationId": "repoResolvePullReviewComment", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "description": "id of the review comment", + "name": "id", + "in": "path", + "required": true + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "400": { + "$ref": "#/responses/validationError" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/pulls/comments/{id}/unresolve": { + "post": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Unresolve a pull request review comment", + "operationId": "repoUnresolvePullReviewComment", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "description": "id of the review comment", + "name": "id", + "in": "path", + "required": true + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "400": { + "$ref": "#/responses/validationError" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, "/repos/{owner}/group/{group_id}/{repo}/pulls/pinned": { "get": { "produces": [ @@ -10915,6 +11416,83 @@ } } }, + "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/comments/{id}/replies": { + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Reply to a pull request review comment", + "operationId": "repoCreatePullReviewCommentReply", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "description": "index of the pull request", + "name": "index", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "description": "id of the review comment to reply to", + "name": "id", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreatePullReviewCommentReplyOptions" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "201": { + "$ref": "#/responses/PullReviewComment" + }, + "400": { + "$ref": "#/responses/validationError" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + } + } + } + }, "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/commits": { "get": { "produces": [ @@ -11176,6 +11754,9 @@ "200": { "$ref": "#/responses/empty" }, + "403": { + "$ref": "#/responses/forbidden" + }, "404": { "$ref": "#/responses/notFound" }, @@ -11444,7 +12025,7 @@ "tags": [ "repository" ], - "summary": "Create a review to an pull request", + "summary": "Create a review to a pull request", "operationId": "repoCreatePullReview", "parameters": [ { @@ -11565,7 +12146,7 @@ "tags": [ "repository" ], - "summary": "Submit a pending review to an pull request", + "summary": "Submit a pending review to a pull request", "operationId": "repoSubmitPullReview", "parameters": [ { @@ -12326,7 +12907,7 @@ }, { "type": "boolean", - "description": "filter (exclude / include) drafts, if you dont have repo write access none will show", + "description": "filter (exclude / include) drafts, if you don't have repo write access none will show", "name": "draft", "in": "query" },