From 46cd9b737990c75ea7648d89c15fc0ae245ff11e 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, 24 Nov 2025 00:35:19 -0500 Subject: [PATCH] update swagger definitions --- templates/swagger/v1_groups.json | 25222 ++++++++++++++--------------- templates/swagger/v1_json.tmpl | 5 + 2 files changed, 12616 insertions(+), 12611 deletions(-) diff --git a/templates/swagger/v1_groups.json b/templates/swagger/v1_groups.json index 0a73b3e46f..667fbf96da 100644 --- a/templates/swagger/v1_groups.json +++ b/templates/swagger/v1_groups.json @@ -1,15 +1,14 @@ { "paths": { - "/repos/{owner}/group/{group_id}/{repo}/collaborators": { - "get": { - "operationId": "repoListCollaborators", + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/stopwatch/stop": { + "post": { "parameters": [ { + "required": true, "type": "string", "description": "owner of the repo", "name": "owner", - "in": "path", - "required": true + "in": "path" }, { "type": "string", @@ -18,47 +17,57 @@ "in": "path", "required": true }, - { - "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" - }, { "required": true, - "in": "path", - "description": "group ID of the repo", + "type": "integer", + "format": "int64", + "description": "index of the issue to stop the stopwatch on", + "name": "index", + "in": "path" + }, + { "name": "group_id", "type": "integer", - "format": "int64" + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" } ], "responses": { - "200": { - "$ref": "#/responses/UserList" + "201": { + "$ref": "#/responses/empty" + }, + "403": { + "description": "Not repo writer, user does not have rights to toggle stopwatch" }, "404": { "$ref": "#/responses/notFound" + }, + "409": { + "description": "Cannot stop a non-existent stopwatch" } }, + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], "tags": [ - "repository" + "issue" ], - "summary": "List a repository's collaborators" + "summary": "Stop an issue's existing stopwatch.", + "operationId": "issueStopStopWatch" } }, - "/repos/{owner}/group/{group_id}/{repo}/actions/runs": { + "/repos/{owner}/group/{group_id}/{repo}/commits": { "get": { - "operationId": "getWorkflowRuns", + "tags": [ + "repository" + ], + "summary": "Get a list of all commits from a repository", + "operationId": "repoGetAllCommits", "parameters": [ { "type": "string", @@ -68,53 +77,73 @@ "required": true }, { + "required": true, "type": "string", - "description": "name of the repository", + "description": "name of the repo", "name": "repo", - "in": "path", - "required": true + "in": "path" }, { "type": "string", - "description": "workflow event name", - "name": "event", + "description": "SHA or branch to start listing commits from (usually 'master')", + "name": "sha", "in": "query" }, { - "description": "workflow branch", - "name": "branch", + "type": "string", + "description": "filepath of a file/dir", + "name": "path", + "in": "query" + }, + { + "format": "date-time", + "description": "Only commits after this date will be returned (ISO 8601 format)", + "name": "since", "in": "query", "type": "string" }, { "type": "string", - "description": "workflow status (pending, queued, in_progress, failure, success, skipped)", - "name": "status", + "format": "date-time", + "description": "Only commits before this date will be returned (ISO 8601 format)", + "name": "until", "in": "query" }, { - "type": "string", - "description": "triggered by user", - "name": "actor", - "in": "query" - }, - { - "type": "string", - "description": "triggering sha of the workflow run", - "name": "head_sha", - "in": "query" - }, - { - "type": "integer", - "description": "page number of results to return (1-based)", - "name": "page", - "in": "query" - }, - { - "description": "page size of results", - "name": "limit", "in": "query", - "type": "integer" + "type": "boolean", + "description": "include diff stats for every commit (disable for speedup, default 'true')", + "name": "stat" + }, + { + "type": "boolean", + "description": "include verification for every commit (disable for speedup, default 'true')", + "name": "verification", + "in": "query" + }, + { + "type": "boolean", + "description": "include a list of affected files for every commit (disable for speedup, default 'true')", + "name": "files", + "in": "query" + }, + { + "name": "page", + "in": "query", + "type": "integer", + "description": "page number of results to return (1-based)" + }, + { + "type": "integer", + "description": "page size of results (ignored if used with 'path')", + "name": "limit", + "in": "query" + }, + { + "type": "string", + "description": "commits that match the given specifier will not be listed.", + "name": "not", + "in": "query" }, { "in": "path", @@ -127,169 +156,28 @@ ], "responses": { "200": { - "$ref": "#/responses/WorkflowRunsList" - }, - "400": { - "$ref": "#/responses/error" + "$ref": "#/responses/CommitList" }, "404": { "$ref": "#/responses/notFound" + }, + "409": { + "$ref": "#/responses/EmptyRepository" } }, "produces": [ "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Lists all runs for a repository run" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/avatar": { - "post": { - "summary": "Update avatar", - "operationId": "repoUpdateAvatar", - "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 - }, - { - "schema": { - "$ref": "#/definitions/UpdateRepoAvatarOption" - }, - "name": "body", - "in": "body" - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ] - }, - "delete": { - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Delete avatar", - "operationId": "repoDeleteAvatar", - "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 - }, - { - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true - } ] } }, - "/repos/{owner}/group/{group_id}/{repo}/git/commits/{sha}.{diffType}": { + "/repos/{owner}/group/{group_id}/{repo}/signing-key.gpg": { "get": { - "summary": "Get a commit's diff or patch", - "operationId": "repoDownloadCommitDiffOrPatch", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "name": "sha", - "in": "path", - "required": true, - "type": "string", - "description": "SHA of the commit to get" - }, - { - "enum": [ - "diff", - "patch" - ], - "type": "string", - "description": "whether the output is diff or patch", - "name": "diffType", - "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/string" - }, - "404": { - "$ref": "#/responses/notFound" + "description": "GPG armored public key", + "schema": { + "type": "string" + } } }, "produces": [ @@ -297,11 +185,145 @@ ], "tags": [ "repository" + ], + "summary": "Get signing-key.gpg for given repository", + "operationId": "repoSigningKey", + "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 + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } ] } }, "/repos/{owner}/group/{group_id}/{repo}/labels/{id}": { + "get": { + "tags": [ + "issue" + ], + "summary": "Get a single label", + "operationId": "issueGetLabel", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "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 label to get", + "name": "id" + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "200": { + "$ref": "#/responses/Label" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ] + }, + "delete": { + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "description": "id of the label to delete", + "name": "id", + "in": "path", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "tags": [ + "issue" + ], + "summary": "Delete a label", + "operationId": "issueDeleteLabel" + }, "patch": { + "responses": { + "422": { + "$ref": "#/responses/validationError" + }, + "200": { + "$ref": "#/responses/Label" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, "consumes": [ "application/json" ], @@ -315,26 +337,26 @@ "operationId": "issueEditLabel", "parameters": [ { - "name": "owner", "in": "path", "required": true, "type": "string", - "description": "owner of the repo" + "description": "owner of the repo", + "name": "owner" }, { + "type": "string", + "description": "name of the repo", "name": "repo", "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" + "required": true }, { - "in": "path", - "required": true, "type": "integer", "format": "int64", "description": "id of the label to edit", - "name": "id" + "name": "id", + "in": "path", + "required": true }, { "name": "body", @@ -351,153 +373,69 @@ "type": "integer", "format": "int64" } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - }, - "200": { - "$ref": "#/responses/Label" - } - } - }, - "get": { - "operationId": "issueGetLabel", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "type": "integer", - "format": "int64", - "description": "id of the label to get", - "name": "id", - "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/Label" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/diffpatch": { + "post": { "produces": [ "application/json" ], "tags": [ - "issue" + "repository" ], - "summary": "Get a single label" - }, - "delete": { - "operationId": "issueDeleteLabel", + "summary": "Apply diff patch to repository", + "operationId": "repoApplyDiffPatch", "parameters": [ { - "type": "string", - "description": "owner of the repo", "name": "owner", "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", "required": true }, { - "description": "name of the repo", - "name": "repo", - "in": "path", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/ApplyDiffPatchFileOptions" + }, + "name": "body", + "in": "body" }, { - "name": "id", - "in": "path", "required": true, - "type": "integer", - "format": "int64", - "description": "id of the label to delete" - }, - { + "in": "path", + "description": "group ID of the repo", "name": "group_id", "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" + "format": "int64" } ], "responses": { - "204": { - "$ref": "#/responses/empty" + "200": { + "$ref": "#/responses/FileResponse" }, "404": { "$ref": "#/responses/notFound" + }, + "423": { + "$ref": "#/responses/repoArchivedError" } }, - "tags": [ - "issue" - ], - "summary": "Delete a label" + "consumes": [ + "application/json" + ] } }, "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/stopwatch/delete": { "delete": { - "summary": "Delete an issue's existing stopwatch.", - "operationId": "issueDeleteStopWatch", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "type": "integer", - "format": "int64", - "description": "index of the issue to stop the stopwatch on", - "name": "index", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], "responses": { "404": { "$ref": "#/responses/notFound" @@ -520,19 +458,9 @@ ], "tags": [ "issue" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues": { - "get": { - "produces": [ - "application/json" ], - "tags": [ - "issue" - ], - "summary": "List a repository's issues", - "operationId": "issueListIssues", + "summary": "Delete an issue's existing stopwatch.", + "operationId": "issueDeleteStopWatch", "parameters": [ { "type": "string", @@ -542,140 +470,19 @@ "required": true }, { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "description": "whether issue is open or closed", - "name": "state", - "in": "query", - "enum": [ - "closed", - "open", - "all" - ], - "type": "string" - }, - { - "in": "query", - "type": "string", - "description": "comma separated list of label names. Fetch only issues that have any of this label names. Non existent labels are discarded.", - "name": "labels" - }, - { - "in": "query", - "type": "string", - "description": "search string", - "name": "q" - }, - { - "enum": [ - "issues", - "pulls" - ], - "type": "string", - "description": "filter by type (issues / pulls) if set", - "name": "type", - "in": "query" - }, - { - "type": "string", - "description": "comma separated list of milestone names or ids. It uses names and fall back to ids. Fetch only issues that have any of this milestones. Non existent milestones are discarded", - "name": "milestones", - "in": "query" - }, - { - "in": "query", - "type": "string", - "format": "date-time", - "description": "Only show items updated after the given time. This is a timestamp in RFC 3339 format", - "name": "since" - }, - { - "format": "date-time", - "description": "Only show items updated before the given time. This is a timestamp in RFC 3339 format", - "name": "before", - "in": "query", - "type": "string" - }, - { - "in": "query", - "type": "string", - "description": "Only show items which were created by the given user", - "name": "created_by" - }, - { - "type": "string", - "description": "Only show items for which the given user is assigned", - "name": "assigned_by", - "in": "query" - }, - { - "type": "string", - "description": "Only show items in which the given user was mentioned", - "name": "mentioned_by", - "in": "query" - }, - { - "name": "page", - "in": "query", - "type": "integer", - "description": "page number of results to return (1-based)" - }, - { - "description": "page size of results", - "name": "limit", - "in": "query", - "type": "integer" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/IssueList" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "post": { - "tags": [ - "issue" - ], - "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.", - "operationId": "issueCreateIssue", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "in": "path", - "required": true, "type": "string", "description": "name of the repo", - "name": "repo" + "name": "repo", + "in": "path", + "required": true }, { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/CreateIssueOption" - } + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the issue to stop the stopwatch on", + "name": "index", + "in": "path" }, { "required": true, @@ -685,149 +492,26 @@ "type": "integer", "format": "int64" } - ], - "responses": { - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "412": { - "$ref": "#/responses/error" - }, - "422": { - "$ref": "#/responses/validationError" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - }, - "201": { - "$ref": "#/responses/Issue" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" ] } }, - "/repos/{owner}/group/{group_id}/{repo}/commits/{ref}/statuses": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a commit's statuses, by branch/tag/commit reference", - "operationId": "repoListStatusesByRef", + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/times/{id}": { + "delete": { "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" + "required": true }, { "required": true, "type": "string", - "description": "name of branch/tag/commit", - "name": "ref", + "description": "name of the repo", + "name": "repo", "in": "path" }, - { - "name": "sort", - "in": "query", - "enum": [ - "oldest", - "recentupdate", - "leastupdate", - "leastindex", - "highestindex" - ], - "type": "string", - "description": "type of sort" - }, - { - "enum": [ - "pending", - "success", - "error", - "failure", - "warning" - ], - "type": "string", - "description": "type of state", - "name": "state", - "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" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "$ref": "#/responses/CommitStatusList" - }, - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/assets/{attachment_id}": { - "get": { - "tags": [ - "issue" - ], - "summary": "Get an issue attachment", - "operationId": "issueGetIssueAttachment", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, { "type": "integer", "format": "int64", @@ -837,12 +521,82 @@ "required": true }, { + "required": true, + "type": "integer", "format": "int64", - "description": "id of the attachment to get", - "name": "attachment_id", + "description": "id of time to delete", + "name": "id", + "in": "path" + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "204": { + "$ref": "#/responses/empty" + }, + "400": { + "$ref": "#/responses/error" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Delete specific tracked time", + "operationId": "issueDeleteTime" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/forks": { + "get": { + "tags": [ + "repository" + ], + "summary": "List a repository's forks", + "operationId": "listForks", + "parameters": [ + { "in": "path", "required": true, - "type": "integer" + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "integer", + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query" + }, + { + "name": "limit", + "in": "query", + "type": "integer", + "description": "page size of results" }, { "type": "integer", @@ -855,125 +609,42 @@ ], "responses": { "200": { - "$ref": "#/responses/Attachment" + "$ref": "#/responses/RepositoryList" }, "404": { - "$ref": "#/responses/error" + "$ref": "#/responses/notFound" } }, "produces": [ "application/json" ] }, - "delete": { - "produces": [ - "application/json" - ], + "post": { "tags": [ - "issue" + "repository" ], - "summary": "Delete an issue attachment", - "operationId": "issueDeleteIssueAttachment", + "summary": "Fork a repository", + "operationId": "createFork", "parameters": [ { - "description": "owner of the repo", + "description": "owner of the repo to fork", "name": "owner", "in": "path", "required": true, "type": "string" }, { - "description": "name of the repo", - "name": "repo", "in": "path", "required": true, - "type": "string" - }, - { - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the issue", - "name": "index" - }, - { - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "id of the attachment to delete", - "name": "attachment_id" - }, - { - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true - } - ], - "responses": { - "423": { - "$ref": "#/responses/repoArchivedError" - }, - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/error" - } - } - }, - "patch": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Edit an issue attachment", - "operationId": "issueEditIssueAttachment", - "parameters": [ - { - "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" - }, - { - "type": "integer", - "format": "int64", - "description": "index of the issue", - "name": "index", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "description": "id of the attachment to edit", - "name": "attachment_id", - "in": "path", - "required": true + "type": "string", + "description": "name of the repo to fork", + "name": "repo" }, { "name": "body", "in": "body", "schema": { - "$ref": "#/definitions/EditAttachmentOptions" + "$ref": "#/definitions/CreateForkOption" } }, { @@ -986,28 +657,30 @@ } ], "responses": { - "423": { - "$ref": "#/responses/repoArchivedError" - }, - "201": { - "$ref": "#/responses/Attachment" - }, "404": { - "$ref": "#/responses/error" + "$ref": "#/responses/notFound" + }, + "409": { + "description": "The repository with the same name already exists." }, "422": { "$ref": "#/responses/validationError" + }, + "202": { + "$ref": "#/responses/Repository" + }, + "403": { + "$ref": "#/responses/forbidden" } - } + }, + "produces": [ + "application/json" + ] } }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/timeline": { + "/repos/{owner}/group/{group_id}/{repo}/actions/jobs": { "get": { - "tags": [ - "issue" - ], - "summary": "List all comments and events on an issue", - "operationId": "issueGetCommentsAndTimeline", + "operationId": "listWorkflowJobs", "parameters": [ { "type": "string", @@ -1017,45 +690,155 @@ "required": true }, { - "type": "string", - "description": "name of the repo", - "name": "repo", "in": "path", - "required": true + "required": true, + "type": "string", + "description": "name of the repository", + "name": "repo" + }, + { + "type": "string", + "description": "workflow status (pending, queued, in_progress, failure, success, skipped)", + "name": "status", + "in": "query" + }, + { + "name": "page", + "in": "query", + "type": "integer", + "description": "page number of results to return (1-based)" + }, + { + "description": "page size of results", + "name": "limit", + "in": "query", + "type": "integer" }, { "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", "type": "integer", - "format": "int64", - "description": "index of the issue", - "name": "index", + "format": "int64" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/WorkflowJobsList" + }, + "400": { + "$ref": "#/responses/error" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Lists all jobs for a repository" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/pulls": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "List a repo's pull requests", + "operationId": "repoListPullRequests", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", "in": "path" }, + { + "description": "Name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, { "type": "string", - "format": "date-time", - "description": "if provided, only comments updated since the specified time are returned.", - "name": "since", + "description": "Filter by target base branch of the pull request", + "name": "base_branch", + "in": "query" + }, + { + "type": "string", + "default": "open", + "description": "State of pull request", + "name": "state", + "in": "query", + "enum": [ + "open", + "closed", + "all" + ] + }, + { + "enum": [ + "oldest", + "recentupdate", + "recentclose", + "leastupdate", + "mostcomment", + "leastcomment", + "priority" + ], + "type": "string", + "description": "Type of sort", + "name": "sort", "in": "query" }, { "type": "integer", - "description": "page number of results to return (1-based)", + "format": "int64", + "description": "ID of the milestone", + "name": "milestone", + "in": "query" + }, + { + "description": "Label IDs", + "name": "labels", + "in": "query", + "type": "array", + "items": { + "type": "integer", + "format": "int64" + }, + "collectionFormat": "multi" + }, + { + "type": "string", + "description": "Filter by pull request author", + "name": "poster", + "in": "query" + }, + { + "description": "Page number of results to return (1-based)", "name": "page", - "in": "query" + "in": "query", + "minimum": 1, + "type": "integer", + "default": 1 }, { "type": "integer", - "description": "page size of results", + "description": "Page size of results", "name": "limit", - "in": "query" - }, - { - "type": "string", - "format": "date-time", - "description": "if provided, only comments updated before the provided time are returned.", - "name": "before", - "in": "query" + "in": "query", + "minimum": 0 }, { "format": "int64", @@ -1067,191 +850,26 @@ } ], "responses": { - "200": { - "$ref": "#/responses/TimelineList" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/stopwatch/start": { - "post": { - "operationId": "issueStartStopWatch", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "type": "integer", - "format": "int64", - "description": "index of the issue to create the stopwatch on", - "name": "index", - "in": "path", - "required": true - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "201": { - "$ref": "#/responses/empty" - }, - "403": { - "description": "Not repo writer, user does not have rights to toggle stopwatch" - }, "404": { "$ref": "#/responses/notFound" }, - "409": { - "description": "Cannot start a stopwatch again if it already exists" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Start stopwatch on an issue." - } - }, - "/repos/{owner}/group/{group_id}/{repo}/languages": { - "get": { - "responses": { - "200": { - "$ref": "#/responses/LanguageStatistics" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get languages and number of bytes of code written", - "operationId": "repoGetLanguages", - "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 - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/statuses/{sha}": { - "post": { - "responses": { - "201": { - "$ref": "#/responses/CommitStatus" - }, - "400": { + "500": { "$ref": "#/responses/error" }, - "404": { - "$ref": "#/responses/notFound" + "200": { + "$ref": "#/responses/PullRequestList" } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Create a commit status", - "operationId": "repoCreateStatus", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "sha of the commit", - "name": "sha", - "in": "path", - "required": true - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/CreateStatusOption" - } - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ] + } }, - "get": { + "post": { + "operationId": "repoCreatePullRequest", "parameters": [ { - "required": true, "type": "string", "description": "owner of the repo", "name": "owner", - "in": "path" + "in": "path", + "required": true }, { "name": "repo", @@ -1261,258 +879,117 @@ "description": "name of the repo" }, { - "type": "string", - "description": "sha of the commit", - "name": "sha", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "type of sort", - "name": "sort", - "in": "query", - "enum": [ - "oldest", - "recentupdate", - "leastupdate", - "leastindex", - "highestindex" - ] - }, - { - "description": "type of state", - "name": "state", - "in": "query", - "enum": [ - "pending", - "success", - "error", - "failure", - "warning" - ], - "type": "string" - }, - { - "name": "page", - "in": "query", - "type": "integer", - "description": "page number of results to return (1-based)" - }, - { - "type": "integer", - "description": "page size of results", - "name": "limit", - "in": "query" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/CommitStatusList" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a commit's statuses", - "operationId": "repoListStatuses" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/wiki/page/{pageName}": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a wiki page", - "operationId": "repoGetWikiPage", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the page", - "name": "pageName" - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "200": { - "$ref": "#/responses/WikiPage" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "delete": { - "tags": [ - "repository" - ], - "summary": "Delete a wiki page", - "operationId": "repoDeleteWikiPage", - "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 - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the page", - "name": "pageName" - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "423": { - "$ref": "#/responses/repoArchivedError" - }, - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "patch": { - "summary": "Edit a wiki page", - "operationId": "repoEditWikiPage", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "required": true, - "type": "string", - "description": "name of the page", - "name": "pageName", - "in": "path" - }, - { + "name": "body", "in": "body", "schema": { - "$ref": "#/definitions/CreateWikiPageOptions" - }, - "name": "body" + "$ref": "#/definitions/CreatePullRequestOption" + } }, { - "name": "group_id", - "type": "integer", - "format": "int64", "required": true, "in": "path", - "description": "group ID of the repo" + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" } ], "responses": { - "200": { - "$ref": "#/responses/WikiPage" - }, - "400": { - "$ref": "#/responses/error" - }, "403": { "$ref": "#/responses/forbidden" }, "404": { "$ref": "#/responses/notFound" }, + "409": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" + }, "423": { "$ref": "#/responses/repoArchivedError" + }, + "201": { + "$ref": "#/responses/PullRequest" } }, "consumes": [ "application/json" ], - "tags": [ - "repository" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/actions/jobs/{job_id}/logs": { - "get": { "produces": [ "application/json" ], "tags": [ "repository" ], - "summary": "Downloads the job logs for a workflow run", - "operationId": "downloadActionsRunJobLogs", + "summary": "Create a pull request" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/git/commits/{sha}.{diffType}": { + "get": { + "produces": [ + "text/plain" + ], + "tags": [ + "repository" + ], + "summary": "Get a commit's diff or patch", + "operationId": "repoDownloadCommitDiffOrPatch", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "SHA of the commit to get", + "name": "sha" + }, + { + "name": "diffType", + "in": "path", + "required": true, + "enum": [ + "diff", + "patch" + ], + "type": "string", + "description": "whether the output is diff or patch" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/string" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/reviews/{id}/comments": { + "get": { "parameters": [ { "name": "owner", @@ -1522,58 +999,66 @@ "description": "owner of the repo" }, { - "description": "name of the repository", "name": "repo", "in": "path", "required": true, - "type": "string" + "type": "string", + "description": "name of the repo" }, { - "type": "integer", - "description": "id of the job", - "name": "job_id", + "description": "index of the pull request", + "name": "index", "in": "path", - "required": true - }, - { - "format": "int64", "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "id", "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "id of the review" + }, + { "description": "group ID of the repo", "name": "group_id", - "type": "integer" + "type": "integer", + "format": "int64", + "required": true, + "in": "path" } ], "responses": { "200": { - "description": "output blob content" - }, - "400": { - "$ref": "#/responses/error" + "$ref": "#/responses/PullReviewCommentList" }, "404": { "$ref": "#/responses/notFound" } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/reviews/{id}/undismissals": { - "post": { + }, "produces": [ "application/json" ], "tags": [ "repository" ], - "summary": "Cancel to dismiss a review for a pull request", - "operationId": "repoUnDismissPullReview", + "summary": "Get a specific review for a pull request", + "operationId": "repoGetPullReviewComments" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/pulls/pinned": { + "get": { + "summary": "List a repo's pinned pull requests", + "operationId": "repoListPinnedPullRequests", "parameters": [ { + "type": "string", "description": "owner of the repo", "name": "owner", "in": "path", - "required": true, - "type": "string" + "required": true }, { "in": "path", @@ -1583,12 +1068,278 @@ "name": "repo" }, { - "name": "index", - "in": "path", - "required": true, + "description": "group ID of the repo", + "name": "group_id", "type": "integer", "format": "int64", - "description": "index of the pull request" + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/PullRequestList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/git/commits/{sha}": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get a single commit from a repository", + "operationId": "repoGetSingleCommit", + "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": "a git ref or commit sha", + "name": "sha", + "in": "path", + "required": true + }, + { + "type": "boolean", + "description": "include diff stats for every commit (disable for speedup, default 'true')", + "name": "stat", + "in": "query" + }, + { + "type": "boolean", + "description": "include verification for every commit (disable for speedup, default 'true')", + "name": "verification", + "in": "query" + }, + { + "type": "boolean", + "description": "include a list of affected files for every commit (disable for speedup, default 'true')", + "name": "files", + "in": "query" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/Commit" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/artifacts/{artifact_id}": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Gets a specific artifact for a workflow run", + "operationId": "getArtifact", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repository", + "name": "repo" + }, + { + "type": "string", + "description": "id of the artifact", + "name": "artifact_id", + "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/Artifact" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + }, + "delete": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Deletes a specific artifact for a workflow run", + "operationId": "deleteArtifact", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "type": "string", + "description": "name of the repository", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "id of the artifact", + "name": "artifact_id", + "in": "path", + "required": true + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/reviewers": { + "get": { + "operationId": "repoGetReviewers", + "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/UserList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Return all users that can be requested to review in this repo" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/reviews/{id}/dismissals": { + "post": { + "summary": "Dismiss a review for a pull request", + "operationId": "repoDismissPullReview", + "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", @@ -1598,6 +1349,14 @@ "in": "path", "required": true }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DismissPullReviewOptions" + } + }, { "description": "group ID of the repo", "name": "group_id", @@ -1608,6 +1367,9 @@ } ], "responses": { + "200": { + "$ref": "#/responses/PullReview" + }, "403": { "$ref": "#/responses/forbidden" }, @@ -1616,18 +1378,142 @@ }, "422": { "$ref": "#/responses/validationError" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/lock": { + "put": { + "tags": [ + "issue" + ], + "summary": "Lock an issue", + "operationId": "issueLockIssue", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" }, - "200": { - "$ref": "#/responses/PullReview" + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "format": "int64", + "description": "index of the issue", + "name": "index", + "in": "path", + "required": true, + "type": "integer" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/LockIssueOption" + } + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] + }, + "delete": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Unlock an issue", + "operationId": "issueUnlockIssue", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path" + }, + { + "type": "integer", + "format": "int64", + "description": "index of the issue", + "name": "index", + "in": "path", + "required": true + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "204": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" } } } }, - "/repos/{owner}/group/{group_id}/{repo}/licenses": { + "/repos/{owner}/group/{group_id}/{repo}/issue_config": { "get": { "responses": { "200": { - "$ref": "#/responses/LicensesList" + "$ref": "#/responses/RepoIssueConfig" }, "404": { "$ref": "#/responses/notFound" @@ -1639,48 +1525,116 @@ "tags": [ "repository" ], - "summary": "Get repo licenses", - "operationId": "repoGetLicenses", + "summary": "Returns the issue config for a repo", + "operationId": "repoGetIssueConfig", "parameters": [ { + "type": "string", + "description": "owner of the repo", "name": "owner", "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" + "required": true }, { - "in": "path", - "required": true, "type": "string", "description": "name of the repo", - "name": "repo" + "name": "repo", + "in": "path", + "required": true }, { - "in": "path", - "description": "group ID of the repo", "name": "group_id", "type": "integer", "format": "int64", - "required": true + "required": true, + "in": "path", + "description": "group ID of the repo" } ] } }, - "/repos/{owner}/group/{group_id}/{repo}/actions/variables/{variablename}": { + "/repos/{owner}/group/{group_id}/{repo}/actions/secrets/{secretname}": { "put": { + "operationId": "updateRepoSecret", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repository", + "name": "owner" + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repository", + "name": "repo" + }, + { + "description": "name of the secret", + "name": "secretname", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/CreateOrUpdateSecretOption" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "201": { + "description": "response when creating a secret" + }, + "204": { + "description": "response when updating a secret" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], "tags": [ "repository" ], - "summary": "Update a repo-level variable", - "operationId": "updateRepoVariable", + "summary": "Create or Update a secret value in a repository" + }, + "delete": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Delete a secret in a repository", + "operationId": "deleteRepoSecret", "parameters": [ { "type": "string", - "description": "owner of the repo", + "description": "owner of the repository", "name": "owner", "in": "path", "required": true @@ -1693,18 +1647,80 @@ "required": true }, { - "name": "variablename", + "type": "string", + "description": "name of the secret", + "name": "secretname", + "in": "path", + "required": true + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "204": { + "description": "delete one secret of the repository" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/git/trees/{sha}": { + "get": { + "tags": [ + "repository" + ], + "summary": "Gets the tree of a repository.", + "operationId": "GetTree", + "parameters": [ + { + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { "in": "path", "required": true, "type": "string", - "description": "name of the variable" + "description": "sha of the commit", + "name": "sha" }, { - "schema": { - "$ref": "#/definitions/UpdateVariableOption" - }, - "name": "body", - "in": "body" + "type": "boolean", + "description": "show all directories and files", + "name": "recursive", + "in": "query" + }, + { + "type": "integer", + "description": "page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page", + "name": "page", + "in": "query" + }, + { + "name": "per_page", + "in": "query", + "type": "integer", + "description": "number of items per page" }, { "name": "group_id", @@ -1722,30 +1738,140 @@ "404": { "$ref": "#/responses/notFound" }, - "201": { - "description": "response when updating a repo-level variable" - }, - "204": { - "description": "response when updating a repo-level variable" + "200": { + "$ref": "#/responses/GitTreeResponse" } - } - }, - "post": { + }, + "produces": [ + "application/json" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/variables/{variablename}": { + "get": { "produces": [ "application/json" ], "tags": [ "repository" ], + "summary": "Get a repo-level variable", + "operationId": "getRepoVariable", + "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 + }, + { + "required": true, + "type": "string", + "description": "name of the variable", + "name": "variablename", + "in": "path" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/ActionVariable" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + }, + "put": { + "operationId": "updateRepoVariable", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repository", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "string", + "description": "name of the variable", + "name": "variablename", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/UpdateVariableOption" + } + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "201": { + "description": "response when updating a repo-level variable" + }, + "204": { + "description": "response when updating a repo-level variable" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Update a repo-level variable" + }, + "post": { "summary": "Create a repo-level variable", "operationId": "createRepoVariable", "parameters": [ { - "in": "path", "required": true, "type": "string", "description": "owner of the repo", - "name": "owner" + "name": "owner", + "in": "path" }, { "type": "string", @@ -1769,12 +1895,12 @@ } }, { + "description": "group ID of the repo", + "name": "group_id", "type": "integer", "format": "int64", "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" + "in": "path" } ], "responses": { @@ -1790,7 +1916,13 @@ "500": { "$ref": "#/responses/error" } - } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] }, "delete": { "produces": [ @@ -1803,25 +1935,25 @@ "operationId": "deleteRepoVariable", "parameters": [ { - "type": "string", "description": "owner of the repo", "name": "owner", "in": "path", - "required": true + "required": true, + "type": "string" }, { + "name": "repo", "in": "path", "required": true, "type": "string", - "description": "name of the repository", - "name": "repo" + "description": "name of the repository" }, { + "required": true, "type": "string", "description": "name of the variable", "name": "variablename", - "in": "path", - "required": true + "in": "path" }, { "required": true, @@ -1833,6 +1965,9 @@ } ], "responses": { + "204": { + "description": "response when deleting a variable" + }, "400": { "$ref": "#/responses/error" }, @@ -1844,126 +1979,11 @@ }, "201": { "description": "response when deleting a variable" - }, - "204": { - "description": "response when deleting a variable" - } - } - }, - "get": { - "operationId": "getRepoVariable", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repository", - "name": "repo" - }, - { - "type": "string", - "description": "name of the variable", - "name": "variablename", - "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/ActionVariable" - }, - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a repo-level variable" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/reviews/{id}/comments": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a specific review for a pull request", - "operationId": "repoGetPullReviewComments", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "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", - "name": "id", - "in": "path", - "required": true - }, - { - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true - } - ], - "responses": { - "200": { - "$ref": "#/responses/PullReviewCommentList" - }, - "404": { - "$ref": "#/responses/notFound" } } } }, - "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/reviews/{id}": { + "/repos/{owner}/group/{group_id}/{repo}/git/notes/{sha}": { "get": { "produces": [ "application/json" @@ -1971,135 +1991,8 @@ "tags": [ "repository" ], - "summary": "Get a specific review for a pull request", - "operationId": "repoGetPullReview", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, - { - "description": "index of the pull request", - "name": "index", - "in": "path", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "type": "integer", - "format": "int64", - "description": "id of the review", - "name": "id", - "in": "path", - "required": true - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "$ref": "#/responses/PullReview" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "post": { - "operationId": "repoSubmitPullReview", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "description": "index of the pull request", - "name": "index", - "in": "path", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "format": "int64", - "description": "id of the review", - "name": "id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SubmitPullReviewOptions" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/PullReview" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Submit a pending review to an pull request" - }, - "delete": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Delete a specific review from a pull request", - "operationId": "repoDeletePullReview", + "summary": "Get a note corresponding to a single commit from a repository", + "operationId": "repoGetNote", "parameters": [ { "type": "string", @@ -2116,20 +2009,83 @@ "description": "name of the repo" }, { + "type": "string", + "description": "a git ref or commit sha", + "name": "sha", + "in": "path", + "required": true + }, + { + "type": "boolean", + "description": "include verification for every commit (disable for speedup, default 'true')", + "name": "verification", + "in": "query" + }, + { + "description": "include a list of affected files for every commit (disable for speedup, default 'true')", + "name": "files", + "in": "query", + "type": "boolean" + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", "type": "integer", "format": "int64", - "description": "index of the pull request", + "required": true + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + }, + "200": { + "$ref": "#/responses/Note" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/pin/{position}": { + "patch": { + "tags": [ + "issue" + ], + "summary": "Moves the Pin to the given Position", + "operationId": "moveIssuePin", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "description": "index of issue", "name": "index", "in": "path", "required": true }, { - "in": "path", "required": true, "type": "integer", "format": "int64", - "description": "id of the review", - "name": "id" + "description": "the new position", + "name": "position", + "in": "path" }, { "description": "group ID of the repo", @@ -2140,6 +2096,205 @@ "in": "path" } ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/hooks/git": { + "get": { + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "200": { + "$ref": "#/responses/GitHookList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "List the Git hooks in a repository", + "operationId": "repoListGitHooks" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/artifacts": { + "get": { + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "type": "string", + "description": "name of the repository", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of the artifact", + "name": "name", + "in": "query" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/ArtifactsList" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Lists all artifacts for a repository", + "operationId": "getArtifacts" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/keys/{id}": { + "get": { + "responses": { + "200": { + "$ref": "#/responses/DeployKey" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get a repository's key by id", + "operationId": "repoGetKey", + "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 + }, + { + "format": "int64", + "description": "id of the key to get", + "name": "id", + "in": "path", + "required": true, + "type": "integer" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ] + }, + "delete": { + "tags": [ + "repository" + ], + "summary": "Delete a key from a repository", + "operationId": "repoDeleteKey", + "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 + }, + { + "required": true, + "type": "integer", + "format": "int64", + "description": "id of the key to delete", + "name": "id", + "in": "path" + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], "responses": { "404": { "$ref": "#/responses/notFound" @@ -2153,36 +2308,33 @@ } } }, - "/repos/{owner}/group/{group_id}/{repo}/actions/variables": { + "/repos/{owner}/group/{group_id}/{repo}/topics": { "get": { - "produces": [ - "application/json" - ], "tags": [ "repository" ], - "summary": "Get repo-level variables list", - "operationId": "getRepoVariablesList", + "summary": "Get list of topics that a repository has", + "operationId": "repoListTopics", "parameters": [ { + "required": true, "type": "string", "description": "owner of the repo", "name": "owner", - "in": "path", - "required": true + "in": "path" }, { "type": "string", - "description": "name of the repository", + "description": "name of the repo", "name": "repo", "in": "path", "required": true }, { - "type": "integer", - "description": "page number of results to return (1-based)", "name": "page", - "in": "query" + "in": "query", + "type": "integer", + "description": "page number of results to return (1-based)" }, { "type": "integer", @@ -2191,12 +2343,12 @@ "in": "query" }, { + "description": "group ID of the repo", "name": "group_id", "type": "integer", "format": "int64", "required": true, - "in": "path", - "description": "group ID of the repo" + "in": "path" } ], "responses": { @@ -2204,31 +2356,75 @@ "$ref": "#/responses/notFound" }, "200": { - "$ref": "#/responses/VariableList" - }, - "400": { - "$ref": "#/responses/error" + "$ref": "#/responses/TopicNames" } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issue_config": { - "get": { + }, + "produces": [ + "application/json" + ] + }, + "put": { + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/RepoTopicOptions" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/invalidTopicsError" + }, + "204": { + "$ref": "#/responses/empty" + } + }, "produces": [ "application/json" ], "tags": [ "repository" ], - "summary": "Returns the issue config for a repo", - "operationId": "repoGetIssueConfig", + "summary": "Replace list of topics for a repository", + "operationId": "repoUpdateTopics" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/git/refs": { + "get": { "parameters": [ { + "name": "owner", + "in": "path", "required": true, "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" + "description": "owner of the repo" }, { "name": "repo", @@ -2237,57 +2433,6 @@ "type": "string", "description": "name of the repo" }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "200": { - "$ref": "#/responses/RepoIssueConfig" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/teams/{team}": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Check if a team is assigned to a repository", - "operationId": "repoCheckTeam", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "team name", - "name": "team" - }, { "required": true, "in": "path", @@ -2299,132 +2444,7 @@ ], "responses": { "200": { - "$ref": "#/responses/Team" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "405": { - "$ref": "#/responses/error" - } - } - }, - "put": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Add a team to a repository", - "operationId": "repoAddTeam", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "team name", - "name": "team", - "in": "path", - "required": true - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "405": { - "$ref": "#/responses/error" - }, - "422": { - "$ref": "#/responses/validationError" - } - } - }, - "delete": { - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "description": "team name", - "name": "team", - "in": "path", - "required": true, - "type": "string" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "405": { - "$ref": "#/responses/error" - }, - "422": { - "$ref": "#/responses/validationError" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Delete a team from a repository", - "operationId": "repoDeleteTeam" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/releases/latest": { - "get": { - "responses": { - "200": { - "$ref": "#/responses/Release" + "$ref": "#/responses/ReferenceList" }, "404": { "$ref": "#/responses/notFound" @@ -2436,8 +2456,20 @@ "tags": [ "repository" ], - "summary": "Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at", - "operationId": "repoGetLatestRelease", + "summary": "Get specified ref or filtered repository's refs", + "operationId": "repoListAllGitRefs" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/signing-key.pub": { + "get": { + "produces": [ + "text/plain" + ], + "tags": [ + "repository" + ], + "summary": "Get signing-key.pub for given repository", + "operationId": "repoSigningKeySSH", "parameters": [ { "type": "string", @@ -2454,26 +2486,34 @@ "name": "repo" }, { + "description": "group ID of the repo", "name": "group_id", "type": "integer", "format": "int64", "required": true, - "in": "path", - "description": "group ID of the repo" + "in": "path" } - ] + ], + "responses": { + "200": { + "description": "ssh public key", + "schema": { + "type": "string" + } + } + } } }, - "/repos/{owner}/group/{group_id}/{repo}/git/trees/{sha}": { - "get": { + "/repos/{owner}/group/{group_id}/{repo}/hooks/{id}": { + "delete": { "produces": [ "application/json" ], "tags": [ "repository" ], - "summary": "Gets the tree of a repository.", - "operationId": "GetTree", + "summary": "Delete a hook in a repository", + "operationId": "repoDeleteHook", "parameters": [ { "description": "owner of the repo", @@ -2483,36 +2523,162 @@ "type": "string" }, { - "description": "name of the repo", "name": "repo", "in": "path", "required": true, - "type": "string" + "type": "string", + "description": "name of the repo" }, { - "type": "string", - "description": "sha of the commit", - "name": "sha", + "type": "integer", + "format": "int64", + "description": "id of the hook to delete", + "name": "id", "in": "path", "required": true }, { - "type": "boolean", - "description": "show all directories and files", - "name": "recursive", - "in": "query" + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + }, + "patch": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Edit a hook in a repository", + "operationId": "repoEditHook", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true }, { - "type": "integer", - "description": "page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page", - "name": "page", - "in": "query" + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true }, { + "description": "index of the hook", + "name": "id", + "in": "path", + "required": true, "type": "integer", - "description": "number of items per page", - "name": "per_page", - "in": "query" + "format": "int64" + }, + { + "in": "body", + "schema": { + "$ref": "#/definitions/EditHookOption" + }, + "name": "body" + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/Hook" + } + } + }, + "get": { + "responses": { + "200": { + "$ref": "#/responses/Hook" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get a hook", + "operationId": "repoGetHook", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "id of the hook to get" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issue_templates": { + "get": { + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true }, { "required": true, @@ -2525,34 +2691,33 @@ ], "responses": { "200": { - "$ref": "#/responses/GitTreeResponse" - }, - "400": { - "$ref": "#/responses/error" + "$ref": "#/responses/IssueTemplates" }, "404": { "$ref": "#/responses/notFound" } - } - } - }, - "/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", + "summary": "Get available issue templates for a repository", + "operationId": "repoGetIssueTemplates" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/file-contents": { + "get": { + "summary": "Get the metadata and contents of requested files", + "operationId": "repoGetFileContents", "parameters": [ { - "type": "string", "description": "owner of the repo", "name": "owner", "in": "path", - "required": true + "required": true, + "type": "string" }, { "type": "string", @@ -2561,38 +2726,18 @@ "in": "path", "required": true }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "200": { - "$ref": "#/responses/RegistrationToken" - } - } - }, - "post": { - "summary": "Get a repository's actions runner registration token", - "operationId": "repoCreateRunnerRegistrationToken", - "parameters": [ { "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true + "description": "The name of the commit/branch/tag. Default to the repository’s default branch.", + "name": "ref", + "in": "query" }, { "required": true, "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" + "description": "The JSON encoded body (see the POST request): {\"files\": [\"filename1\", \"filename2\"]}", + "name": "body", + "in": "query" }, { "description": "group ID of the repo", @@ -2605,27 +2750,33 @@ ], "responses": { "200": { - "$ref": "#/responses/RegistrationToken" + "$ref": "#/responses/ContentsListResponse" + }, + "404": { + "$ref": "#/responses/notFound" } }, + "description": "See the POST method. This GET method supports using JSON encoded request body in query parameter.", "produces": [ "application/json" ], "tags": [ "repository" ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/collaborators/{collaborator}/permission": { - "get": { - "operationId": "repoGetRepoPermissions", + }, + "post": { + "tags": [ + "repository" + ], + "summary": "Get the metadata and contents of requested files", + "operationId": "repoGetFileContentsPost", "parameters": [ { + "name": "owner", "in": "path", "required": true, "type": "string", - "description": "owner of the repo", - "name": "owner" + "description": "owner of the repo" }, { "type": "string", @@ -2635,11 +2786,18 @@ "required": true }, { - "in": "path", - "required": true, "type": "string", - "description": "username of the collaborator whose permissions are to be obtained", - "name": "collaborator" + "description": "The name of the commit/branch/tag. Default to the repository’s default branch.", + "name": "ref", + "in": "query" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetFilesOptions" + } }, { "type": "integer", @@ -2650,6 +2808,270 @@ "name": "group_id" } ], + "responses": { + "200": { + "$ref": "#/responses/ContentsListResponse" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "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`.", + "produces": [ + "application/json" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/tag_protections/{id}": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get a specific tag protection for the repository", + "operationId": "repoGetTagProtection", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "required": true, + "type": "integer", + "description": "id of the tag protect to get", + "name": "id", + "in": "path" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/TagProtection" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + }, + "delete": { + "summary": "Delete a specific tag protection for the repository", + "operationId": "repoDeleteTagProtection", + "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 + }, + { + "in": "path", + "required": true, + "type": "integer", + "description": "id of protected tag", + "name": "id" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + }, + "patch": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Edit a tag protections for a repository. Only fields that are set will be changed", + "operationId": "repoEditTagProtection", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "required": true, + "type": "integer", + "description": "id of protected tag", + "name": "id", + "in": "path" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/EditTagProtectionOption" + } + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/TagProtection" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/archive/{archive}": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get an archive of a repository", + "operationId": "repoGetArchive", + "parameters": [ + { + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "required": true, + "type": "string", + "description": "the git reference for download with attached archive format (e.g. master.zip)", + "name": "archive", + "in": "path" + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "success" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/collaborators/{collaborator}/permission": { + "get": { + "operationId": "repoGetRepoPermissions", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "username of the collaborator whose permissions are to be obtained", + "name": "collaborator", + "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/RepoCollaboratorPermission" @@ -2670,31 +3092,95 @@ "summary": "Get repository permissions for a user" } }, - "/repos/{owner}/group/{group_id}/{repo}/collaborators/{collaborator}": { + "/repos/{owner}/group/{group_id}/{repo}/issues/comments": { "get": { - "operationId": "repoCheckCollaborator", + "responses": { + "200": { + "$ref": "#/responses/CommentList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "List all comments in a repository", + "operationId": "issueGetRepoComments", "parameters": [ { - "type": "string", "description": "owner of the repo", "name": "owner", "in": "path", - "required": true - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", "required": true, "type": "string" }, { "type": "string", - "description": "username of the user to check for being a collaborator", - "name": "collaborator", + "description": "name of the repo", + "name": "repo", "in": "path", "required": true }, + { + "in": "query", + "type": "string", + "format": "date-time", + "description": "if provided, only comments updated since the provided time are returned.", + "name": "since" + }, + { + "description": "if provided, only comments updated before the provided time are returned.", + "name": "before", + "in": "query", + "type": "string", + "format": "date-time" + }, + { + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query", + "type": "integer" + }, + { + "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" + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/runners/registration-token": { + "get": { + "summary": "Get a repository's actions runner registration token", + "operationId": "repoGetRunnerRegistrationToken", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "name": "repo", + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo" + }, { "description": "group ID of the repo", "name": "group_id", @@ -2705,14 +3191,8 @@ } ], "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" + "200": { + "$ref": "#/responses/RegistrationToken" } }, "produces": [ @@ -2720,73 +3200,55 @@ ], "tags": [ "repository" - ], - "summary": "Check if a user is a collaborator of a repository" + ] }, - "put": { + "post": { "produces": [ "application/json" ], "tags": [ "repository" ], - "summary": "Add or Update a collaborator to a repository", - "operationId": "repoAddCollaborator", + "summary": "Get a repository's actions runner registration token", + "operationId": "repoCreateRunnerRegistrationToken", "parameters": [ { + "required": true, "type": "string", "description": "owner of the repo", "name": "owner", - "in": "path", - "required": true + "in": "path" }, { - "required": true, "type": "string", "description": "name of the repo", "name": "repo", - "in": "path" - }, - { - "type": "string", - "description": "username of the user to add or update as a collaborator", - "name": "collaborator", "in": "path", "required": true }, { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/AddCollaboratorOption" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", "format": "int64", "required": true, - "in": "path" + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" } ], "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" + "200": { + "$ref": "#/responses/RegistrationToken" } } - }, - "delete": { - "operationId": "repoDeleteCollaborator", + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues": { + "get": { + "tags": [ + "issue" + ], + "summary": "List a repository's issues", + "operationId": "issueListIssues", "parameters": [ { "type": "string", @@ -2796,18 +3258,94 @@ "required": true }, { + "required": true, "type": "string", "description": "name of the repo", "name": "repo", - "in": "path", - "required": true + "in": "path" + }, + { + "enum": [ + "closed", + "open", + "all" + ], + "type": "string", + "description": "whether issue is open or closed", + "name": "state", + "in": "query" }, { "type": "string", - "description": "username of the collaborator to delete", - "name": "collaborator", - "in": "path", - "required": true + "description": "comma separated list of label names. Fetch only issues that have any of this label names. Non existent labels are discarded.", + "name": "labels", + "in": "query" + }, + { + "type": "string", + "description": "search string", + "name": "q", + "in": "query" + }, + { + "name": "type", + "in": "query", + "enum": [ + "issues", + "pulls" + ], + "type": "string", + "description": "filter by type (issues / pulls) if set" + }, + { + "type": "string", + "description": "comma separated list of milestone names or ids. It uses names and fall back to ids. Fetch only issues that have any of this milestones. Non existent milestones are discarded", + "name": "milestones", + "in": "query" + }, + { + "type": "string", + "format": "date-time", + "description": "Only show items updated after the given time. This is a timestamp in RFC 3339 format", + "name": "since", + "in": "query" + }, + { + "description": "Only show items updated before the given time. This is a timestamp in RFC 3339 format", + "name": "before", + "in": "query", + "type": "string", + "format": "date-time" + }, + { + "description": "Only show items which were created by the given user", + "name": "created_by", + "in": "query", + "type": "string" + }, + { + "type": "string", + "description": "Only show items for which the given user is assigned", + "name": "assigned_by", + "in": "query" + }, + { + "in": "query", + "type": "string", + "description": "Only show items in which the given user was mentioned", + "name": "mentioned_by" + }, + { + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query", + "type": "integer" + }, + { + "type": "integer", + "description": "page size of results", + "name": "limit", + "in": "query" }, { "type": "integer", @@ -2819,148 +3357,20 @@ } ], "responses": { - "422": { - "$ref": "#/responses/validationError" - }, - "204": { - "$ref": "#/responses/empty" + "200": { + "$ref": "#/responses/IssueList" }, "404": { "$ref": "#/responses/notFound" } }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Delete a collaborator from a repository" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/comments/{id}/assets/{attachment_id}": { - "get": { - "tags": [ - "issue" - ], - "summary": "Get a comment attachment", - "operationId": "issueGetIssueCommentAttachment", - "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 - }, - { - "format": "int64", - "description": "id of the comment", - "name": "id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "required": true, - "type": "integer", - "format": "int64", - "description": "id of the attachment to get", - "name": "attachment_id", - "in": "path" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "200": { - "$ref": "#/responses/Attachment" - }, - "404": { - "$ref": "#/responses/error" - } - }, "produces": [ "application/json" ] }, - "delete": { - "tags": [ - "issue" - ], - "summary": "Delete a comment attachment", - "operationId": "issueDeleteIssueCommentAttachment", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "description": "id of the comment", - "name": "id", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "description": "id of the attachment to delete", - "name": "attachment_id", - "in": "path", - "required": true - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "404": { - "$ref": "#/responses/error" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - }, - "204": { - "$ref": "#/responses/empty" - } - }, - "produces": [ - "application/json" - ] - }, - "patch": { - "summary": "Edit a comment attachment", - "operationId": "issueEditIssueCommentAttachment", + "post": { + "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.", + "operationId": "issueCreateIssue", "parameters": [ { "in": "path", @@ -2977,27 +3387,166 @@ "required": true }, { - "required": true, - "type": "integer", - "format": "int64", - "description": "id of the comment", - "name": "id", - "in": "path" + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/CreateIssueOption" + } }, { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", "type": "integer", "format": "int64", - "description": "id of the attachment to edit", - "name": "attachment_id", + "required": true + } + ], + "responses": { + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "412": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + }, + "201": { + "$ref": "#/responses/Issue" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/times": { + "get": { + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", "in": "path", "required": true }, { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/EditAttachmentOptions" - } + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "optional filter by user (available for issue managers)", + "name": "user", + "in": "query" + }, + { + "type": "string", + "format": "date-time", + "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format", + "name": "since", + "in": "query" + }, + { + "type": "string", + "format": "date-time", + "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format", + "name": "before", + "in": "query" + }, + { + "name": "page", + "in": "query", + "type": "integer", + "description": "page number of results to return (1-based)" + }, + { + "description": "page size of results", + "name": "limit", + "in": "query", + "type": "integer" + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/TrackedTimeList" + }, + "400": { + "$ref": "#/responses/error" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "List a repo's tracked times", + "operationId": "repoTrackedTimes" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/releases/{id}/assets/{attachment_id}": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "description": "id of the release", + "name": "id", + "in": "path", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "format": "int64", + "description": "id of the attachment to get", + "name": "attachment_id", + "in": "path", + "required": true, + "type": "integer" }, { "format": "int64", @@ -3008,336 +3557,160 @@ "type": "integer" } ], + "responses": { + "200": { + "$ref": "#/responses/Attachment" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get a release attachment", + "operationId": "repoGetReleaseAttachment" + }, + "delete": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Delete a release attachment", + "operationId": "repoDeleteReleaseAttachment", + "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 release", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "description": "id of the attachment to delete", + "name": "attachment_id", + "in": "path", + "required": true + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "204": { + "$ref": "#/responses/empty" + } + } + }, + "patch": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Edit a release attachment", + "operationId": "repoEditReleaseAttachment", + "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": "id of the release", + "name": "id", + "in": "path", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "attachment_id", + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "id of the attachment to edit" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/EditAttachmentOptions" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], "responses": { "201": { "$ref": "#/responses/Attachment" }, "404": { - "$ref": "#/responses/error" + "$ref": "#/responses/notFound" }, "422": { "$ref": "#/responses/validationError" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/git/refs": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get specified ref or filtered repository's refs", - "operationId": "repoListAllGitRefs", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/ReferenceList" - }, - "404": { - "$ref": "#/responses/notFound" } } } }, - "/repos/{owner}/group/{group_id}/{repo}/issues/comments/{id}/reactions": { + "/repos/{owner}/group/{group_id}/{repo}/releases": { "get": { - "operationId": "issueGetCommentReactions", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "integer", - "format": "int64", - "description": "id of the comment to edit", - "name": "id", - "in": "path", - "required": true - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "200": { - "$ref": "#/responses/ReactionList" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Get a list of reactions from a comment of an issue" - }, - "post": { - "summary": "Add a reaction to a comment of an issue", - "operationId": "issuePostCommentReaction", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "id of the comment to edit", - "name": "id" - }, - { - "name": "content", - "in": "body", - "schema": { - "$ref": "#/definitions/EditReactionOption" - } - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/Reaction" - }, - "201": { - "$ref": "#/responses/Reaction" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ] - }, - "delete": { - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Remove a reaction from a comment of an issue", - "operationId": "issueDeleteCommentReaction", - "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 comment to edit", - "name": "id", - "in": "path", - "required": true - }, - { - "schema": { - "$ref": "#/definitions/EditReactionOption" - }, - "name": "content", - "in": "body" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/transfer/accept": { - "post": { - "operationId": "acceptRepoTransfer", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo to transfer" - }, - { - "description": "name of the repo to transfer", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "202": { - "$ref": "#/responses/Repository" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], "tags": [ "repository" ], - "summary": "Accept a repo transfer" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/reactions": { - "post": { - "responses": { - "201": { - "$ref": "#/responses/Reaction" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/Reaction" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Add a reaction to an issue", - "operationId": "issuePostIssueReaction", + "summary": "List a repo's releases", + "operationId": "repoListReleases", "parameters": [ { "type": "string", @@ -3347,140 +3720,29 @@ "required": true }, { - "name": "repo", "in": "path", "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "description": "index of the issue", - "name": "index", - "in": "path", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "content", - "in": "body", - "schema": { - "$ref": "#/definitions/EditReactionOption" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ] - }, - "delete": { - "tags": [ - "issue" - ], - "summary": "Remove a reaction from an issue", - "operationId": "issueDeleteIssueReaction", - "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 + "name": "repo" }, { - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the issue", - "name": "index", - "in": "path" + "type": "boolean", + "description": "filter (exclude / include) drafts, if you dont have repo write access none will show", + "name": "draft", + "in": "query" }, { - "in": "body", - "schema": { - "$ref": "#/definitions/EditReactionOption" - }, - "name": "content" + "type": "boolean", + "description": "filter (exclude / include) pre-releases", + "name": "pre-release", + "in": "query" }, { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] - }, - "get": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Get a list reactions of an issue", - "operationId": "issueGetIssueReactions", - "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": "index of the issue", - "name": "index", - "in": "path", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "in": "query", "type": "integer", "description": "page number of results to return (1-based)", - "name": "page" + "name": "page", + "in": "query" }, { "type": "integer", @@ -3489,25 +3751,83 @@ "in": "query" }, { - "description": "group ID of the repo", "name": "group_id", "type": "integer", "format": "int64", "required": true, - "in": "path" + "in": "path", + "description": "group ID of the repo" } ], "responses": { "200": { - "$ref": "#/responses/ReactionList" - }, - "403": { - "$ref": "#/responses/forbidden" + "$ref": "#/responses/ReleaseList" }, "404": { "$ref": "#/responses/notFound" } - } + }, + "produces": [ + "application/json" + ] + }, + "post": { + "tags": [ + "repository" + ], + "summary": "Create a release", + "operationId": "repoCreateRelease", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/CreateReleaseOption" + } + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "409": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" + }, + "201": { + "$ref": "#/responses/Release" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] } }, "/repos/{owner}/group/{group_id}/{repo}/actions/workflows/{workflow_id}/enable": { @@ -3522,35 +3842,29 @@ "required": true }, { - "in": "path", - "required": true, "type": "string", "description": "name of the repo", - "name": "repo" - }, - { - "type": "string", - "description": "id of the workflow", - "name": "workflow_id", + "name": "repo", "in": "path", "required": true }, { + "in": "path", + "required": true, + "type": "string", + "description": "id of the workflow", + "name": "workflow_id" + }, + { + "in": "path", "description": "group ID of the repo", "name": "group_id", "type": "integer", "format": "int64", - "required": true, - "in": "path" + "required": true } ], "responses": { - "400": { - "$ref": "#/responses/error" - }, - "403": { - "$ref": "#/responses/forbidden" - }, "404": { "$ref": "#/responses/notFound" }, @@ -3562,6 +3876,12 @@ }, "204": { "description": "No Content" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" } }, "produces": [ @@ -3573,1471 +3893,13 @@ "summary": "Enable a workflow" } }, - "/repos/{owner}/group/{group_id}/{repo}/wiki/revisions/{pageName}": { - "get": { - "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 - }, - { - "required": true, - "type": "string", - "description": "name of the page", - "name": "pageName", - "in": "path" - }, - { - "type": "integer", - "description": "page number of results to return (1-based)", - "name": "page", - "in": "query" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "200": { - "$ref": "#/responses/WikiCommitList" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get revisions of a wiki page", - "operationId": "repoGetWikiPageRevisions" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/reviews": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List all reviews for a pull request", - "operationId": "repoListPullReviews", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the pull request", - "name": "index" - }, - { - "in": "query", - "type": "integer", - "description": "page number of results to return (1-based)", - "name": "page" - }, - { - "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/PullReviewList" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "post": { - "tags": [ - "repository" - ], - "summary": "Create a review to an pull request", - "operationId": "repoCreatePullReview", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "integer", - "format": "int64", - "description": "index of the pull request", - "name": "index", - "in": "path", - "required": true - }, - { - "schema": { - "$ref": "#/definitions/CreatePullReviewOptions" - }, - "name": "body", - "in": "body", - "required": true - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "422": { - "$ref": "#/responses/validationError" - }, - "200": { - "$ref": "#/responses/PullReview" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/tags": { - "get": { - "operationId": "repoListTags", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "in": "query", - "type": "integer", - "description": "page number of results to return (1-based)", - "name": "page" - }, - { - "name": "limit", - "in": "query", - "type": "integer", - "description": "page size of results, default maximum page size is 50" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "200": { - "$ref": "#/responses/TagList" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List a repository's tags" - }, - "post": { - "responses": { - "405": { - "$ref": "#/responses/empty" - }, - "409": { - "$ref": "#/responses/conflict" - }, - "422": { - "$ref": "#/responses/validationError" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - }, - "200": { - "$ref": "#/responses/Tag" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Create a new git tag in a repository", - "operationId": "repoCreateTag", - "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 - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/CreateTagOption" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/subscription": { - "get": { - "tags": [ - "repository" - ], - "summary": "Check if the current user is watching a repo", - "operationId": "userCurrentCheckSubscription", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "200": { - "$ref": "#/responses/WatchInfo" - }, - "404": { - "description": "User is not watching this repo or repo do not exist" - } - } - }, - "put": { - "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 - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "200": { - "$ref": "#/responses/WatchInfo" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "tags": [ - "repository" - ], - "summary": "Watch a repo", - "operationId": "userCurrentPutSubscription" - }, - "delete": { - "tags": [ - "repository" - ], - "summary": "Unwatch a repo", - "operationId": "userCurrentDeleteSubscription", - "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", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/times/{id}": { - "delete": { - "tags": [ - "issue" - ], - "summary": "Delete specific tracked time", - "operationId": "issueDeleteTime", - "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 issue", - "name": "index", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "description": "id of time to delete", - "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/error" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issue_templates": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get available issue templates for a repository", - "operationId": "repoGetIssueTemplates", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "200": { - "$ref": "#/responses/IssueTemplates" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issue_config/validate": { - "get": { - "operationId": "repoValidateIssueConfig", - "parameters": [ - { - "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" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "200": { - "$ref": "#/responses/RepoIssueConfigValidation" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Returns the validation information for a issue config" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/tags/{tag}": { - "get": { - "summary": "Get the tag of a repository by tag name", - "operationId": "repoGetTag", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "type": "string", - "description": "name of tag", - "name": "tag", - "in": "path", - "required": true - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "$ref": "#/responses/Tag" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ] - }, - "delete": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Delete a repository's tag by name", - "operationId": "repoDeleteTag", - "parameters": [ - { - "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" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of tag to delete", - "name": "tag" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "405": { - "$ref": "#/responses/empty" - }, - "409": { - "$ref": "#/responses/conflict" - }, - "422": { - "$ref": "#/responses/validationError" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/push_mirrors/{name}": { - "get": { - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "remote name of push mirror", - "name": "name" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/PushMirror" - }, - "400": { - "$ref": "#/responses/error" - }, - "403": { - "$ref": "#/responses/forbidden" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get push mirror of the repository by remoteName", - "operationId": "repoGetPushMirrorByRemoteName" - }, - "delete": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "deletes a push mirror from a repository by remoteName", - "operationId": "repoDeletePushMirror", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "string", - "description": "remote name of the pushMirror", - "name": "name", - "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/error" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/subscriptions/check": { - "get": { - "tags": [ - "issue" - ], - "summary": "Check if user is subscribed to an issue", - "operationId": "issueCheckSubscription", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "name": "index", - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the issue" - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "200": { - "$ref": "#/responses/WatchInfo" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/hooks": { - "get": { - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, - { - "in": "query", - "type": "integer", - "description": "page number of results to return (1-based)", - "name": "page" - }, - { - "type": "integer", - "description": "page size of results", - "name": "limit", - "in": "query" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "200": { - "$ref": "#/responses/HookList" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List the hooks in a repository", - "operationId": "repoListHooks" - }, - "post": { - "responses": { - "201": { - "$ref": "#/responses/Hook" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Create a hook", - "operationId": "repoCreateHook", - "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 - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/CreateHookOption" - } - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/actions/tasks": { - "get": { - "responses": { - "400": { - "$ref": "#/responses/error" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "409": { - "$ref": "#/responses/conflict" - }, - "422": { - "$ref": "#/responses/validationError" - }, - "200": { - "$ref": "#/responses/TasksList" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List a repository's action tasks", - "operationId": "ListActionTasks", - "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", - "description": "page number of results to return (1-based)", - "name": "page", - "in": "query" - }, - { - "type": "integer", - "description": "page size of results, default maximum page size is 50", - "name": "limit", - "in": "query" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/keys/{id}": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a repository's key by id", - "operationId": "repoGetKey", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "integer", - "format": "int64", - "description": "id of the key to get", - "name": "id", - "in": "path", - "required": true - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "200": { - "$ref": "#/responses/DeployKey" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "delete": { - "tags": [ - "repository" - ], - "summary": "Delete a key from a repository", - "operationId": "repoDeleteKey", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "description": "id of the key to delete", - "name": "id", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/actions/workflows": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List repository workflows", - "operationId": "ActionsListRepositoryWorkflows", - "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 - }, - { - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true - } - ], - "responses": { - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - }, - "500": { - "$ref": "#/responses/error" - }, - "200": { - "$ref": "#/responses/ActionWorkflowList" - }, - "400": { - "$ref": "#/responses/error" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}": { - "get": { - "summary": "Get an issue", - "operationId": "issueGetIssue", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "index", - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the issue to get" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/Issue" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ] - }, - "delete": { - "tags": [ - "issue" - ], - "summary": "Delete an issue", - "operationId": "issueDelete", - "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 - }, - { - "name": "index", - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "index of issue to delete" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, + "/repos/{owner}/group/{group_id}/{repo}/issues/comments/{id}": { "patch": { - "responses": { - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "412": { - "$ref": "#/responses/error" - }, - "201": { - "$ref": "#/responses/Issue" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], "tags": [ "issue" ], - "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.", - "operationId": "issueEditIssue", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "index", - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the issue to edit" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/EditIssueOption" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/compare/{basehead}": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get commit comparison information", - "operationId": "repoCompareDiff", - "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 - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "compare two branches or commits", - "name": "basehead" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "200": { - "$ref": "#/responses/Compare" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/wiki/pages": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get all wiki pages", - "operationId": "repoGetWikiPages", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "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" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/WikiPageList" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/subscriptions": { - "get": { + "summary": "Edit a comment", + "operationId": "issueEditComment", "parameters": [ { "description": "owner of the repo", @@ -5046,187 +3908,6 @@ "required": true, "type": "string" }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, - { - "type": "integer", - "format": "int64", - "description": "index of the issue", - "name": "index", - "in": "path", - "required": true - }, - { - "in": "query", - "type": "integer", - "description": "page number of results to return (1-based)", - "name": "page" - }, - { - "type": "integer", - "description": "page size of results", - "name": "limit", - "in": "query" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "200": { - "$ref": "#/responses/UserList" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Get users who subscribed on an issue.", - "operationId": "issueSubscriptions" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/actions/runs/{run}/artifacts": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Lists all artifacts for a repository run", - "operationId": "getArtifactsOfRun", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repository", - "name": "repo", - "in": "path", - "required": true - }, - { - "name": "run", - "in": "path", - "required": true, - "type": "integer", - "description": "runid of the workflow run" - }, - { - "description": "name of the artifact", - "name": "name", - "in": "query", - "type": "string" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "$ref": "#/responses/ArtifactsList" - }, - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/hooks/git/{id}": { - "get": { - "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 - }, - { - "required": true, - "type": "string", - "description": "id of the hook to get", - "name": "id", - "in": "path" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/GitHook" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a Git hook", - "operationId": "repoGetGitHook" - }, - "delete": { - "tags": [ - "repository" - ], - "summary": "Delete a Git hook in a repository", - "operationId": "repoDeleteGitHook", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, { "name": "repo", "in": "path", @@ -5235,11 +3916,19 @@ "description": "name of the repo" }, { - "required": true, - "type": "string", - "description": "id of the hook to get", + "type": "integer", + "format": "int64", + "description": "id of the comment to edit", "name": "id", - "in": "path" + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/EditIssueCommentOption" + } }, { "type": "integer", @@ -5251,147 +3940,41 @@ } ], "responses": { - "204": { - "$ref": "#/responses/empty" + "403": { + "$ref": "#/responses/forbidden" }, "404": { "$ref": "#/responses/notFound" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + }, + "200": { + "$ref": "#/responses/Comment" + }, + "204": { + "$ref": "#/responses/empty" } }, + "consumes": [ + "application/json" + ], "produces": [ "application/json" ] }, - "patch": { - "operationId": "repoEditGitHook", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "string", - "description": "id of the hook to get", - "name": "id", - "in": "path", - "required": true - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/EditGitHookOption" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/GitHook" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Edit a Git hook in a repository" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/activities/feeds": { "get": { - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "string", - "format": "date", - "description": "the date of the activities to be found", - "name": "date", - "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/ActivityFeedsList" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ + "consumes": [ "application/json" ], - "tags": [ - "repository" - ], - "summary": "List a repository's activity feeds", - "operationId": "repoListActivityFeeds" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/labels/{id}": { - "delete": { "produces": [ "application/json" ], "tags": [ "issue" ], - "summary": "Remove a label from an issue", - "operationId": "issueRemoveLabel", + "summary": "Get a comment", + "operationId": "issueGetComment", "parameters": [ { "type": "string", @@ -5401,22 +3984,14 @@ "required": true }, { + "required": true, "type": "string", "description": "name of the repo", "name": "repo", - "in": "path", - "required": true + "in": "path" }, { - "format": "int64", - "description": "index of the issue", - "name": "index", - "in": "path", - "required": true, - "type": "integer" - }, - { - "description": "id of the label to remove", + "description": "id of the comment", "name": "id", "in": "path", "required": true, @@ -5433,6 +4008,9 @@ } ], "responses": { + "200": { + "$ref": "#/responses/Comment" + }, "204": { "$ref": "#/responses/empty" }, @@ -5441,15 +4019,10 @@ }, "404": { "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" } } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/branch_protections/priority": { - "post": { + }, + "delete": { "parameters": [ { "description": "owner of the repo", @@ -5466,154 +4039,12 @@ "required": true }, { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/UpdateBranchProtectionPriories" - } - }, - { + "in": "path", + "required": true, "type": "integer", "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Update the priorities of branch protections for a repository.", - "operationId": "repoUpdateBranchProtectionPriories" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/times": { - "get": { - "operationId": "repoTrackedTimes", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "name": "user", - "in": "query", - "type": "string", - "description": "optional filter by user (available for issue managers)" - }, - { - "in": "query", - "type": "string", - "format": "date-time", - "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format", - "name": "since" - }, - { - "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format", - "name": "before", - "in": "query", - "type": "string", - "format": "date-time" - }, - { - "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" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/TrackedTimeList" - }, - "400": { - "$ref": "#/responses/error" - }, - "403": { - "$ref": "#/responses/forbidden" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List a repo's tracked times" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/hooks/git": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List the Git hooks in a repository", - "operationId": "repoListGitHooks", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true + "description": "id of comment to delete", + "name": "id" }, { "description": "group ID of the repo", @@ -5625,119 +4056,47 @@ } ], "responses": { - "200": { - "$ref": "#/responses/GitHookList" - }, "404": { "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/signing-key.gpg": { - "get": { - "summary": "Get signing-key.gpg for given repository", - "operationId": "repoSigningKey", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true + "204": { + "$ref": "#/responses/empty" }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "200": { - "description": "GPG armored public key", - "schema": { - "type": "string" - } + "403": { + "$ref": "#/responses/forbidden" } }, - "produces": [ - "text/plain" - ], "tags": [ - "repository" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/teams": { - "get": { - "tags": [ - "repository" + "issue" ], - "summary": "List a repository's teams", - "operationId": "repoListTeams", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/TeamList" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ] + "summary": "Delete a comment", + "operationId": "issueDeleteComment" } }, "/repos/{owner}/group/{group_id}/{repo}/actions/jobs/{job_id}": { "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Gets a specific workflow job for a workflow run", + "operationId": "getWorkflowJob", "parameters": [ { - "in": "path", - "required": true, "type": "string", "description": "owner of the repo", - "name": "owner" + "name": "owner", + "in": "path", + "required": true }, { + "required": true, + "type": "string", "description": "name of the repository", "name": "repo", - "in": "path", - "required": true, - "type": "string" + "in": "path" }, { "type": "string", @@ -5765,4412 +4124,45 @@ "404": { "$ref": "#/responses/notFound" } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Gets a specific workflow job for a workflow run", - "operationId": "getWorkflowJob" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/pulls/pinned": { - "get": { - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "$ref": "#/responses/PullRequestList" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List a repo's pinned pull requests", - "operationId": "repoListPinnedPullRequests" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/git/refs/{ref}": { - "get": { - "responses": { - "200": { - "$ref": "#/responses/ReferenceList" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get specified ref or filtered repository's refs", - "operationId": "repoListGitRefs", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "type": "string", - "description": "part or full name of the ref", - "name": "ref", - "in": "path", - "required": true - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/pin/{position}": { - "patch": { - "tags": [ - "issue" - ], - "summary": "Moves the Pin to the given Position", - "operationId": "moveIssuePin", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "description": "index of issue", - "name": "index", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "description": "the new position", - "name": "position", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/pulls/{base}/{head}": { - "get": { - "tags": [ - "repository" - ], - "summary": "Get a pull request by base and head", - "operationId": "repoGetPullRequestByBaseHead", - "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": "base of the pull request to get", - "name": "base", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "string", - "description": "head of the pull request to get", - "name": "head", - "in": "path", - "required": true - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "200": { - "$ref": "#/responses/PullRequest" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/lock": { - "put": { - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Lock an issue", - "operationId": "issueLockIssue", - "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 issue", - "name": "index", - "in": "path", - "required": true - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/LockIssueOption" - } - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ] - }, - "delete": { - "tags": [ - "issue" - ], - "summary": "Unlock an issue", - "operationId": "issueUnlockIssue", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the issue", - "name": "index", - "in": "path" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/actions/artifacts": { - "get": { - "summary": "Lists all artifacts for a repository", - "operationId": "getArtifacts", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repository", - "name": "repo" - }, - { - "type": "string", - "description": "name of the artifact", - "name": "name", - "in": "query" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/ArtifactsList" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/comments": { - "get": { - "tags": [ - "issue" - ], - "summary": "List all comments on an issue", - "operationId": "issueGetComments", - "parameters": [ - { - "required": true, - "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 issue", - "name": "index", - "in": "path" - }, - { - "type": "string", - "format": "date-time", - "description": "if provided, only comments updated since the specified time are returned.", - "name": "since", - "in": "query" - }, - { - "name": "before", - "in": "query", - "type": "string", - "format": "date-time", - "description": "if provided, only comments updated before the provided time are returned." - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/CommentList" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ] - }, - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Add a comment to an issue", - "operationId": "issueCreateComment", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "name": "index", - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the issue" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/CreateIssueCommentOption" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - }, - "201": { - "$ref": "#/responses/Comment" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/pinned": { - "get": { - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "$ref": "#/responses/IssueList" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List a repo's pinned issues", - "operationId": "repoListPinnedIssues" - } - }, - "/repos/{owner}/group/{group_id}/{repo}": { - "get": { - "operationId": "repoGet", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "200": { - "$ref": "#/responses/Repository" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a repository" - }, - "delete": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Delete a repository", - "operationId": "repoDelete", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo to delete", - "name": "owner" - }, - { - "type": "string", - "description": "name of the repo to delete", - "name": "repo", - "in": "path", - "required": true - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "patch": { - "parameters": [ - { - "type": "string", - "description": "owner of the repo to edit", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo to edit" - }, - { - "schema": { - "$ref": "#/definitions/EditRepoOption" - }, - "description": "Properties of a repo that you can edit", - "name": "body", - "in": "body" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "200": { - "$ref": "#/responses/Repository" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Edit a repository's properties. Only fields that are set will be changed.", - "operationId": "repoEdit" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/times": { - "get": { - "tags": [ - "issue" - ], - "summary": "List an issue's tracked times", - "operationId": "issueTrackedTimes", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "format": "int64", - "description": "index of the issue", - "name": "index", - "in": "path", - "required": true, - "type": "integer" - }, - { - "name": "user", - "in": "query", - "type": "string", - "description": "optional filter by user (available for issue managers)" - }, - { - "name": "since", - "in": "query", - "type": "string", - "format": "date-time", - "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format" - }, - { - "format": "date-time", - "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format", - "name": "before", - "in": "query", - "type": "string" - }, - { - "type": "integer", - "description": "page number of results to return (1-based)", - "name": "page", - "in": "query" - }, - { - "description": "page size of results", - "name": "limit", - "in": "query", - "type": "integer" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/TrackedTimeList" - } - }, - "produces": [ - "application/json" - ] - }, - "post": { - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Add tracked time to a issue", - "operationId": "issueAddTime", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "format": "int64", - "description": "index of the issue", - "name": "index", - "in": "path", - "required": true, - "type": "integer" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/AddTimeOption" - } - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "200": { - "$ref": "#/responses/TrackedTime" - }, - "400": { - "$ref": "#/responses/error" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ] - }, - "delete": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Reset a tracked time of an issue", - "operationId": "issueResetTime", - "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": "index of the issue to add tracked time to", - "name": "index", - "in": "path", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "400": { - "$ref": "#/responses/error" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "204": { - "$ref": "#/responses/empty" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/releases": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List a repo's releases", - "operationId": "repoListReleases", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "in": "query", - "type": "boolean", - "description": "filter (exclude / include) drafts, if you dont have repo write access none will show", - "name": "draft" - }, - { - "in": "query", - "type": "boolean", - "description": "filter (exclude / include) pre-releases", - "name": "pre-release" - }, - { - "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/ReleaseList" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "post": { - "summary": "Create a release", - "operationId": "repoCreateRelease", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/CreateReleaseOption" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "201": { - "$ref": "#/responses/Release" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "409": { - "$ref": "#/responses/error" - }, - "422": { - "$ref": "#/responses/validationError" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/commits": { - "get": { - "summary": "Get a list of all commits from a repository", - "operationId": "repoGetAllCommits", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "type": "string", - "description": "SHA or branch to start listing commits from (usually 'master')", - "name": "sha", - "in": "query" - }, - { - "type": "string", - "description": "filepath of a file/dir", - "name": "path", - "in": "query" - }, - { - "type": "string", - "format": "date-time", - "description": "Only commits after this date will be returned (ISO 8601 format)", - "name": "since", - "in": "query" - }, - { - "type": "string", - "format": "date-time", - "description": "Only commits before this date will be returned (ISO 8601 format)", - "name": "until", - "in": "query" - }, - { - "in": "query", - "type": "boolean", - "description": "include diff stats for every commit (disable for speedup, default 'true')", - "name": "stat" - }, - { - "type": "boolean", - "description": "include verification for every commit (disable for speedup, default 'true')", - "name": "verification", - "in": "query" - }, - { - "in": "query", - "type": "boolean", - "description": "include a list of affected files for every commit (disable for speedup, default 'true')", - "name": "files" - }, - { - "type": "integer", - "description": "page number of results to return (1-based)", - "name": "page", - "in": "query" - }, - { - "description": "page size of results (ignored if used with 'path')", - "name": "limit", - "in": "query", - "type": "integer" - }, - { - "type": "string", - "description": "commits that match the given specifier will not be listed.", - "name": "not", - "in": "query" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/CommitList" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "409": { - "$ref": "#/responses/EmptyRepository" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/git/blobs/{sha}": { - "get": { - "tags": [ - "repository" - ], - "summary": "Gets the blob of a repository.", - "operationId": "GetBlob", - "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 - }, - { - "required": true, - "type": "string", - "description": "sha of the commit", - "name": "sha", - "in": "path" - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "200": { - "$ref": "#/responses/GitBlobResponse" - }, - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/milestones": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Get all of a repository's opened milestones", - "operationId": "issueGetMilestonesList", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "description": "Milestone state, Recognized values are open, closed and all. Defaults to \"open\"", - "name": "state", - "in": "query", - "type": "string" - }, - { - "type": "string", - "description": "filter by milestone name", - "name": "name", - "in": "query" - }, - { - "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" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "200": { - "$ref": "#/responses/MilestoneList" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "post": { - "responses": { - "201": { - "$ref": "#/responses/Milestone" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Create a milestone", - "operationId": "issueCreateMilestone", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/CreateMilestoneOption" - } - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/milestones/{id}": { - "get": { - "responses": { - "200": { - "$ref": "#/responses/Milestone" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Get a milestone", - "operationId": "issueGetMilestone", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "the milestone to get, identified by ID and if not available by name", - "name": "id" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ] - }, - "delete": { - "tags": [ - "issue" - ], - "summary": "Delete a milestone", - "operationId": "issueDeleteMilestone", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "the milestone to delete, identified by ID and if not available by name", - "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" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "patch": { - "responses": { - "200": { - "$ref": "#/responses/Milestone" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Update a milestone", - "operationId": "issueEditMilestone", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "the milestone to edit, identified by ID and if not available by name", - "name": "id", - "in": "path", - "required": true - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/EditMilestoneOption" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/contents": { - "get": { - "operationId": "repoGetContentsList", - "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": "The name of the commit/branch/tag. Default to the repository’s default branch.", - "name": "ref", - "in": "query" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/ContentsListResponse" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "description": "This API follows GitHub's design, and it is not easy to use. Recommend users to use our \"contents-ext\" API instead.", - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Gets the metadata of all the entries of the root dir." - }, - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Modify multiple files in a repository", - "operationId": "repoChangeFiles", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ChangeFilesOptions" - } - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "201": { - "$ref": "#/responses/FilesResponse" - }, - "403": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/error" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/branch_protections": { - "get": { - "responses": { - "200": { - "$ref": "#/responses/BranchProtectionList" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List branch protections for a repository", - "operationId": "repoListBranchProtection", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "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" - } - ] - }, - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Create a branch protections for a repository", - "operationId": "repoCreateBranchProtection", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "in": "body", - "schema": { - "$ref": "#/definitions/CreateBranchProtectionOption" - }, - "name": "body" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - }, - "201": { - "$ref": "#/responses/BranchProtection" - }, - "403": { - "$ref": "#/responses/forbidden" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/commits": { - "get": { - "tags": [ - "repository" - ], - "summary": "Get commits for a pull request", - "operationId": "repoGetPullRequestCommits", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the pull request to get", - "name": "index", - "in": "path" - }, - { - "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" - }, - { - "type": "boolean", - "description": "include verification for every commit (disable for speedup, default 'true')", - "name": "verification", - "in": "query" - }, - { - "description": "include a list of affected files for every commit (disable for speedup, default 'true')", - "name": "files", - "in": "query", - "type": "boolean" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/CommitList" - } - }, - "produces": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/hooks/{id}/tests": { - "post": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Test a push webhook", - "operationId": "repoTestHook", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "id of the hook to test", - "name": "id" - }, - { - "description": "The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload.", - "name": "ref", - "in": "query", - "type": "string" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/comments/{id}": { - "delete": { - "operationId": "issueDeleteComment", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, - { - "required": true, - "type": "integer", - "format": "int64", - "description": "id of comment to delete", - "name": "id", - "in": "path" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "tags": [ - "issue" - ], - "summary": "Delete a comment" - }, - "patch": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Edit a comment", - "operationId": "issueEditComment", - "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": "id of the comment to edit", - "name": "id", - "in": "path", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/EditIssueCommentOption" - } - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "200": { - "$ref": "#/responses/Comment" - }, - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - } - } - }, - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Get a comment", - "operationId": "issueGetComment", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "id of the comment", - "name": "id" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "200": { - "$ref": "#/responses/Comment" - }, - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/comments/{id}": { - "delete": { - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "integer", - "description": "this parameter is ignored", - "name": "index", - "in": "path", - "required": true - }, - { - "description": "id of comment to delete", - "name": "id", - "in": "path", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "tags": [ - "issue" - ], - "summary": "Delete a comment", - "operationId": "issueDeleteCommentDeprecated", - "deprecated": true - }, - "patch": { - "summary": "Edit a comment", - "operationId": "issueEditCommentDeprecated", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "type": "integer", - "description": "this parameter is ignored", - "name": "index", - "in": "path", - "required": true - }, - { - "format": "int64", - "description": "id of the comment to edit", - "name": "id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/EditIssueCommentOption" - } - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/Comment" - }, - "204": { - "$ref": "#/responses/empty" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "deprecated": true - } - }, - "/repos/{owner}/group/{group_id}/{repo}/editorconfig/{filepath}": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get the EditorConfig definitions of a file in a repository", - "operationId": "repoGetEditorConfig", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "string", - "description": "filepath of file to get", - "name": "filepath", - "in": "path", - "required": true - }, - { - "name": "ref", - "in": "query", - "type": "string", - "description": "The name of the commit/branch/tag. Default to the repository’s default branch." - }, - { - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "description": "success" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/times/{user}": { - "get": { - "summary": "List a user's tracked times in a repo", - "operationId": "userTrackedTimes", - "deprecated": true, - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "username of the user whose tracked times are to be listed", - "name": "user", - "in": "path", - "required": true - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/TrackedTimeList" - }, - "400": { - "$ref": "#/responses/error" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/transfer/reject": { - "post": { - "tags": [ - "repository" - ], - "summary": "Reject a repo transfer", - "operationId": "rejectRepoTransfer", - "parameters": [ - { - "type": "string", - "description": "owner of the repo to transfer", - "name": "owner", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "name of the repo to transfer", - "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/Repository" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/actions/runners": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get repo-level runners", - "operationId": "getRepoRunners", - "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", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "200": { - "$ref": "#/definitions/ActionRunnersResponse" - }, - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/stopwatch/stop": { - "post": { - "responses": { - "201": { - "$ref": "#/responses/empty" - }, - "403": { - "description": "Not repo writer, user does not have rights to toggle stopwatch" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "409": { - "description": "Cannot stop a non-existent stopwatch" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Stop an issue's existing stopwatch.", - "operationId": "issueStopStopWatch", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the issue to stop the stopwatch on", - "name": "index", - "in": "path" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/actions/workflows/{workflow_id}": { - "get": { - "tags": [ - "repository" - ], - "summary": "Get a workflow", - "operationId": "ActionsGetWorkflow", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, - { - "type": "string", - "description": "id of the workflow", - "name": "workflow_id", - "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/ActionWorkflow" - }, - "400": { - "$ref": "#/responses/error" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - }, - "500": { - "$ref": "#/responses/error" - } - }, - "produces": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/branch_protections/{name}": { - "patch": { - "responses": { - "200": { - "$ref": "#/responses/BranchProtection" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Edit a branch protections for a repository. Only fields that are set will be changed", - "operationId": "repoEditBranchProtection", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "name": "name", - "in": "path", - "required": true, - "type": "string", - "description": "name of protected branch" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/EditBranchProtectionOption" - } - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ] - }, - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a specific branch protection for the repository", - "operationId": "repoGetBranchProtection", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "name": "name", - "in": "path", - "required": true, - "type": "string", - "description": "name of protected branch" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/BranchProtection" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "delete": { - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Delete a specific branch protection for the repository", - "operationId": "repoDeleteBranchProtection", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "name of protected branch", - "name": "name", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/dependencies": { - "post": { - "tags": [ - "issue" - ], - "summary": "Make the issue in the url depend on the issue in the form.", - "operationId": "issueCreateIssueDependencies", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "description": "index of the issue", - "name": "index", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/IssueMeta" - } - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "201": { - "$ref": "#/responses/Issue" - }, - "404": { - "description": "the issue does not exist" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - } - }, - "produces": [ - "application/json" - ] - }, - "delete": { - "summary": "Remove an issue dependency", - "operationId": "issueRemoveIssueDependencies", - "parameters": [ - { - "in": "path", - "required": true, - "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": "index of the issue", - "name": "index" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/IssueMeta" - } - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "200": { - "$ref": "#/responses/Issue" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ] - }, - "get": { - "summary": "List an issue's dependencies, i.e all issues that block this issue.", - "operationId": "issueListIssueDependencies", - "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": "index of the issue", - "name": "index", - "in": "path", - "required": true - }, - { - "type": "integer", - "description": "page number of results to return (1-based)", - "name": "page", - "in": "query" - }, - { - "name": "limit", - "in": "query", - "type": "integer", - "description": "page size of results" - }, - { - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true - } - ], - "responses": { - "200": { - "$ref": "#/responses/IssueList" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/releases/{id}": { - "delete": { - "responses": { - "422": { - "$ref": "#/responses/validationError" - }, - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "tags": [ - "repository" - ], - "summary": "Delete a release", - "operationId": "repoDeleteRelease", - "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 - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "id of the release to delete" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ] - }, - "patch": { - "operationId": "repoEditRelease", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "format": "int64", - "description": "id of the release to edit", - "name": "id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/EditReleaseOption" - } - }, - { - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true - } - ], - "responses": { - "200": { - "$ref": "#/responses/Release" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Update a release" - }, - "get": { - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "type": "integer", - "format": "int64", - "description": "id of the release to get", - "name": "id", - "in": "path", - "required": true - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "$ref": "#/responses/Release" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a release", - "operationId": "repoGetRelease" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/releases/tags/{tag}": { - "get": { - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, - { - "required": true, - "type": "string", - "description": "tag name of the release to get", - "name": "tag", - "in": "path" - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "200": { - "$ref": "#/responses/Release" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a release by tag name", - "operationId": "repoGetReleaseByTag" - }, - "delete": { - "tags": [ - "repository" - ], - "summary": "Delete a release by tag name", - "operationId": "repoDeleteReleaseByTag", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "type": "string", - "description": "tag name of the release to delete", - "name": "tag", - "in": "path", - "required": true - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "422": { - "$ref": "#/responses/validationError" - }, - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/push_mirrors-sync": { - "post": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Sync all push mirrored repository", - "operationId": "repoPushMirrorSync", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo to sync", - "name": "owner" - }, - { - "required": true, - "type": "string", - "description": "name of the repo to sync", - "name": "repo", - "in": "path" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "200": { - "$ref": "#/responses/empty" - }, - "400": { - "$ref": "#/responses/error" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/assignees": { - "get": { - "responses": { - "200": { - "$ref": "#/responses/UserList" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Return all users that have write access and can be assigned to issues", - "operationId": "repoGetAssignees", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/commits/{ref}/status": { - "get": { - "responses": { - "200": { - "$ref": "#/responses/CombinedStatus" - }, - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a commit's combined status, by branch/tag/commit reference", - "operationId": "repoGetCombinedStatusByRef", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "type": "string", - "description": "name of branch/tag/commit", - "name": "ref", - "in": "path", - "required": true - }, - { - "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" - } - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/raw/{filepath}": { - "get": { - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "type": "string", - "description": "path of the file to get, it should be \"{ref}/{filepath}\". If there is no ref could be inferred, it will be treated as the default branch", - "name": "filepath", - "in": "path", - "required": true - }, - { - "description": "The name of the commit/branch/tag. Default to the repository’s default branch", - "name": "ref", - "in": "query", - "type": "string" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "description": "Returns raw file content.", - "schema": { - "type": "file" - } - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/octet-stream" - ], - "tags": [ - "repository" - ], - "summary": "Get a file from a repository", - "operationId": "repoGetRawFile" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/signing-key.pub": { - "get": { - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "200": { - "description": "ssh public key", - "schema": { - "type": "string" - } - } - }, - "produces": [ - "text/plain" - ], - "tags": [ - "repository" - ], - "summary": "Get signing-key.pub for given repository", - "operationId": "repoSigningKeySSH" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/labels": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Get all of a repository's labels", - "operationId": "issueListLabels", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, - { - "in": "query", - "type": "integer", - "description": "page number of results to return (1-based)", - "name": "page" - }, - { - "type": "integer", - "description": "page size of results", - "name": "limit", - "in": "query" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/LabelList" - } - } - }, - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Create a label", - "operationId": "issueCreateLabel", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/CreateLabelOption" - } - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "201": { - "$ref": "#/responses/Label" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/blocks": { - "post": { - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Block the issue given in the body by the issue in path", - "operationId": "issueCreateIssueBlocking", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "index", - "in": "path", - "required": true, - "type": "string", - "description": "index of the issue" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/IssueMeta" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "201": { - "$ref": "#/responses/Issue" - }, - "404": { - "description": "the issue does not exist" - } - } - }, - "delete": { - "summary": "Unblock the issue given in the body by the issue in path", - "operationId": "issueRemoveIssueBlocking", - "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": "index of the issue", - "name": "index", - "in": "path", - "required": true - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/IssueMeta" - } - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "$ref": "#/responses/Issue" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ] - }, - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "List issues that are blocked by this issue", - "operationId": "issueListBlocks", - "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": "index of the issue", - "name": "index", - "in": "path", - "required": true - }, - { - "name": "page", - "in": "query", - "type": "integer", - "description": "page number of results to return (1-based)" - }, - { - "name": "limit", - "in": "query", - "type": "integer", - "description": "page size of results" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/IssueList" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/releases/{id}/assets/{attachment_id}": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a release attachment", - "operationId": "repoGetReleaseAttachment", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "description": "id of the release", - "name": "id", - "in": "path", - "required": true - }, - { - "format": "int64", - "description": "id of the attachment to get", - "name": "attachment_id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "200": { - "$ref": "#/responses/Attachment" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "delete": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Delete a release attachment", - "operationId": "repoDeleteReleaseAttachment", - "parameters": [ - { - "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" - }, - { - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "id of the release", - "name": "id" - }, - { - "required": true, - "type": "integer", - "format": "int64", - "description": "id of the attachment to delete", - "name": "attachment_id", - "in": "path" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "patch": { - "summary": "Edit a release attachment", - "operationId": "repoEditReleaseAttachment", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "format": "int64", - "description": "id of the release", - "name": "id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "id of the attachment to edit", - "name": "attachment_id" - }, - { - "in": "body", - "schema": { - "$ref": "#/definitions/EditAttachmentOptions" - }, - "name": "body" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "201": { - "$ref": "#/responses/Attachment" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/actions/jobs": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Lists all jobs for a repository", - "operationId": "listWorkflowJobs", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "required": true, - "type": "string", - "description": "name of the repository", - "name": "repo", - "in": "path" - }, - { - "type": "string", - "description": "workflow status (pending, queued, in_progress, failure, success, skipped)", - "name": "status", - "in": "query" - }, - { - "description": "page number of results to return (1-based)", - "name": "page", - "in": "query", - "type": "integer" - }, - { - "type": "integer", - "description": "page size of results", - "name": "limit", - "in": "query" - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/WorkflowJobsList" - }, - "400": { - "$ref": "#/responses/error" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/actions/artifacts/{artifact_id}/zip": { - "get": { - "summary": "Downloads a specific artifact for a workflow run redirects to blob url", - "operationId": "downloadArtifact", - "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 - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "id of the artifact", - "name": "artifact_id" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "302": { - "description": "redirect to the blob download" - }, - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/reviewers": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Return all users that can be requested to review in this repo", - "operationId": "repoGetReviewers", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "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/UserList" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/merge": { - "get": { - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "format": "int64", - "description": "index of the pull request", - "name": "index", - "in": "path", - "required": true, - "type": "integer" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "204": { - "description": "pull request has been merged" - }, - "404": { - "description": "pull request has not been merged" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Check if a pull request has been merged", - "operationId": "repoPullRequestIsMerged" - }, - "post": { - "operationId": "repoMergePullRequest", - "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 - }, - { - "name": "index", - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the pull request to merge" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/MergePullRequestOption" - } - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "200": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "405": { - "$ref": "#/responses/empty" - }, - "409": { - "$ref": "#/responses/error" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Merge a pull request" - }, - "delete": { - "tags": [ - "repository" - ], - "summary": "Cancel the scheduled auto merge for the given pull request", - "operationId": "repoCancelScheduledAutoMerge", - "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 - }, - { - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the pull request to merge", - "name": "index" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - } - }, - "produces": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/labels": { - "delete": { - "tags": [ - "issue" - ], - "summary": "Remove all labels from an issue", - "operationId": "issueClearLabels", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the issue", - "name": "index", - "in": "path" - }, - { - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ] - }, - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Get an issue's labels", - "operationId": "issueGetLabels", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the issue", - "name": "index" - }, - { - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/LabelList" - } - } - }, - "put": { - "responses": { - "200": { - "$ref": "#/responses/LabelList" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Replace an issue's labels", - "operationId": "issueReplaceLabels", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, - { - "description": "index of the issue", - "name": "index", - "in": "path", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/IssueLabelsOption" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ] - }, - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Add a label to an issue", - "operationId": "issueAddLabel", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "format": "int64", - "description": "index of the issue", - "name": "index", - "in": "path", - "required": true, - "type": "integer" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/IssueLabelsOption" - } - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "200": { - "$ref": "#/responses/LabelList" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } } } }, "/repos/{owner}/group/{group_id}/{repo}/releases/{id}/assets": { "get": { + "summary": "List release's attachments", + "operationId": "repoListReleaseAttachments", + "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 + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "id of the release" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], "responses": { "200": { "$ref": "#/responses/AttachmentList" @@ -10184,40 +4176,6 @@ ], "tags": [ "repository" - ], - "summary": "List release's attachments", - "operationId": "repoListReleaseAttachments", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "format": "int64", - "description": "id of the release", - "name": "id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } ] }, "post": { @@ -10232,25 +4190,25 @@ "required": true }, { - "in": "path", - "required": true, "type": "string", "description": "name of the repo", - "name": "repo" + "name": "repo", + "in": "path", + "required": true }, { + "type": "integer", + "format": "int64", "description": "id of the release", "name": "id", "in": "path", - "required": true, - "type": "integer", - "format": "int64" + "required": true }, { - "in": "query", - "type": "string", "description": "name of the attachment", - "name": "name" + "name": "name", + "in": "query", + "type": "string" }, { "type": "file", @@ -10259,12 +4217,12 @@ "in": "formData" }, { - "type": "integer", - "format": "int64", - "required": true, "in": "path", "description": "group ID of the repo", - "name": "group_id" + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true } ], "responses": { @@ -10293,107 +4251,42 @@ ] } }, - "/repos/{owner}/group/{group_id}/{repo}/transfer": { - "post": { - "parameters": [ - { - "description": "owner of the repo to transfer", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "string", - "description": "name of the repo to transfer", - "name": "repo", - "in": "path", - "required": true - }, - { - "description": "Transfer Options", - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TransferRepoOption" - } - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - }, - "202": { - "$ref": "#/responses/Repository" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Transfer a repo ownership", - "operationId": "repoTransfer" - } - }, "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/update": { "post": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], "summary": "Merge PR's baseBranch into headBranch", "operationId": "repoUpdatePullRequest", "parameters": [ { - "in": "path", - "required": true, "type": "string", "description": "owner of the repo", - "name": "owner" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", + "name": "owner", "in": "path", "required": true }, { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "integer", + "format": "int64", "description": "index of the pull request to get", "name": "index", "in": "path", - "required": true, - "type": "integer", - "format": "int64" + "required": true }, { - "description": "how to update pull request", - "name": "style", - "in": "query", "enum": [ "merge", "rebase" ], - "type": "string" + "type": "string", + "description": "how to update pull request", + "name": "style", + "in": "query" }, { "format": "int64", @@ -10405,12 +4298,6 @@ } ], "responses": { - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, "409": { "$ref": "#/responses/error" }, @@ -10419,96 +4306,166 @@ }, "200": { "$ref": "#/responses/empty" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/comments/{id}/assets": { - "get": { - "operationId": "issueListIssueCommentAttachments", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" + "403": { + "$ref": "#/responses/forbidden" }, - { - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "id of the comment", - "name": "id" - }, - { - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true - } - ], - "responses": { "404": { - "$ref": "#/responses/error" - }, - "200": { - "$ref": "#/responses/AttachmentList" + "$ref": "#/responses/notFound" } }, "produces": [ "application/json" ], + "tags": [ + "repository" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/comments/{id}": { + "delete": { + "operationId": "issueDeleteCommentDeprecated", + "deprecated": true, + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "integer", + "description": "this parameter is ignored", + "name": "index", + "in": "path", + "required": true + }, + { + "required": true, + "type": "integer", + "format": "int64", + "description": "id of comment to delete", + "name": "id", + "in": "path" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, "tags": [ "issue" ], - "summary": "List comment's attachments" + "summary": "Delete a comment" }, - "post": { + "patch": { + "operationId": "issueEditCommentDeprecated", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "integer", + "description": "this parameter is ignored", + "name": "index", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "id of the comment to edit", + "name": "id" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/EditIssueCommentOption" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "produces": [ + "application/json" + ], + "summary": "Edit a comment", + "deprecated": true, "responses": { "404": { - "$ref": "#/responses/error" + "$ref": "#/responses/notFound" }, - "413": { - "$ref": "#/responses/error" + "200": { + "$ref": "#/responses/Comment" }, - "422": { - "$ref": "#/responses/validationError" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - }, - "201": { - "$ref": "#/responses/Attachment" - }, - "400": { - "$ref": "#/responses/error" + "204": { + "$ref": "#/responses/empty" }, "403": { "$ref": "#/responses/forbidden" } }, "consumes": [ - "multipart/form-data" + "application/json" ], + "tags": [ + "issue" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/comments/{id}/assets/{attachment_id}": { + "get": { "produces": [ "application/json" ], "tags": [ "issue" ], - "summary": "Create a comment attachment", - "operationId": "issueCreateIssueCommentAttachment", + "summary": "Get a comment attachment", + "operationId": "issueGetIssueCommentAttachment", "parameters": [ { "type": "string", @@ -10518,111 +4475,113 @@ "required": true }, { - "required": true, "type": "string", "description": "name of the repo", "name": "repo", - "in": "path" + "in": "path", + "required": true }, { - "required": true, "type": "integer", "format": "int64", "description": "id of the comment", "name": "id", - "in": "path" - }, - { - "type": "string", - "description": "name of the attachment", - "name": "name", - "in": "query" - }, - { - "required": true, - "type": "file", - "description": "attachment to upload", - "name": "attachment", - "in": "formData" + "in": "path", + "required": true }, { "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "id of the attachment to get", + "name": "attachment_id" + }, + { "description": "group ID of the repo", "name": "group_id", "type": "integer", "format": "int64", - "required": true - } - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/file-contents": { - "get": { - "description": "See the POST method. This GET method supports using JSON encoded request body in query parameter.", - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get the metadata and contents of requested files", - "operationId": "repoGetFileContents", - "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": "The name of the commit/branch/tag. Default to the repository’s default branch.", - "name": "ref", - "in": "query" - }, - { - "in": "query", "required": true, - "type": "string", - "description": "The JSON encoded body (see the POST request): {\"files\": [\"filename1\", \"filename2\"]}", - "name": "body" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" + "in": "path" } ], "responses": { "200": { - "$ref": "#/responses/ContentsListResponse" + "$ref": "#/responses/Attachment" }, "404": { - "$ref": "#/responses/notFound" + "$ref": "#/responses/error" } } }, - "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`.", + "delete": { + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "integer", + "format": "int64", + "description": "id of the comment", + "name": "id", + "in": "path", + "required": true + }, + { + "format": "int64", + "description": "id of the attachment to delete", + "name": "attachment_id", + "in": "path", + "required": true, + "type": "integer" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/error" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + }, "produces": [ "application/json" ], "tags": [ - "repository" + "issue" ], - "summary": "Get the metadata and contents of requested files", - "operationId": "repoGetFileContentsPost", + "summary": "Delete a comment attachment", + "operationId": "issueDeleteIssueCommentAttachment" + }, + "patch": { + "tags": [ + "issue" + ], + "summary": "Edit a comment attachment", + "operationId": "issueEditIssueCommentAttachment", "parameters": [ { "description": "owner of the repo", @@ -10639,19 +4598,116 @@ "required": true }, { - "type": "string", - "description": "The name of the commit/branch/tag. Default to the repository’s default branch.", - "name": "ref", - "in": "query" + "type": "integer", + "format": "int64", + "description": "id of the comment", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "description": "id of the attachment to edit", + "name": "attachment_id", + "in": "path", + "required": true }, { "name": "body", "in": "body", - "required": true, "schema": { - "$ref": "#/definitions/GetFilesOptions" + "$ref": "#/definitions/EditAttachmentOptions" } }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "201": { + "$ref": "#/responses/Attachment" + }, + "404": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/subscriptions/{user}": { + "put": { + "responses": { + "200": { + "description": "Already subscribed" + }, + "201": { + "description": "Successfully Subscribed" + }, + "304": { + "description": "User can only subscribe itself if he is no admin" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Subscribe user to issue", + "operationId": "issueAddSubscription", + "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": "index of the issue", + "name": "index", + "in": "path", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "required": true, + "type": "string", + "description": "username of the user to subscribe the issue to", + "name": "user", + "in": "path" + }, { "required": true, "in": "path", @@ -10660,136 +4716,25 @@ "type": "integer", "format": "int64" } - ], + ] + }, + "delete": { "responses": { + "304": { + "description": "User can only subscribe itself if he is no admin" + }, "404": { "$ref": "#/responses/notFound" }, "200": { - "$ref": "#/responses/ContentsListResponse" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/deadline": { - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.", - "operationId": "issueEditIssueDeadline", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" + "description": "Already unsubscribed" }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "description": "index of the issue to create or update a deadline on", - "name": "index", - "in": "path", - "required": true - }, - { - "schema": { - "$ref": "#/definitions/EditDeadlineOption" - }, - "name": "body", - "in": "body" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { "201": { - "$ref": "#/responses/IssueDeadline" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/assets": { - "get": { - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "description": "index of the issue", - "name": "index", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "200": { - "$ref": "#/responses/AttachmentList" - }, - "404": { - "$ref": "#/responses/error" + "description": "Successfully Unsubscribed" } }, - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "List issue's attachments", - "operationId": "issueListIssueAttachments" - }, - "post": { "consumes": [ - "multipart/form-data" + "application/json" ], "produces": [ "application/json" @@ -10797,85 +4742,8 @@ "tags": [ "issue" ], - "summary": "Create an issue attachment", - "operationId": "issueCreateIssueAttachment", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, - { - "format": "int64", - "description": "index of the issue", - "name": "index", - "in": "path", - "required": true, - "type": "integer" - }, - { - "description": "name of the attachment", - "name": "name", - "in": "query", - "type": "string" - }, - { - "name": "attachment", - "in": "formData", - "required": true, - "type": "file", - "description": "attachment to upload" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/error" - }, - "413": { - "$ref": "#/responses/error" - }, - "422": { - "$ref": "#/responses/validationError" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - }, - "201": { - "$ref": "#/responses/Attachment" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/forks": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List a repository's forks", - "operationId": "listForks", + "summary": "Unsubscribe user from issue", + "operationId": "issueDeleteSubscription", "parameters": [ { "name": "owner", @@ -10885,11 +4753,62 @@ "description": "owner of the repo" }, { - "required": true, "type": "string", "description": "name of the repo", "name": "repo", - "in": "path" + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "description": "index of the issue", + "name": "index", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "username of the user to unsubscribe from an issue", + "name": "user" + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/commits": { + "get": { + "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 + }, + { + "format": "int64", + "description": "index of the pull request to get", + "name": "index", + "in": "path", + "required": true, + "type": "integer" }, { "type": "integer", @@ -10904,74 +4823,96 @@ "in": "query" }, { + "description": "include verification for every commit (disable for speedup, default 'true')", + "name": "verification", + "in": "query", + "type": "boolean" + }, + { + "name": "files", + "in": "query", + "type": "boolean", + "description": "include a list of affected files for every commit (disable for speedup, default 'true')" + }, + { + "name": "group_id", "type": "integer", "format": "int64", "required": true, "in": "path", - "description": "group ID of the repo", - "name": "group_id" + "description": "group ID of the repo" } ], "responses": { "200": { - "$ref": "#/responses/RepositoryList" + "$ref": "#/responses/CommitList" }, "404": { "$ref": "#/responses/notFound" } - } - }, + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get commits for a pull request", + "operationId": "repoGetPullRequestCommits" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/branch_protections/priority": { "post": { - "summary": "Fork a repository", - "operationId": "createFork", + "summary": "Update the priorities of branch protections for a repository.", + "operationId": "repoUpdateBranchProtectionPriories", "parameters": [ { - "description": "owner of the repo to fork", + "required": true, + "type": "string", + "description": "owner of the repo", "name": "owner", + "in": "path" + }, + { + "description": "name of the repo", + "name": "repo", "in": "path", "required": true, "type": "string" }, { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo to fork" - }, - { + "in": "body", "schema": { - "$ref": "#/definitions/CreateForkOption" + "$ref": "#/definitions/UpdateBranchProtectionPriories" }, - "name": "body", - "in": "body" + "name": "body" }, { - "required": true, - "in": "path", "description": "group ID of the repo", "name": "group_id", "type": "integer", - "format": "int64" + "format": "int64", + "required": true, + "in": "path" } ], "responses": { - "403": { - "$ref": "#/responses/forbidden" + "204": { + "$ref": "#/responses/empty" }, "404": { "$ref": "#/responses/notFound" }, - "409": { - "description": "The repository with the same name already exists." - }, "422": { "$ref": "#/responses/validationError" }, - "202": { - "$ref": "#/responses/Repository" + "423": { + "$ref": "#/responses/repoArchivedError" } }, + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -10982,14 +4923,18 @@ }, "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/files": { "get": { + "tags": [ + "repository" + ], + "summary": "Get changed files for a pull request", "operationId": "repoGetPullRequestFiles", "parameters": [ { - "type": "string", "description": "owner of the repo", "name": "owner", "in": "path", - "required": true + "required": true, + "type": "string" }, { "type": "string", @@ -10999,12 +4944,12 @@ "required": true }, { - "type": "integer", - "format": "int64", - "description": "index of the pull request to get", "name": "index", "in": "path", - "required": true + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the pull request to get" }, { "type": "string", @@ -11031,18 +4976,18 @@ "in": "query" }, { + "type": "integer", "description": "page size of results", "name": "limit", - "in": "query", - "type": "integer" + "in": "query" }, { - "name": "group_id", - "type": "integer", "format": "int64", "required": true, "in": "path", - "description": "group ID of the repo" + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" } ], "responses": { @@ -11053,22 +4998,436 @@ "$ref": "#/responses/notFound" } }, + "produces": [ + "application/json" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/pulls/{base}/{head}": { + "get": { + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "name": "repo", + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo" + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "base of the pull request to get", + "name": "base" + }, + { + "type": "string", + "description": "head of the pull request to get", + "name": "head", + "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/PullRequest" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, "produces": [ "application/json" ], "tags": [ "repository" ], - "summary": "Get changed files for a pull request" + "summary": "Get a pull request by base and head", + "operationId": "repoGetPullRequestByBaseHead" } }, - "/repos/{owner}/group/{group_id}/{repo}/issues/comments": { - "get": { + "/repos/{owner}/group/{group_id}/{repo}/transfer": { + "post": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Transfer a repo ownership", + "operationId": "repoTransfer", + "parameters": [ + { + "type": "string", + "description": "owner of the repo to transfer", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo to transfer", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "description": "Transfer Options", + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TransferRepoOption" + } + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "422": { + "$ref": "#/responses/validationError" + }, + "202": { + "$ref": "#/responses/Repository" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/labels": { + "delete": { + "responses": { + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "204": { + "$ref": "#/responses/empty" + } + }, + "produces": [ + "application/json" + ], "tags": [ "issue" ], - "summary": "List all comments in a repository", - "operationId": "issueGetRepoComments", + "summary": "Remove all labels from an issue", + "operationId": "issueClearLabels", + "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 issue", + "name": "index", + "in": "path", + "required": true + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ] + }, + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Get an issue's labels", + "operationId": "issueGetLabels", + "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 + }, + { + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the issue", + "name": "index", + "in": "path" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/LabelList" + } + } + }, + "put": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Replace an issue's labels", + "operationId": "issueReplaceLabels", + "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 + }, + { + "name": "index", + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the issue" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/IssueLabelsOption" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/LabelList" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + }, + "post": { + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "name": "repo", + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo" + }, + { + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the issue", + "name": "index" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/IssueLabelsOption" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/LabelList" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Add a label to an issue", + "operationId": "issueAddLabel" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/subscriptions": { + "get": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Get users who subscribed on an issue.", + "operationId": "issueSubscriptions", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "name": "index", + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the issue" + }, + { + "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/UserList" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/keys": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "List a repository's keys", + "operationId": "repoListKeys", "parameters": [ { "name": "owner", @@ -11085,18 +5444,16 @@ "required": true }, { - "type": "string", - "format": "date-time", - "description": "if provided, only comments updated since the provided time are returned.", - "name": "since", + "type": "integer", + "description": "the key_id to search for", + "name": "key_id", "in": "query" }, { - "description": "if provided, only comments updated before the provided time are returned.", - "name": "before", "in": "query", "type": "string", - "format": "date-time" + "description": "fingerprint of the key", + "name": "fingerprint" }, { "type": "integer", @@ -11110,6 +5467,1549 @@ "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/DeployKeyList" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + }, + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Add a key to a repository", + "operationId": "repoCreateKey", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/CreateKeyOption" + } + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "201": { + "$ref": "#/responses/DeployKey" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/reviews/{id}": { + "get": { + "summary": "Get a specific review for a pull request", + "operationId": "repoGetPullReview", + "parameters": [ + { + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "name": "index", + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the pull request" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "id of the review" + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "200": { + "$ref": "#/responses/PullReview" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + }, + "post": { + "operationId": "repoSubmitPullReview", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "name": "index", + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the pull request" + }, + { + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "id of the review", + "name": "id" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SubmitPullReviewOptions" + } + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "$ref": "#/responses/PullReview" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Submit a pending review to an pull request" + }, + "delete": { + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "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", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Delete a specific review from a pull request", + "operationId": "repoDeletePullReview" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/push_mirrors-sync": { + "post": { + "summary": "Sync all push mirrored repository", + "operationId": "repoPushMirrorSync", + "parameters": [ + { + "type": "string", + "description": "owner of the repo to sync", + "name": "owner", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo to sync", + "name": "repo" + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "200": { + "$ref": "#/responses/empty" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/comments/{id}/assets": { + "get": { + "responses": { + "200": { + "$ref": "#/responses/AttachmentList" + }, + "404": { + "$ref": "#/responses/error" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "List comment's attachments", + "operationId": "issueListIssueCommentAttachments", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "required": true, + "type": "integer", + "format": "int64", + "description": "id of the comment", + "name": "id", + "in": "path" + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ] + }, + "post": { + "operationId": "issueCreateIssueCommentAttachment", + "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 comment", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of the attachment", + "name": "name", + "in": "query" + }, + { + "required": true, + "type": "file", + "description": "attachment to upload", + "name": "attachment", + "in": "formData" + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/error" + }, + "413": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + }, + "201": { + "$ref": "#/responses/Attachment" + } + }, + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Create a comment attachment" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/assignees": { + "get": { + "summary": "Return all users that have write access and can be assigned to issues", + "operationId": "repoGetAssignees", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "$ref": "#/responses/UserList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/wiki/pages": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get all wiki pages", + "operationId": "repoGetWikiPages", + "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", + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query" + }, + { + "type": "integer", + "description": "page size of results", + "name": "limit", + "in": "query" + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "200": { + "$ref": "#/responses/WikiPageList" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}": { + "get": { + "responses": { + "200": { + "$ref": "#/responses/PullRequest" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get a pull request", + "operationId": "repoGetPullRequest", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "name": "repo", + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo" + }, + { + "type": "integer", + "format": "int64", + "description": "index of the pull request to get", + "name": "index", + "in": "path", + "required": true + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ] + }, + "patch": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.", + "operationId": "repoEditPullRequest", + "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 + }, + { + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the pull request to edit", + "name": "index", + "in": "path" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/EditPullRequestOption" + } + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "412": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" + }, + "201": { + "$ref": "#/responses/PullRequest" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "409": { + "$ref": "#/responses/error" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/licenses": { + "get": { + "summary": "Get repo licenses", + "operationId": "repoGetLicenses", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "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/LicensesList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/workflows/{workflow_id}/disable": { + "put": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Disable a workflow", + "operationId": "ActionsDisableWorkflow", + "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": "id of the workflow", + "name": "workflow_id", + "in": "path", + "required": true, + "type": "string" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + }, + "204": { + "description": "No Content" + }, + "400": { + "$ref": "#/responses/error" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/mirror-sync": { + "post": { + "tags": [ + "repository" + ], + "summary": "Sync a mirrored repository", + "operationId": "repoMirrorSync", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo to sync" + }, + { + "required": true, + "type": "string", + "description": "name of the repo to sync", + "name": "repo", + "in": "path" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/languages": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get languages and number of bytes of code written", + "operationId": "repoGetLanguages", + "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 + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "$ref": "#/responses/LanguageStatistics" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/reviews": { + "get": { + "operationId": "repoListPullReviews", + "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 + }, + { + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the pull request", + "name": "index" + }, + { + "type": "integer", + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query" + }, + { + "description": "page size of results", + "name": "limit", + "in": "query", + "type": "integer" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/PullReviewList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "List all reviews for a pull request" + }, + "post": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Create a review to an pull request", + "operationId": "repoCreatePullReview", + "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 + }, + { + "name": "index", + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the pull request" + }, + { + "schema": { + "$ref": "#/definitions/CreatePullReviewOptions" + }, + "name": "body", + "in": "body", + "required": true + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "200": { + "$ref": "#/responses/PullReview" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/dependencies": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "List an issue's dependencies, i.e all issues that block this issue.", + "operationId": "issueListIssueDependencies", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path" + }, + { + "type": "string", + "description": "index of the issue", + "name": "index", + "in": "path", + "required": true + }, + { + "type": "integer", + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query" + }, + { + "description": "page size of results", + "name": "limit", + "in": "query", + "type": "integer" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/IssueList" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + }, + "post": { + "tags": [ + "issue" + ], + "summary": "Make the issue in the url depend on the issue in the form.", + "operationId": "issueCreateIssueDependencies", + "parameters": [ + { + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true, + "type": "string" + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "type": "string", + "description": "index of the issue", + "name": "index", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/IssueMeta" + } + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "201": { + "$ref": "#/responses/Issue" + }, + "404": { + "description": "the issue does not exist" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + }, + "produces": [ + "application/json" + ] + }, + "delete": { + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Remove an issue dependency", + "operationId": "issueRemoveIssueDependencies", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "index of the issue", + "name": "index" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/IssueMeta" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/Issue" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/raw/{filepath}": { + "get": { + "operationId": "repoGetRawFile", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "description": "path of the file to get, it should be \"{ref}/{filepath}\". If there is no ref could be inferred, it will be treated as the default branch", + "name": "filepath", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "string", + "description": "The name of the commit/branch/tag. Default to the repository’s default branch", + "name": "ref", + "in": "query" + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "200": { + "schema": { + "type": "file" + }, + "description": "Returns raw file content." + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/octet-stream" + ], + "tags": [ + "repository" + ], + "summary": "Get a file from a repository" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/runners": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get repo-level runners", + "operationId": "getRepoRunners", + "parameters": [ + { + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "repo", + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/definitions/ActionRunnersResponse" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/milestones/{id}": { + "get": { + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "the milestone to get, identified by ID and if not available by name", + "name": "id", + "in": "path", + "required": true + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/Milestone" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Get a milestone", + "operationId": "issueGetMilestone" + }, + "delete": { + "tags": [ + "issue" + ], + "summary": "Delete a milestone", + "operationId": "issueDeleteMilestone", + "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": "the milestone to delete, identified by ID and if not available by name", + "name": "id", + "in": "path", + "required": true + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + }, + "patch": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Update a milestone", + "operationId": "issueEditMilestone", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "the milestone to edit, identified by ID and if not available by name", + "name": "id" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/EditMilestoneOption" + } + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/Milestone" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/blocks": { + "delete": { + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Unblock the issue given in the body by the issue in path", + "operationId": "issueRemoveIssueBlocking", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "type": "string", + "description": "index of the issue", + "name": "index", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/IssueMeta" + } + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/Issue" + } + } + }, + "get": { + "responses": { + "200": { + "$ref": "#/responses/IssueList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "List issues that are blocked by this issue", + "operationId": "issueListBlocks", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "name": "repo", + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo" + }, + { + "type": "string", + "description": "index of the issue", + "name": "index", + "in": "path", + "required": true + }, + { + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query", + "type": "integer" + }, + { + "type": "integer", + "description": "page size of results", + "name": "limit", + "in": "query" + }, { "in": "path", "description": "group ID of the repo", @@ -11118,21 +7018,8 @@ "format": "int64", "required": true } - ], - "responses": { - "200": { - "$ref": "#/responses/CommentList" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/reviews/{id}/dismissals": { + }, "post": { "parameters": [ { @@ -11150,28 +7037,323 @@ "required": true }, { - "type": "integer", - "format": "int64", - "description": "index of the pull request", + "type": "string", + "description": "index of the issue", "name": "index", "in": "path", "required": true }, { - "description": "id of the review", - "name": "id", + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/IssueMeta" + } + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "201": { + "$ref": "#/responses/Issue" + }, + "404": { + "description": "the issue does not exist" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Block the issue given in the body by the issue in path", + "operationId": "issueCreateIssueBlocking" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/contents-ext/{filepath}": { + "get": { + "summary": "The extended \"contents\" API, to get file metadata and/or content, or list a directory.", + "operationId": "repoGetContentsExt", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "path of the dir, file, symlink or submodule in the repo. Swagger requires path parameter to be \"required\", you can leave it empty or pass a single dot (\".\") to get the root directory.", + "name": "filepath", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "the name of the commit/branch/tag, default to the repository’s default branch.", + "name": "ref", + "in": "query" + }, + { + "name": "includes", + "in": "query", + "type": "string", + "description": "By default this API's response only contains file's metadata. Use comma-separated \"includes\" options to retrieve more fields. Option \"file_content\" will try to retrieve the file content, \"lfs_metadata\" will try to retrieve LFS metadata, \"commit_metadata\" will try to retrieve commit metadata, and \"commit_message\" will try to retrieve commit message." + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/ContentsExtResponse" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "description": "It guarantees that only one of the response fields is set if the request succeeds. Users can pass \"includes=file_content\" or \"includes=lfs_metadata\" to retrieve more fields. \"includes=file_content\" only works for single file, if you need to retrieve file contents in batch, use \"file-contents\" API after listing the directory.", + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/subscription": { + "get": { + "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 + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "200": { + "$ref": "#/responses/WatchInfo" + }, + "404": { + "description": "User is not watching this repo or repo do not exist" + } + }, + "tags": [ + "repository" + ], + "summary": "Check if the current user is watching a repo", + "operationId": "userCurrentCheckSubscription" + }, + "put": { + "tags": [ + "repository" + ], + "summary": "Watch a repo", + "operationId": "userCurrentPutSubscription", + "parameters": [ + { + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "200": { + "$ref": "#/responses/WatchInfo" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + }, + "delete": { + "summary": "Unwatch a repo", + "operationId": "userCurrentDeleteSubscription", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "tags": [ + "repository" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/git/refs/{ref}": { + "get": { + "tags": [ + "repository" + ], + "summary": "Get specified ref or filtered repository's refs", + "operationId": "repoListGitRefs", + "parameters": [ + { + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true, + "type": "string" + }, + { + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path" + }, + { + "type": "string", + "description": "part or full name of the ref", + "name": "ref", + "in": "path", + "required": true + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "$ref": "#/responses/ReferenceList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/reviews/{id}/undismissals": { + "post": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Cancel to dismiss a review for a pull request", + "operationId": "repoUnDismissPullReview", + "parameters": [ + { + "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": "index of the pull request", + "name": "index", "in": "path", "required": true, "type": "integer", "format": "int64" }, { - "name": "body", - "in": "body", + "in": "path", "required": true, - "schema": { - "$ref": "#/definitions/DismissPullReviewOptions" - } + "type": "integer", + "format": "int64", + "description": "id of the review", + "name": "id" }, { "type": "integer", @@ -11183,6 +7365,9 @@ } ], "responses": { + "422": { + "$ref": "#/responses/validationError" + }, "200": { "$ref": "#/responses/PullReview" }, @@ -11191,210 +7376,19 @@ }, "404": { "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Dismiss a review for a pull request", - "operationId": "repoDismissPullReview" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/git/commits/{sha}": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a single commit from a repository", - "operationId": "repoGetSingleCommit", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "string", - "description": "a git ref or commit sha", - "name": "sha", - "in": "path", - "required": true - }, - { - "type": "boolean", - "description": "include diff stats for every commit (disable for speedup, default 'true')", - "name": "stat", - "in": "query" - }, - { - "type": "boolean", - "description": "include verification for every commit (disable for speedup, default 'true')", - "name": "verification", - "in": "query" - }, - { - "type": "boolean", - "description": "include a list of affected files for every commit (disable for speedup, default 'true')", - "name": "files", - "in": "query" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - }, - "200": { - "$ref": "#/responses/Commit" } } } }, - "/repos/{owner}/group/{group_id}/{repo}/topics/{topic}": { - "put": { - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/invalidTopicsError" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Add a topic to a repository", - "operationId": "repoAddTopic", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, - { - "required": true, - "type": "string", - "description": "name of the topic to add", - "name": "topic", - "in": "path" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ] - }, - "delete": { - "tags": [ - "repository" - ], - "summary": "Delete a topic from a repository", - "operationId": "repoDeleteTopic", - "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": "name of the topic to delete", - "name": "topic", - "in": "path", - "required": true - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/invalidTopicsError" - }, - "204": { - "$ref": "#/responses/empty" - } - }, - "produces": [ - "application/json" - ] - } - }, "/repos/{owner}/group/{group_id}/{repo}/actions/runs/{run}/jobs": { "get": { - "summary": "Lists all jobs for a workflow run", - "operationId": "listWorkflowRunJobs", "parameters": [ { + "type": "string", + "description": "owner of the repo", "name": "owner", "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" + "required": true }, { "in": "path", @@ -11417,10 +7411,10 @@ "in": "query" }, { - "type": "integer", - "description": "page number of results to return (1-based)", "name": "page", - "in": "query" + "in": "query", + "type": "integer", + "description": "page number of results to return (1-based)" }, { "description": "page size of results", @@ -11428,6 +7422,370 @@ "in": "query", "type": "integer" }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/WorkflowJobsList" + }, + "400": { + "$ref": "#/responses/error" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Lists all jobs for a workflow run", + "operationId": "listWorkflowRunJobs" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/wiki/new": { + "post": { + "operationId": "repoCreateWikiPage", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/CreateWikiPageOptions" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + }, + "201": { + "$ref": "#/responses/WikiPage" + } + }, + "consumes": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Create a wiki page" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/statuses/{sha}": { + "get": { + "responses": { + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/CommitStatusList" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get a commit's statuses", + "operationId": "repoListStatuses", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "required": true, + "type": "string", + "description": "sha of the commit", + "name": "sha", + "in": "path" + }, + { + "description": "type of sort", + "name": "sort", + "in": "query", + "enum": [ + "oldest", + "recentupdate", + "leastupdate", + "leastindex", + "highestindex" + ], + "type": "string" + }, + { + "type": "string", + "description": "type of state", + "name": "state", + "in": "query", + "enum": [ + "pending", + "success", + "error", + "failure", + "warning" + ] + }, + { + "name": "page", + "in": "query", + "type": "integer", + "description": "page number of results to return (1-based)" + }, + { + "description": "page size of results", + "name": "limit", + "in": "query", + "type": "integer" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ] + }, + "post": { + "tags": [ + "repository" + ], + "summary": "Create a commit status", + "operationId": "repoCreateStatus", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "name": "sha", + "in": "path", + "required": true, + "type": "string", + "description": "sha of the commit" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/CreateStatusOption" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "201": { + "$ref": "#/responses/CommitStatus" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/transfer/reject": { + "post": { + "responses": { + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/Repository" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Reject a repo transfer", + "operationId": "rejectRepoTransfer", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo to transfer", + "name": "owner", + "in": "path" + }, + { + "required": true, + "type": "string", + "description": "name of the repo to transfer", + "name": "repo", + "in": "path" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/pinned": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "List a repo's pinned issues", + "operationId": "repoListPinnedIssues", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "200": { + "$ref": "#/responses/IssueList" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/runners/{runner_id}": { + "delete": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Delete an repo-level runner", + "operationId": "deleteRepoRunner", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "name": "repo", + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo" + }, + { + "description": "id of the runner", + "name": "runner_id", + "in": "path", + "required": true, + "type": "string" + }, { "required": true, "in": "path", @@ -11438,26 +7796,21 @@ } ], "responses": { + "204": { + "description": "runner has been deleted" + }, "400": { "$ref": "#/responses/error" }, "404": { "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/WorkflowJobsList" } - }, + } + }, + "get": { "produces": [ "application/json" ], - "tags": [ - "repository" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/actions/runners/{runner_id}": { - "get": { "tags": [ "repository" ], @@ -11504,216 +7857,47 @@ "404": { "$ref": "#/responses/notFound" } - }, - "produces": [ - "application/json" - ] - }, - "delete": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Delete an repo-level runner", - "operationId": "deleteRepoRunner", - "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": "id of the runner", - "name": "runner_id", - "in": "path", - "required": true, - "type": "string" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "204": { - "description": "runner has been deleted" - }, - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - } } } }, - "/repos/{owner}/group/{group_id}/{repo}/branches/{branch}": { + "/repos/{owner}/group/{group_id}/{repo}/issues/comments/{id}/reactions": { "get": { - "tags": [ - "repository" - ], - "summary": "Retrieve a specific branch from a repository, including its effective branch protection", - "operationId": "repoGetBranch", + "operationId": "issueGetCommentReactions", "parameters": [ { - "name": "owner", "in": "path", "required": true, "type": "string", - "description": "owner of the repo" + "description": "owner of the repo", + "name": "owner" }, { + "type": "string", "description": "name of the repo", "name": "repo", "in": "path", - "required": true, - "type": "string" - }, - { - "type": "string", - "description": "branch to get", - "name": "branch", - "in": "path", "required": true }, { - "in": "path", - "description": "group ID of the repo", - "name": "group_id", "type": "integer", "format": "int64", + "description": "id of the comment to edit", + "name": "id", + "in": "path", "required": true + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" } ], "responses": { "200": { - "$ref": "#/responses/Branch" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ] - }, - "delete": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Delete a specific branch from a repository", - "operationId": "repoDeleteBranch", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "required": true, - "type": "string", - "description": "branch to delete", - "name": "branch", - "in": "path" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - } - } - }, - "patch": { - "summary": "Rename a branch", - "operationId": "repoRenameBranch", - "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 - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the branch", - "name": "branch" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/RenameBranchRepoOption" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "422": { - "$ref": "#/responses/validationError" - }, - "204": { - "$ref": "#/responses/empty" + "$ref": "#/responses/ReactionList" }, "403": { "$ref": "#/responses/forbidden" @@ -11729,13 +7913,540 @@ "application/json" ], "tags": [ - "repository" + "issue" + ], + "summary": "Get a list of reactions from a comment of an issue" + }, + "post": { + "operationId": "issuePostCommentReaction", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "id of the comment to edit", + "name": "id" + }, + { + "in": "body", + "schema": { + "$ref": "#/definitions/EditReactionOption" + }, + "name": "content" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/Reaction" + }, + "201": { + "$ref": "#/responses/Reaction" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Add a reaction to a comment of an issue" + }, + "delete": { + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Remove a reaction from a comment of an issue", + "operationId": "issueDeleteCommentReaction", + "parameters": [ + { + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "id of the comment to edit", + "name": "id" + }, + { + "name": "content", + "in": "body", + "schema": { + "$ref": "#/definitions/EditReactionOption" + } + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "200": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "consumes": [ + "application/json" ] } }, - "/repos/{owner}/group/{group_id}/{repo}/tag_protections": { + "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/requested_reviewers": { + "post": { + "responses": { + "422": { + "$ref": "#/responses/validationError" + }, + "201": { + "$ref": "#/responses/PullReviewList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "create review requests for a pull request", + "operationId": "repoCreatePullReviewRequests", + "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": "index of the pull request", + "name": "index", + "in": "path", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PullReviewRequestOptions" + } + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ] + }, + "delete": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "cancel review requests for a pull request", + "operationId": "repoDeletePullReviewRequests", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "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 + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PullReviewRequestOptions" + } + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "422": { + "$ref": "#/responses/validationError" + }, + "204": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/reactions": { "get": { - "operationId": "repoListTagProtection", + "tags": [ + "issue" + ], + "summary": "Get a list reactions of an issue", + "operationId": "issueGetIssueReactions", + "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 + }, + { + "format": "int64", + "description": "index of the issue", + "name": "index", + "in": "path", + "required": true, + "type": "integer" + }, + { + "in": "query", + "type": "integer", + "description": "page number of results to return (1-based)", + "name": "page" + }, + { + "name": "limit", + "in": "query", + "type": "integer", + "description": "page size of results" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/ReactionList" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Add a reaction to an issue", + "operationId": "issuePostIssueReaction", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path" + }, + { + "description": "index of the issue", + "name": "index", + "in": "path", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "in": "body", + "schema": { + "$ref": "#/definitions/EditReactionOption" + }, + "name": "content" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/Reaction" + }, + "201": { + "$ref": "#/responses/Reaction" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + }, + "delete": { + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Remove a reaction from an issue", + "operationId": "issueDeleteIssueReaction", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "name": "repo", + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo" + }, + { + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the issue", + "name": "index" + }, + { + "name": "content", + "in": "body", + "schema": { + "$ref": "#/definitions/EditReactionOption" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "consumes": [ + "application/json" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/transfer/accept": { + "post": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Accept a repo transfer", + "operationId": "acceptRepoTransfer", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo to transfer" + }, + { + "description": "name of the repo to transfer", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "202": { + "$ref": "#/responses/Repository" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/stopwatch/start": { + "post": { + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "409": { + "description": "Cannot start a stopwatch again if it already exists" + }, + "201": { + "$ref": "#/responses/empty" + }, + "403": { + "description": "Not repo writer, user does not have rights to toggle stopwatch" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Start stopwatch on an issue.", + "operationId": "issueStartStopWatch", "parameters": [ { "type": "string", @@ -11751,6 +8462,156 @@ "type": "string", "description": "name of the repo" }, + { + "type": "integer", + "format": "int64", + "description": "index of the issue to create the stopwatch on", + "name": "index", + "in": "path", + "required": true + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/topics/{topic}": { + "put": { + "summary": "Add a topic to a repository", + "operationId": "repoAddTopic", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "name": "topic", + "in": "path", + "required": true, + "type": "string", + "description": "name of the topic to add" + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/invalidTopicsError" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + }, + "delete": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Delete a topic from a repository", + "operationId": "repoDeleteTopic", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path" + }, + { + "name": "topic", + "in": "path", + "required": true, + "type": "string", + "description": "name of the topic to delete" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "422": { + "$ref": "#/responses/invalidTopicsError" + }, + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/merge-upstream": { + "post": { + "operationId": "repoMergeUpstream", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/MergeUpstreamRequest" + } + }, { "type": "integer", "format": "int64", @@ -11762,7 +8623,13 @@ ], "responses": { "200": { - "$ref": "#/responses/TagProtectionList" + "$ref": "#/responses/MergeUpstreamResponse" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" } }, "produces": [ @@ -11771,17 +8638,751 @@ "tags": [ "repository" ], - "summary": "List tag protections for a repository" - }, - "post": { + "summary": "Merge a branch from upstream" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/tags": { + "get": { "produces": [ "application/json" ], "tags": [ "repository" ], - "summary": "Create a tag protections for a repository", - "operationId": "repoCreateTagProtection", + "summary": "List a repository's tags", + "operationId": "repoListTags", + "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", + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query" + }, + { + "type": "integer", + "description": "page size of results, default maximum page size is 50", + "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/TagList" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + }, + "post": { + "responses": { + "200": { + "$ref": "#/responses/Tag" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "405": { + "$ref": "#/responses/empty" + }, + "409": { + "$ref": "#/responses/conflict" + }, + "422": { + "$ref": "#/responses/validationError" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Create a new git tag in a repository", + "operationId": "repoCreateTag", + "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 + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/CreateTagOption" + } + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/runs/{run}": { + "get": { + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "name": "repo", + "in": "path", + "required": true, + "type": "string", + "description": "name of the repository" + }, + { + "type": "string", + "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": { + "200": { + "$ref": "#/responses/WorkflowRun" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Gets a specific workflow run", + "operationId": "GetWorkflowRun" + }, + "delete": { + "operationId": "deleteActionRun", + "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": "runid of the workflow 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": { + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "204": { + "description": "No Content" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Delete a workflow run" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/teams": { + "get": { + "operationId": "repoListTeams", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path" + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "$ref": "#/responses/TeamList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "List a repository's teams" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/notifications": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "notification" + ], + "summary": "List users's notification threads on a specific repo", + "operationId": "notifyGetRepoList", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path" + }, + { + "name": "all", + "in": "query", + "type": "boolean", + "description": "If true, show notifications marked as read. Default value is false" + }, + { + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned", + "name": "status-types", + "in": "query", + "type": "array" + }, + { + "name": "subject-type", + "in": "query", + "type": "array", + "items": { + "enum": [ + "issue", + "pull", + "commit", + "repository" + ], + "type": "string" + }, + "collectionFormat": "multi", + "description": "filter notifications by subject type" + }, + { + "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format", + "name": "since", + "in": "query", + "type": "string", + "format": "date-time" + }, + { + "type": "string", + "format": "date-time", + "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format", + "name": "before", + "in": "query" + }, + { + "type": "integer", + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query" + }, + { + "description": "page size of results", + "name": "limit", + "in": "query", + "type": "integer" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/NotificationThreadList" + } + }, + "consumes": [ + "application/json" + ] + }, + "put": { + "tags": [ + "notification" + ], + "summary": "Mark notification threads as read, pinned or unread on a specific repo", + "operationId": "notifyReadRepoList", + "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": "If true, mark all notifications on this repo. Default value is false", + "name": "all", + "in": "query", + "type": "string" + }, + { + "collectionFormat": "multi", + "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.", + "name": "status-types", + "in": "query", + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "string", + "description": "Status to mark notifications as. Defaults to read.", + "name": "to-status", + "in": "query" + }, + { + "type": "string", + "format": "date-time", + "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.", + "name": "last_read_at", + "in": "query" + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "205": { + "$ref": "#/responses/NotificationThreadList" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/hooks/git/{id}": { + "delete": { + "tags": [ + "repository" + ], + "summary": "Delete a Git hook in a repository", + "operationId": "repoDeleteGitHook", + "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 + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "id of the hook to get", + "name": "id" + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ] + }, + "patch": { + "responses": { + "200": { + "$ref": "#/responses/GitHook" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Edit a Git hook in a repository", + "operationId": "repoEditGitHook", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "id of the hook to get", + "name": "id", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/EditGitHookOption" + } + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ] + }, + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get a Git hook", + "operationId": "repoGetGitHook", + "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": "id of the hook to get", + "name": "id", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "200": { + "$ref": "#/responses/GitHook" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/commits/{sha}/pull": { + "get": { + "summary": "Get the merged pull request of the commit", + "operationId": "repoGetCommitPullRequest", + "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": "SHA of the commit to get", + "name": "sha", + "in": "path", + "required": true + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/PullRequest" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/avatar": { + "post": { + "tags": [ + "repository" + ], + "summary": "Update avatar", + "operationId": "repoUpdateAvatar", + "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 + }, + { + "in": "body", + "schema": { + "$ref": "#/definitions/UpdateRepoAvatarOption" + }, + "name": "body" + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "204": { + "$ref": "#/responses/empty" + } + }, + "produces": [ + "application/json" + ] + }, + "delete": { + "operationId": "repoDeleteAvatar", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Delete avatar" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/workflows/{workflow_id}": { + "get": { "parameters": [ { "required": true, @@ -11797,6 +9398,636 @@ "in": "path", "required": true }, + { + "type": "string", + "description": "id of the workflow", + "name": "workflow_id", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "500": { + "$ref": "#/responses/error" + }, + "200": { + "$ref": "#/responses/ActionWorkflow" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get a workflow", + "operationId": "ActionsGetWorkflow" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/commits/{ref}/statuses": { + "get": { + "operationId": "repoListStatusesByRef", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of branch/tag/commit", + "name": "ref" + }, + { + "enum": [ + "oldest", + "recentupdate", + "leastupdate", + "leastindex", + "highestindex" + ], + "type": "string", + "description": "type of sort", + "name": "sort", + "in": "query" + }, + { + "in": "query", + "enum": [ + "pending", + "success", + "error", + "failure", + "warning" + ], + "type": "string", + "description": "type of state", + "name": "state" + }, + { + "type": "integer", + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query" + }, + { + "in": "query", + "type": "integer", + "description": "page size of results", + "name": "limit" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/CommitStatusList" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get a commit's statuses, by branch/tag/commit reference" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/activities/feeds": { + "get": { + "operationId": "repoListActivityFeeds", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "string", + "format": "date", + "description": "the date of the activities to be found", + "name": "date", + "in": "query" + }, + { + "type": "integer", + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query" + }, + { + "description": "page size of results", + "name": "limit", + "in": "query", + "type": "integer" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/ActivityFeedsList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "List a repository's activity feeds" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/compare/{basehead}": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get commit comparison information", + "operationId": "repoCompareDiff", + "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": "compare two branches or commits", + "name": "basehead", + "in": "path", + "required": true + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "$ref": "#/responses/Compare" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/artifacts/{artifact_id}/zip": { + "get": { + "responses": { + "302": { + "description": "redirect to the blob download" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Downloads a specific artifact for a workflow run redirects to blob url", + "operationId": "downloadArtifact", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "required": true, + "type": "string", + "description": "name of the repository", + "name": "repo", + "in": "path" + }, + { + "description": "id of the artifact", + "name": "artifact_id", + "in": "path", + "required": true, + "type": "string" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/jobs/{job_id}/logs": { + "get": { + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "required": true, + "type": "string", + "description": "name of the repository", + "name": "repo", + "in": "path" + }, + { + "name": "job_id", + "in": "path", + "required": true, + "type": "integer", + "description": "id of the job" + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "200": { + "description": "output blob content" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Downloads the job logs for a workflow run", + "operationId": "downloadActionsRunJobLogs" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/pin": { + "post": { + "tags": [ + "issue" + ], + "summary": "Pin an Issue", + "operationId": "pinIssue", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path" + }, + { + "type": "integer", + "format": "int64", + "description": "index of issue to pin", + "name": "index", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "204": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + } + } + }, + "delete": { + "summary": "Unpin an Issue", + "operationId": "unpinIssue", + "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": "index of issue to unpin", + "name": "index", + "in": "path", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "tags": [ + "issue" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/git/tags/{sha}": { + "get": { + "summary": "Gets the tag object of an annotated tag (not lightweight tags)", + "operationId": "GetAnnotatedTag", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path" + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.", + "name": "sha" + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "200": { + "$ref": "#/responses/AnnotatedTag" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/times/{user}": { + "get": { + "summary": "List a user's tracked times in a repo", + "operationId": "userTrackedTimes", + "deprecated": true, + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "description": "username of the user whose tracked times are to be listed", + "name": "user", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "200": { + "$ref": "#/responses/TrackedTimeList" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/tag_protections": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "List tag protections for a repository", + "operationId": "repoListTagProtection", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/TagProtectionList" + } + } + }, + "post": { + "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 + }, { "name": "body", "in": "body", @@ -11814,6 +10045,9 @@ } ], "responses": { + "422": { + "$ref": "#/responses/validationError" + }, "423": { "$ref": "#/responses/repoArchivedError" }, @@ -11823,6 +10057,1558 @@ "403": { "$ref": "#/responses/forbidden" }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Create a tag protections for a repository", + "operationId": "repoCreateTagProtection" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/tasks": { + "get": { + "operationId": "ListActionTasks", + "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", + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query" + }, + { + "name": "limit", + "in": "query", + "type": "integer", + "description": "page size of results, default maximum page size is 50" + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "409": { + "$ref": "#/responses/conflict" + }, + "422": { + "$ref": "#/responses/validationError" + }, + "200": { + "$ref": "#/responses/TasksList" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "List a repository's action tasks" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/runs": { + "get": { + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "required": true, + "type": "string", + "description": "name of the repository", + "name": "repo", + "in": "path" + }, + { + "name": "event", + "in": "query", + "type": "string", + "description": "workflow event name" + }, + { + "type": "string", + "description": "workflow branch", + "name": "branch", + "in": "query" + }, + { + "type": "string", + "description": "workflow status (pending, queued, in_progress, failure, success, skipped)", + "name": "status", + "in": "query" + }, + { + "type": "string", + "description": "triggered by user", + "name": "actor", + "in": "query" + }, + { + "type": "string", + "description": "triggering sha of the workflow run", + "name": "head_sha", + "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/WorkflowRunsList" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Lists all runs for a repository run", + "operationId": "getWorkflowRuns" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/wiki/page/{pageName}": { + "get": { + "responses": { + "200": { + "$ref": "#/responses/WikiPage" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get a wiki page", + "operationId": "repoGetWikiPage", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "name": "pageName", + "in": "path", + "required": true, + "type": "string", + "description": "name of the page" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ] + }, + "delete": { + "tags": [ + "repository" + ], + "summary": "Delete a wiki page", + "operationId": "repoDeleteWikiPage", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "type": "string", + "description": "name of the page", + "name": "pageName", + "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" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + } + }, + "patch": { + "responses": { + "200": { + "$ref": "#/responses/WikiPage" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + }, + "consumes": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Edit a wiki page", + "operationId": "repoEditWikiPage", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "description": "name of the page", + "name": "pageName", + "in": "path", + "required": true, + "type": "string" + }, + { + "schema": { + "$ref": "#/definitions/CreateWikiPageOptions" + }, + "name": "body", + "in": "body" + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/contents": { + "get": { + "description": "This API follows GitHub's design, and it is not easy to use. Recommend users to use our \"contents-ext\" API instead.", + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Gets the metadata of all the entries of the root dir.", + "operationId": "repoGetContentsList", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "The name of the commit/branch/tag. Default to the repository’s default branch.", + "name": "ref", + "in": "query" + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "200": { + "$ref": "#/responses/ContentsListResponse" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + }, + "post": { + "tags": [ + "repository" + ], + "summary": "Modify multiple files in a repository", + "operationId": "repoChangeFiles", + "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 + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ChangeFilesOptions" + } + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "201": { + "$ref": "#/responses/FilesResponse" + }, + "403": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/error" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/tags/{tag}": { + "get": { + "tags": [ + "repository" + ], + "summary": "Get the tag of a repository by tag name", + "operationId": "repoGetTag", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "required": true, + "type": "string", + "description": "name of tag", + "name": "tag", + "in": "path" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/Tag" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ] + }, + "delete": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Delete a repository's tag by name", + "operationId": "repoDeleteTag", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "description": "name of tag to delete", + "name": "tag", + "in": "path", + "required": true, + "type": "string" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "405": { + "$ref": "#/responses/empty" + }, + "409": { + "$ref": "#/responses/conflict" + }, + "422": { + "$ref": "#/responses/validationError" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/new_pin_allowed": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Returns if new Issue Pins are allowed", + "operationId": "repoNewPinAllowed", + "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 + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/RepoNewIssuePinsAllowed" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/collaborators": { + "get": { + "operationId": "repoListCollaborators", + "parameters": [ + { + "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" + }, + { + "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" + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "200": { + "$ref": "#/responses/UserList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "List a repository's collaborators" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/assets/{attachment_id}": { + "delete": { + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the issue", + "name": "index", + "in": "path" + }, + { + "type": "integer", + "format": "int64", + "description": "id of the attachment to delete", + "name": "attachment_id", + "in": "path", + "required": true + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/error" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Delete an issue attachment", + "operationId": "issueDeleteIssueAttachment" + }, + "patch": { + "tags": [ + "issue" + ], + "summary": "Edit an issue attachment", + "operationId": "issueEditIssueAttachment", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "integer", + "format": "int64", + "description": "index of the issue", + "name": "index", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "description": "id of the attachment to edit", + "name": "attachment_id", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/EditAttachmentOptions" + } + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "201": { + "$ref": "#/responses/Attachment" + }, + "404": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] + }, + "get": { + "parameters": [ + { + "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": "index of the issue", + "name": "index", + "in": "path", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "id of the attachment to get", + "name": "attachment_id" + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "200": { + "$ref": "#/responses/Attachment" + }, + "404": { + "$ref": "#/responses/error" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Get an issue attachment", + "operationId": "issueGetIssueAttachment" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/contents/{filepath}": { + "get": { + "operationId": "repoGetContents", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "required": true, + "type": "string", + "description": "path of the dir, file, symlink or submodule in the repo", + "name": "filepath", + "in": "path" + }, + { + "type": "string", + "description": "The name of the commit/branch/tag. Default to the repository’s default branch.", + "name": "ref", + "in": "query" + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "200": { + "$ref": "#/responses/ContentsResponse" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "description": "This API follows GitHub's design, and it is not easy to use. Recommend users to use the \"contents-ext\" API instead.", + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir." + }, + "put": { + "tags": [ + "repository" + ], + "summary": "Update a file in a repository if SHA is set, or create the file if SHA is not set", + "operationId": "repoUpdateFile", + "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 + }, + { + "name": "filepath", + "in": "path", + "required": true, + "type": "string", + "description": "path of the file to update" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateFileOptions" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "201": { + "$ref": "#/responses/FileResponse" + }, + "403": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/error" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + }, + "200": { + "$ref": "#/responses/FileResponse" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Create a file in a repository", + "operationId": "repoCreateFile", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path" + }, + { + "type": "string", + "description": "path of the file to create", + "name": "filepath", + "in": "path", + "required": true + }, + { + "required": true, + "schema": { + "$ref": "#/definitions/CreateFileOptions" + }, + "name": "body", + "in": "body" + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "201": { + "$ref": "#/responses/FileResponse" + }, + "403": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/error" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + } + }, + "delete": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Delete a file in a repository", + "operationId": "repoDeleteFile", + "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 + }, + { + "required": true, + "type": "string", + "description": "path of the file to delete", + "name": "filepath", + "in": "path" + }, + { + "schema": { + "$ref": "#/definitions/DeleteFileOptions" + }, + "name": "body", + "in": "body", + "required": true + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "404": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/error" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + }, + "200": { + "$ref": "#/responses/FileDeleteResponse" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/error" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/releases/{id}": { + "get": { + "operationId": "repoGetRelease", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "name": "repo", + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo" + }, + { + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "id of the release to get", + "name": "id" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/Release" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get a release" + }, + "delete": { + "tags": [ + "repository" + ], + "summary": "Delete a release", + "operationId": "repoDeleteRelease", + "parameters": [ + { + "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" + }, + { + "type": "integer", + "format": "int64", + "description": "id of the release to delete", + "name": "id", + "in": "path", + "required": true + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + } + } + }, + "patch": { + "responses": { + "200": { + "$ref": "#/responses/Release" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Update a release", + "operationId": "repoEditRelease", + "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 release to edit", + "name": "id", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/EditReleaseOption" + } + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/teams/{team}": { + "get": { + "tags": [ + "repository" + ], + "summary": "Check if a team is assigned to a repository", + "operationId": "repoCheckTeam", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "team name", + "name": "team", + "in": "path", + "required": true + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "405": { + "$ref": "#/responses/error" + }, + "200": { + "$ref": "#/responses/Team" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ] + }, + "put": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Add a team to a repository", + "operationId": "repoAddTeam", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "team name", + "name": "team", + "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" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "405": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" + } + } + }, + "delete": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Delete a team from a repository", + "operationId": "repoDeleteTeam", + "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": "team name", + "name": "team", + "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" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "405": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issue_config/validate": { + "get": { + "operationId": "repoValidateIssueConfig", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/RepoIssueConfigValidation" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Returns the validation information for a issue config" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/branches/{branch}": { + "patch": { + "summary": "Rename a branch", + "operationId": "repoRenameBranch", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "description": "name of the branch", + "name": "branch", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/RenameBranchRepoOption" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + }, "404": { "$ref": "#/responses/notFound" }, @@ -11832,40 +11618,44 @@ }, "consumes": [ "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "repository" ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/subscriptions/{user}": { - "put": { + }, + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Retrieve a specific branch from a repository, including its effective branch protection", + "operationId": "repoGetBranch", "parameters": [ { - "description": "owner of the repo", - "name": "owner", "in": "path", "required": true, - "type": "string" + "type": "string", + "description": "owner of the repo", + "name": "owner" }, { - "required": true, "type": "string", "description": "name of the repo", "name": "repo", - "in": "path" - }, - { "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the issue", - "name": "index" + "required": true }, { - "required": true, "type": "string", - "description": "username of the user to subscribe the issue to", - "name": "user", - "in": "path" + "description": "branch to get", + "name": "branch", + "in": "path", + "required": true }, { "description": "group ID of the repo", @@ -11878,56 +11668,90 @@ ], "responses": { "200": { - "description": "Already subscribed" - }, - "201": { - "description": "Successfully Subscribed" - }, - "304": { - "description": "User can only subscribe itself if he is no admin" + "$ref": "#/responses/Branch" }, "404": { "$ref": "#/responses/notFound" } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "issue" - ], - "summary": "Subscribe user to issue", - "operationId": "issueAddSubscription" + } }, "delete": { + "tags": [ + "repository" + ], + "summary": "Delete a specific branch from a repository", + "operationId": "repoDeleteBranch", + "parameters": [ + { + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "branch to delete", + "name": "branch", + "in": "path", + "required": true + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], "responses": { - "200": { - "description": "Already unsubscribed" + "423": { + "$ref": "#/responses/repoArchivedError" }, - "201": { - "description": "Successfully Unsubscribed" + "204": { + "$ref": "#/responses/empty" }, - "304": { - "description": "User can only subscribe itself if he is no admin" + "403": { + "$ref": "#/responses/error" }, "404": { "$ref": "#/responses/notFound" } }, - "consumes": [ + "produces": [ "application/json" - ], + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/runs/{run}/artifacts": { + "get": { + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/ArtifactsList" + }, + "400": { + "$ref": "#/responses/error" + } + }, "produces": [ "application/json" ], "tags": [ - "issue" + "repository" ], - "summary": "Unsubscribe user from issue", - "operationId": "issueDeleteSubscription", + "summary": "Lists all artifacts for a repository run", + "operationId": "getArtifactsOfRun", "parameters": [ { "type": "string", @@ -11937,24 +11761,59 @@ "required": true }, { - "name": "repo", "in": "path", "required": true, "type": "string", - "description": "name of the repo" + "description": "name of the repository", + "name": "repo" }, { "type": "integer", - "format": "int64", - "description": "index of the issue", - "name": "index", + "description": "runid of the workflow run", + "name": "run", "in": "path", "required": true }, { + "description": "name of the artifact", + "name": "name", + "in": "query", + "type": "string" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/push_mirrors/{name}": { + "get": { + "summary": "Get push mirror of the repository by remoteName", + "operationId": "repoGetPushMirrorByRemoteName", + "parameters": [ + { + "in": "path", + "required": true, "type": "string", - "description": "username of the user to unsubscribe from an issue", - "name": "user", + "description": "owner of the repo", + "name": "owner" + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "type": "string", + "description": "remote name of push mirror", + "name": "name", "in": "path", "required": true }, @@ -11966,12 +11825,248 @@ "in": "path", "description": "group ID of the repo" } + ], + "responses": { + "200": { + "$ref": "#/responses/PushMirror" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + }, + "delete": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "deletes a push mirror from a repository by remoteName", + "operationId": "repoDeletePushMirror", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "string", + "description": "remote name of the pushMirror", + "name": "name", + "in": "path", + "required": true + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "204": { + "$ref": "#/responses/empty" + }, + "400": { + "$ref": "#/responses/error" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/secrets": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "List an repo's actions secrets", + "operationId": "repoListActionsSecrets", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "description": "name of the repository", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "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" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/SecretList" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/variables": { + "get": { + "tags": [ + "repository" + ], + "summary": "Get repo-level variables list", + "operationId": "getRepoVariablesList", + "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": "page number of results to return (1-based)", + "name": "page", + "in": "query" + }, + { + "type": "integer", + "description": "page size of results", + "name": "limit", + "in": "query" + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/VariableList" + }, + "400": { + "$ref": "#/responses/error" + } + }, + "produces": [ + "application/json" ] } }, - "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}.{diffType}": { - "get": { - "operationId": "repoDownloadPullDiffOrPatch", + "/repos/{owner}/group/{group_id}/{repo}/branch_protections/{name}": { + "delete": { + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Delete a specific branch protection for the repository", + "operationId": "repoDeleteBranchProtection", + "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": "name of protected branch", + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ] + }, + "patch": { + "operationId": "repoEditBranchProtection", "parameters": [ { "required": true, @@ -11981,36 +12076,217 @@ "in": "path" }, { + "required": true, + "type": "string", + "description": "name of the repo", "name": "repo", + "in": "path" + }, + { + "name": "name", "in": "path", "required": true, "type": "string", - "description": "name of the repo" + "description": "name of protected branch" }, { - "name": "index", - "in": "path", - "required": true, + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/EditBranchProtectionOption" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", "type": "integer", "format": "int64", - "description": "index of the pull request to get" + "required": true, + "in": "path" + } + ], + "responses": { + "200": { + "$ref": "#/responses/BranchProtection" }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Edit a branch protections for a repository. Only fields that are set will be changed" + }, + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get a specific branch protection for the repository", + "operationId": "repoGetBranchProtection", + "parameters": [ { + "name": "owner", "in": "path", "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of protected branch", + "name": "name", + "in": "path", + "required": true + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/BranchProtection" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/hooks/{id}/tests": { + "post": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Test a push webhook", + "operationId": "repoTestHook", + "parameters": [ + { + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "description": "id of the hook to test", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload.", + "name": "ref", + "in": "query" + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}.{diffType}": { + "get": { + "produces": [ + "text/plain" + ], + "tags": [ + "repository" + ], + "summary": "Get a pull request diff or patch", + "operationId": "repoDownloadPullDiffOrPatch", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "integer", + "format": "int64", + "description": "index of the pull request to get", + "name": "index", + "in": "path", + "required": true + }, + { "enum": [ "diff", "patch" ], "type": "string", "description": "whether the output is diff or patch", - "name": "diffType" + "name": "diffType", + "in": "path", + "required": true }, { - "type": "boolean", "description": "whether to include binary file changes. if true, the diff is applicable with `git apply`", "name": "binary", - "in": "query" + "in": "query", + "type": "boolean" }, { "description": "group ID of the repo", @@ -12028,23 +12304,809 @@ "404": { "$ref": "#/responses/notFound" } - }, - "produces": [ - "text/plain" - ], - "tags": [ - "repository" - ], - "summary": "Get a pull request diff or patch" + } } }, - "/repos/{owner}/group/{group_id}/{repo}/branches": { + "/repos/{owner}/group/{group_id}/{repo}/media/{filepath}": { "get": { + "responses": { + "200": { + "description": "Returns raw file content.", + "schema": { + "type": "file" + } + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/octet-stream" + ], "tags": [ "repository" ], - "summary": "List a repository's branches", - "operationId": "repoListBranches", + "summary": "Get a file or it's LFS object from a repository", + "operationId": "repoGetRawFileOrLFS", + "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 + }, + { + "name": "filepath", + "in": "path", + "required": true, + "type": "string", + "description": "path of the file to get, it should be \"{ref}/{filepath}\". If there is no ref could be inferred, it will be treated as the default branch" + }, + { + "description": "The name of the commit/branch/tag. Default to the repository’s default branch", + "name": "ref", + "in": "query", + "type": "string" + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/branch_protections": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "List branch protections for a repository", + "operationId": "repoListBranchProtection", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "200": { + "$ref": "#/responses/BranchProtectionList" + } + } + }, + "post": { + "operationId": "repoCreateBranchProtection", + "parameters": [ + { + "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" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/CreateBranchProtectionOption" + } + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "201": { + "$ref": "#/responses/BranchProtection" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Create a branch protections for a repository" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/commits/{ref}/status": { + "get": { + "summary": "Get a commit's combined status, by branch/tag/commit reference", + "operationId": "repoGetCombinedStatusByRef", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "ref", + "in": "path", + "required": true, + "type": "string", + "description": "name of branch/tag/commit" + }, + { + "in": "query", + "type": "integer", + "description": "page number of results to return (1-based)", + "name": "page" + }, + { + "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/CombinedStatus" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/deadline": { + "post": { + "summary": "Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.", + "operationId": "issueEditIssueDeadline", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the issue to create or update a deadline on", + "name": "index", + "in": "path" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/EditDeadlineOption" + } + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "201": { + "$ref": "#/responses/IssueDeadline" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/comments": { + "get": { + "summary": "List all comments on an issue", + "operationId": "issueGetComments", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "integer", + "format": "int64", + "description": "index of the issue", + "name": "index", + "in": "path", + "required": true + }, + { + "description": "if provided, only comments updated since the specified time are returned.", + "name": "since", + "in": "query", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "type": "string", + "format": "date-time", + "description": "if provided, only comments updated before the provided time are returned.", + "name": "before" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/CommentList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ] + }, + "post": { + "responses": { + "201": { + "$ref": "#/responses/Comment" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Add a comment to an issue", + "operationId": "issueCreateComment", + "parameters": [ + { + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "repo", + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo" + }, + { + "format": "int64", + "description": "index of the issue", + "name": "index", + "in": "path", + "required": true, + "type": "integer" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/CreateIssueCommentOption" + } + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/workflows": { + "get": { + "operationId": "ActionsListRepositoryWorkflows", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + }, + "500": { + "$ref": "#/responses/error" + }, + "200": { + "$ref": "#/responses/ActionWorkflowList" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "List repository workflows" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/releases/tags/{tag}": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get a release by tag name", + "operationId": "repoGetReleaseByTag", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "name": "tag", + "in": "path", + "required": true, + "type": "string", + "description": "tag name of the release to get" + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "200": { + "$ref": "#/responses/Release" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + }, + "delete": { + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "name": "repo", + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo" + }, + { + "type": "string", + "description": "tag name of the release to delete", + "name": "tag", + "in": "path", + "required": true + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + } + }, + "tags": [ + "repository" + ], + "summary": "Delete a release by tag name", + "operationId": "repoDeleteReleaseByTag" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/times": { + "get": { + "operationId": "issueTrackedTimes", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "format": "int64", + "description": "index of the issue", + "name": "index", + "in": "path", + "required": true, + "type": "integer" + }, + { + "type": "string", + "description": "optional filter by user (available for issue managers)", + "name": "user", + "in": "query" + }, + { + "type": "string", + "format": "date-time", + "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format", + "name": "since", + "in": "query" + }, + { + "type": "string", + "format": "date-time", + "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format", + "name": "before", + "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" + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "200": { + "$ref": "#/responses/TrackedTimeList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "List an issue's tracked times" + }, + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Add tracked time to a issue", + "operationId": "issueAddTime", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "description": "index of the issue", + "name": "index", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/AddTimeOption" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/TrackedTime" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + } + } + }, + "delete": { + "summary": "Reset a tracked time of an issue", + "operationId": "issueResetTime", + "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 issue to add tracked time to", + "name": "index", + "in": "path", + "required": true + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "204": { + "$ref": "#/responses/empty" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/labels/{id}": { + "delete": { + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Remove a label from an issue", + "operationId": "issueRemoveLabel", "parameters": [ { "type": "string", @@ -12060,6 +13122,474 @@ "name": "repo", "in": "path" }, + { + "type": "integer", + "format": "int64", + "description": "index of the issue", + "name": "index", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "description": "id of the label to remove", + "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" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/merge": { + "post": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Merge a pull request", + "operationId": "repoMergePullRequest", + "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 to merge", + "name": "index", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/MergePullRequestOption" + } + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "405": { + "$ref": "#/responses/empty" + }, + "409": { + "$ref": "#/responses/error" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + } + }, + "delete": { + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "423": { + "$ref": "#/responses/repoArchivedError" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Cancel the scheduled auto merge for the given pull request", + "operationId": "repoCancelScheduledAutoMerge", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the pull request to merge", + "name": "index", + "in": "path" + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ] + }, + "get": { + "summary": "Check if a pull request has been merged", + "operationId": "repoPullRequestIsMerged", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "integer", + "format": "int64", + "description": "index of the pull request", + "name": "index", + "in": "path", + "required": true + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "204": { + "description": "pull request has been merged" + }, + "404": { + "description": "pull request has not been merged" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/subscriptions/check": { + "get": { + "summary": "Check if user is subscribed to an issue", + "operationId": "issueCheckSubscription", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the issue", + "name": "index", + "in": "path" + }, + { + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64" + } + ], + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/WatchInfo" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/git/blobs/{sha}": { + "get": { + "operationId": "GetBlob", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path" + }, + { + "description": "sha of the commit", + "name": "sha", + "in": "path", + "required": true, + "type": "string" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/GitBlobResponse" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Gets the blob of a repository." + } + }, + "/repos/{owner}/group/{group_id}/{repo}/subscribers": { + "get": { + "summary": "List a repo's watchers", + "operationId": "repoListSubscribers", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "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" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "$ref": "#/responses/UserList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/labels": { + "post": { + "tags": [ + "issue" + ], + "summary": "Create a label", + "operationId": "issueCreateLabel", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/CreateLabelOption" + } + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "201": { + "$ref": "#/responses/Label" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] + }, + "get": { + "responses": { + "404": { + "$ref": "#/responses/notFound" + }, + "200": { + "$ref": "#/responses/LabelList" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Get all of a repository's labels", + "operationId": "issueListLabels", + "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 + }, { "in": "query", "type": "integer", @@ -12072,6 +13602,159 @@ "name": "limit", "in": "query" }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/releases/latest": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at", + "operationId": "repoGetLatestRelease", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "200": { + "$ref": "#/responses/Release" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/actions/workflows/{workflow_id}/dispatches": { + "post": { + "operationId": "ActionsDispatchWorkflow", + "parameters": [ + { + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "id of the workflow", + "name": "workflow_id", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/CreateActionWorkflowDispatch" + } + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "422": { + "$ref": "#/responses/validationError" + }, + "204": { + "description": "No Content" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Create a workflow dispatch event" + } + }, + "/repos/{owner}/group/{group_id}/{repo}/branches": { + "get": { + "summary": "List a repository's branches", + "operationId": "repoListBranches", + "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", + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query" + }, + { + "type": "integer", + "description": "page size of results", + "name": "limit", + "in": "query" + }, { "format": "int64", "required": true, @@ -12088,9 +13771,15 @@ }, "produces": [ "application/json" + ], + "tags": [ + "repository" ] }, "post": { + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -12101,25 +13790,25 @@ "operationId": "repoCreateBranch", "parameters": [ { - "name": "owner", "in": "path", "required": true, "type": "string", - "description": "owner of the repo" + "description": "owner of the repo", + "name": "owner" }, { + "type": "string", + "description": "name of the repo", "name": "repo", "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" + "required": true }, { + "name": "body", "in": "body", "schema": { "$ref": "#/definitions/CreateBranchRepoOption" - }, - "name": "body" + } }, { "description": "group ID of the repo", @@ -12131,6 +13820,9 @@ } ], "responses": { + "423": { + "$ref": "#/responses/repoArchivedError" + }, "201": { "$ref": "#/responses/Branch" }, @@ -12142,1066 +13834,44 @@ }, "409": { "description": "The branch with the same name already exists." - }, - "423": { - "$ref": "#/responses/repoArchivedError" - } - }, - "consumes": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/stargazers": { - "get": { - "responses": { - "200": { - "$ref": "#/responses/UserList" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List a repo's stargazers", - "operationId": "repoListStargazers", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, - { - "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" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/merge-upstream": { - "post": { - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/MergeUpstreamRequest" - } - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "$ref": "#/responses/MergeUpstreamResponse" - }, - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Merge a branch from upstream", - "operationId": "repoMergeUpstream" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/contents-ext/{filepath}": { - "get": { - "summary": "The extended \"contents\" API, to get file metadata and/or content, or list a directory.", - "operationId": "repoGetContentsExt", - "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": "path of the dir, file, symlink or submodule in the repo. Swagger requires path parameter to be \"required\", you can leave it empty or pass a single dot (\".\") to get the root directory.", - "name": "filepath", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "the name of the commit/branch/tag, default to the repository’s default branch.", - "name": "ref", - "in": "query" - }, - { - "name": "includes", - "in": "query", - "type": "string", - "description": "By default this API's response only contains file's metadata. Use comma-separated \"includes\" options to retrieve more fields. Option \"file_content\" will try to retrieve the file content, \"lfs_metadata\" will try to retrieve LFS metadata, \"commit_metadata\" will try to retrieve commit metadata, and \"commit_message\" will try to retrieve commit message." - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "200": { - "$ref": "#/responses/ContentsExtResponse" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "description": "It guarantees that only one of the response fields is set if the request succeeds. Users can pass \"includes=file_content\" or \"includes=lfs_metadata\" to retrieve more fields. \"includes=file_content\" only works for single file, if you need to retrieve file contents in batch, use \"file-contents\" API after listing the directory.", - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/contents/{filepath}": { - "put": { - "responses": { - "423": { - "$ref": "#/responses/repoArchivedError" - }, - "200": { - "$ref": "#/responses/FileResponse" - }, - "201": { - "$ref": "#/responses/FileResponse" - }, - "403": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/error" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Update a file in a repository if SHA is set, or create the file if SHA is not set", - "operationId": "repoUpdateFile", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "path of the file to update", - "name": "filepath", - "in": "path", - "required": true - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateFileOptions" - } - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ] - }, - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Create a file in a repository", - "operationId": "repoCreateFile", - "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": "path of the file to create", - "name": "filepath", - "in": "path", - "required": true - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CreateFileOptions" - } - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "201": { - "$ref": "#/responses/FileResponse" - }, - "403": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/error" - }, - "423": { - "$ref": "#/responses/repoArchivedError" } } - }, - "delete": { - "summary": "Delete a file in a repository", - "operationId": "repoDeleteFile", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "path of the file to delete", - "name": "filepath" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DeleteFileOptions" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "423": { - "$ref": "#/responses/repoArchivedError" - }, - "200": { - "$ref": "#/responses/FileDeleteResponse" - }, - "400": { - "$ref": "#/responses/error" - }, - "403": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/error" - }, - "422": { - "$ref": "#/responses/error" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ] - }, - "get": { - "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir.", - "operationId": "repoGetContents", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "type": "string", - "description": "path of the dir, file, symlink or submodule in the repo", - "name": "filepath", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "The name of the commit/branch/tag. Default to the repository’s default branch.", - "name": "ref", - "in": "query" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "200": { - "$ref": "#/responses/ContentsResponse" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "description": "This API follows GitHub's design, and it is not easy to use. Recommend users to use the \"contents-ext\" API instead.", - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ] } }, - "/repos/{owner}/group/{group_id}/{repo}/actions/artifacts/{artifact_id}": { - "get": { - "responses": { - "200": { - "$ref": "#/responses/Artifact" - }, - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Gets a specific artifact for a workflow run", - "operationId": "getArtifact", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repository", - "name": "repo" - }, - { - "type": "string", - "description": "id of the artifact", - "name": "artifact_id", - "in": "path", - "required": true - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ] - }, - "delete": { - "operationId": "deleteArtifact", - "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 - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "id of the artifact", - "name": "artifact_id" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Deletes a specific artifact for a workflow run" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/keys": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List a repository's keys", - "operationId": "repoListKeys", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "name": "key_id", - "in": "query", - "type": "integer", - "description": "the key_id to search for" - }, - { - "description": "fingerprint of the key", - "name": "fingerprint", - "in": "query", - "type": "string" - }, - { - "type": "integer", - "description": "page number of results to return (1-based)", - "name": "page", - "in": "query" - }, - { - "name": "limit", - "in": "query", - "type": "integer", - "description": "page size of results" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/DeployKeyList" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "post": { - "operationId": "repoCreateKey", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/CreateKeyOption" - } - }, - { - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true - } - ], - "responses": { - "201": { - "$ref": "#/responses/DeployKey" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Add a key to a repository" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/pulls": { - "get": { - "responses": { - "200": { - "$ref": "#/responses/PullRequestList" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "500": { - "$ref": "#/responses/error" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List a repo's pull requests", - "operationId": "repoListPullRequests", - "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": "Filter by target base branch of the pull request", - "name": "base_branch", - "in": "query" - }, - { - "default": "open", - "description": "State of pull request", - "name": "state", - "in": "query", - "enum": [ - "open", - "closed", - "all" - ], - "type": "string" - }, - { - "enum": [ - "oldest", - "recentupdate", - "recentclose", - "leastupdate", - "mostcomment", - "leastcomment", - "priority" - ], - "type": "string", - "description": "Type of sort", - "name": "sort", - "in": "query" - }, - { - "type": "integer", - "format": "int64", - "description": "ID of the milestone", - "name": "milestone", - "in": "query" - }, - { - "collectionFormat": "multi", - "description": "Label IDs", - "name": "labels", - "in": "query", - "type": "array", - "items": { - "format": "int64", - "type": "integer" - } - }, - { - "type": "string", - "description": "Filter by pull request author", - "name": "poster", - "in": "query" - }, - { - "name": "page", - "in": "query", - "minimum": 1, - "type": "integer", - "default": 1, - "description": "Page number of results to return (1-based)" - }, - { - "type": "integer", - "description": "Page size of results", - "name": "limit", - "in": "query", - "minimum": 0 - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ] - }, - "post": { - "operationId": "repoCreatePullRequest", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/CreatePullRequestOption" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "201": { - "$ref": "#/responses/PullRequest" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "409": { - "$ref": "#/responses/error" - }, - "422": { - "$ref": "#/responses/validationError" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Create a pull request" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/tag_protections/{id}": { - "get": { - "responses": { - "200": { - "$ref": "#/responses/TagProtection" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a specific tag protection for the repository", - "operationId": "repoGetTagProtection", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "description": "id of the tag protect to get", - "name": "id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ] - }, - "delete": { - "tags": [ - "repository" - ], - "summary": "Delete a specific tag protection for the repository", - "operationId": "repoDeleteTagProtection", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "required": true, - "type": "integer", - "description": "id of protected tag", - "name": "id", - "in": "path" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ] - }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}": { "patch": { - "tags": [ - "repository" - ], - "summary": "Edit a tag protections for a repository. Only fields that are set will be changed", - "operationId": "repoEditTagProtection", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "in": "path", - "required": true, - "type": "integer", - "description": "id of protected tag", - "name": "id" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/EditTagProtectionOption" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], "responses": { - "200": { - "$ref": "#/responses/TagProtection" + "201": { + "$ref": "#/responses/Issue" + }, + "403": { + "$ref": "#/responses/forbidden" }, "404": { "$ref": "#/responses/notFound" }, - "422": { - "$ref": "#/responses/validationError" - }, - "423": { - "$ref": "#/responses/repoArchivedError" + "412": { + "$ref": "#/responses/error" } }, "consumes": [ "application/json" ], - "produces": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/commits/{sha}/pull": { - "get": { - "responses": { - "200": { - "$ref": "#/responses/PullRequest" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, "produces": [ "application/json" ], "tags": [ - "repository" + "issue" ], - "summary": "Get the merged pull request of the commit", - "operationId": "repoGetCommitPullRequest", + "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.", + "operationId": "issueEditIssue", "parameters": [ { - "required": true, "type": "string", "description": "owner of the repo", "name": "owner", - "in": "path" + "in": "path", + "required": true }, { "type": "string", @@ -13211,102 +13881,285 @@ "required": true }, { - "type": "string", - "description": "SHA of the commit to get", - "name": "sha", - "in": "path", - "required": true - }, - { - "description": "group ID of the repo", - "name": "group_id", "type": "integer", "format": "int64", - "required": true, - "in": "path" - } - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/diffpatch": { - "post": { - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" + "description": "index of the issue to edit", + "name": "index", + "in": "path", + "required": true }, { "in": "body", - "required": true, "schema": { - "$ref": "#/definitions/ApplyDiffPatchFileOptions" + "$ref": "#/definitions/EditIssueOption" }, "name": "body" }, { + "name": "group_id", + "type": "integer", + "format": "int64", "required": true, "in": "path", + "description": "group ID of the repo" + } + ] + }, + "get": { + "responses": { + "200": { + "$ref": "#/responses/Issue" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Get an issue", + "operationId": "issueGetIssue", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "format": "int64", + "description": "index of the issue to get", + "name": "index", + "in": "path", + "required": true, + "type": "integer" + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ] + }, + "delete": { + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "tags": [ + "issue" + ], + "summary": "Delete an issue", + "operationId": "issueDelete", + "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 issue to delete", + "name": "index", + "in": "path", + "required": true + }, + { "description": "group ID of the repo", "name": "group_id", "type": "integer", - "format": "int64" + "format": "int64", + "required": true, + "in": "path" + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/assets": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "List issue's attachments", + "operationId": "issueListIssueAttachments", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the issue", + "name": "index" + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" } ], "responses": { "200": { - "$ref": "#/responses/FileResponse" + "$ref": "#/responses/AttachmentList" }, "404": { - "$ref": "#/responses/notFound" + "$ref": "#/responses/error" + } + } + }, + "post": { + "responses": { + "413": { + "$ref": "#/responses/error" + }, + "422": { + "$ref": "#/responses/validationError" }, "423": { "$ref": "#/responses/repoArchivedError" + }, + "201": { + "$ref": "#/responses/Attachment" + }, + "400": { + "$ref": "#/responses/error" + }, + "404": { + "$ref": "#/responses/error" } }, "consumes": [ + "multipart/form-data" + ], + "produces": [ "application/json" ], + "tags": [ + "issue" + ], + "summary": "Create an issue attachment", + "operationId": "issueCreateIssueAttachment", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the issue", + "name": "index" + }, + { + "description": "name of the attachment", + "name": "name", + "in": "query", + "type": "string" + }, + { + "required": true, + "type": "file", + "description": "attachment to upload", + "name": "attachment", + "in": "formData" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/hooks": { + "get": { "produces": [ "application/json" ], "tags": [ "repository" ], - "summary": "Apply diff patch to repository", - "operationId": "repoApplyDiffPatch" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/topics": { - "get": { - "tags": [ - "repository" - ], - "summary": "Get list of topics that a repository has", - "operationId": "repoListTopics", + "summary": "List the hooks in a repository", + "operationId": "repoListHooks", "parameters": [ { + "type": "string", + "description": "owner of the repo", "name": "owner", "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" + "required": true }, { - "name": "repo", - "in": "path", "required": true, "type": "string", - "description": "name of the repo" + "description": "name of the repo", + "name": "repo", + "in": "path" }, { "type": "integer", @@ -13320,160 +14173,6 @@ "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/TopicNames" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ] - }, - "put": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Replace list of topics for a repository", - "operationId": "repoUpdateTopics", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/RepoTopicOptions" - } - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/invalidTopicsError" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/pin": { - "post": { - "tags": [ - "issue" - ], - "summary": "Pin an Issue", - "operationId": "pinIssue", - "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 - }, - { - "required": true, - "type": "integer", - "format": "int64", - "description": "index of issue to pin", - "name": "index", - "in": "path" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "delete": { - "tags": [ - "issue" - ], - "summary": "Unpin an Issue", - "operationId": "unpinIssue", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "required": true, - "type": "integer", - "format": "int64", - "description": "index of issue to unpin", - "name": "index", - "in": "path" - }, { "format": "int64", "required": true, @@ -13484,11 +14183,60 @@ } ], "responses": { - "204": { - "$ref": "#/responses/empty" + "200": { + "$ref": "#/responses/HookList" }, - "403": { - "$ref": "#/responses/forbidden" + "404": { + "$ref": "#/responses/notFound" + } + } + }, + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Create a hook", + "operationId": "repoCreateHook", + "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 + }, + { + "in": "body", + "schema": { + "$ref": "#/definitions/CreateHookOption" + }, + "name": "body" + }, + { + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true + } + ], + "responses": { + "201": { + "$ref": "#/responses/Hook" }, "404": { "$ref": "#/responses/notFound" @@ -13496,13 +14244,10 @@ } } }, - "/repos/{owner}/group/{group_id}/{repo}/actions/workflows/{workflow_id}/disable": { - "put": { - "tags": [ - "repository" - ], - "summary": "Disable a workflow", - "operationId": "ActionsDisableWorkflow", + "/repos/{owner}/group/{group_id}/{repo}/push_mirrors": { + "get": { + "summary": "Get all push mirrors of the repository", + "operationId": "repoListPushMirrors", "parameters": [ { "name": "owner", @@ -13511,388 +14256,6 @@ "type": "string", "description": "owner of the repo" }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "name": "workflow_id", - "in": "path", - "required": true, - "type": "string", - "description": "id of the workflow" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "422": { - "$ref": "#/responses/validationError" - }, - "204": { - "description": "No Content" - }, - "400": { - "$ref": "#/responses/error" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/new_pin_allowed": { - "get": { - "tags": [ - "repository" - ], - "summary": "Returns if new Issue Pins are allowed", - "operationId": "repoNewPinAllowed", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "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/RepoNewIssuePinsAllowed" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/mirror-sync": { - "post": { - "summary": "Sync a mirrored repository", - "operationId": "repoMirrorSync", - "parameters": [ - { - "type": "string", - "description": "owner of the repo to sync", - "name": "owner", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "name of the repo to sync", - "name": "repo", - "in": "path", - "required": true - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/actions/secrets/{secretname}": { - "put": { - "operationId": "updateRepoSecret", - "parameters": [ - { - "type": "string", - "description": "owner of the repository", - "name": "owner", - "in": "path", - "required": true - }, - { - "required": true, - "type": "string", - "description": "name of the repository", - "name": "repo", - "in": "path" - }, - { - "type": "string", - "description": "name of the secret", - "name": "secretname", - "in": "path", - "required": true - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/CreateOrUpdateSecretOption" - } - }, - { - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true - } - ], - "responses": { - "201": { - "description": "response when creating a secret" - }, - "204": { - "description": "response when updating a secret" - }, - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Create or Update a secret value in a repository" - }, - "delete": { - "summary": "Delete a secret in a repository", - "operationId": "deleteRepoSecret", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repository", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repository", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "name of the secret", - "name": "secretname", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "204": { - "description": "delete one secret of the repository" - }, - "400": { - "$ref": "#/responses/error" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/actions/runs/{run}": { - "get": { - "tags": [ - "repository" - ], - "summary": "Gets a specific workflow run", - "operationId": "GetWorkflowRun", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repository" - }, - { - "type": "string", - "description": "id of the run", - "name": "run", - "in": "path", - "required": true - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/WorkflowRun" - }, - "400": { - "$ref": "#/responses/error" - } - }, - "produces": [ - "application/json" - ] - }, - "delete": { - "tags": [ - "repository" - ], - "summary": "Delete a workflow run", - "operationId": "deleteActionRun", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "description": "name of the repository", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "type": "integer", - "description": "runid of the workflow run", - "name": "run", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "400": { - "$ref": "#/responses/error" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}/requested_reviewers": { - "post": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "create review requests for a pull request", - "operationId": "repoCreatePullReviewRequests", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, { "in": "path", "required": true, @@ -13901,579 +14264,10 @@ "name": "repo" }, { - "name": "index", - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the pull request" - }, - { - "required": true, - "schema": { - "$ref": "#/definitions/PullReviewRequestOptions" - }, - "name": "body", - "in": "body" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "201": { - "$ref": "#/responses/PullReviewList" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - } - } - }, - "delete": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "cancel review requests for a pull request", - "operationId": "repoDeletePullReviewRequests", - "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 - }, - { - "name": "index", - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the pull request" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PullReviewRequestOptions" - } - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/git/tags/{sha}": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Gets the tag object of an annotated tag (not lightweight tags)", - "operationId": "GetAnnotatedTag", - "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": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.", - "name": "sha", - "in": "path", - "required": true - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/AnnotatedTag" - }, - "400": { - "$ref": "#/responses/error" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/archive/{archive}": { - "get": { - "operationId": "repoGetArchive", - "parameters": [ - { - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true, - "type": "string" - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "type": "string", - "description": "the git reference for download with attached archive format (e.g. master.zip)", - "name": "archive", - "in": "path", - "required": true - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "description": "success" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get an archive of a repository" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/media/{filepath}": { - "get": { - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "type": "string", - "description": "path of the file to get, it should be \"{ref}/{filepath}\". If there is no ref could be inferred, it will be treated as the default branch", - "name": "filepath", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "The name of the commit/branch/tag. Default to the repository’s default branch", - "name": "ref", - "in": "query" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "200": { - "description": "Returns raw file content.", - "schema": { - "type": "file" - } - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/octet-stream" - ], - "tags": [ - "repository" - ], - "summary": "Get a file or it's LFS object from a repository", - "operationId": "repoGetRawFileOrLFS" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/pulls/{index}": { - "get": { - "responses": { - "200": { - "$ref": "#/responses/PullRequest" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a pull request", - "operationId": "repoGetPullRequest", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the pull request to get", - "name": "index" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ] - }, - "patch": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.", - "operationId": "repoEditPullRequest", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "integer", - "format": "int64", - "description": "index of the pull request to edit", - "name": "index", - "in": "path", - "required": true - }, - { - "schema": { - "$ref": "#/definitions/EditPullRequestOption" - }, - "name": "body", - "in": "body" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "409": { - "$ref": "#/responses/error" - }, - "412": { - "$ref": "#/responses/error" - }, - "422": { - "$ref": "#/responses/validationError" - }, - "201": { - "$ref": "#/responses/PullRequest" - }, - "403": { - "$ref": "#/responses/forbidden" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/hooks/{id}": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a hook", - "operationId": "repoGetHook", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "name": "repo", - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo" - }, - { - "format": "int64", - "description": "id of the hook to get", - "name": "id", - "in": "path", - "required": true, - "type": "integer" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "200": { - "$ref": "#/responses/Hook" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - }, - "delete": { - "summary": "Delete a hook in a repository", - "operationId": "repoDeleteHook", - "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 - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "id of the hook to delete" - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "204": { - "$ref": "#/responses/empty" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ] - }, - "patch": { - "operationId": "repoEditHook", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path" - }, - { - "name": "id", - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "index of the hook" - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/EditHookOption" - } - }, - { - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer" - } - ], - "responses": { - "200": { - "$ref": "#/responses/Hook" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Edit a hook in a repository" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/subscribers": { - "get": { - "summary": "List a repo's watchers", - "operationId": "repoListSubscribers", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "in": "query", "type": "integer", "description": "page number of results to return (1-based)", - "name": "page" + "name": "page", + "in": "query" }, { "in": "query", @@ -14481,371 +14275,6 @@ "description": "page size of results", "name": "limit" }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "404": { - "$ref": "#/responses/notFound" - }, - "200": { - "$ref": "#/responses/UserList" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/actions/workflows/{workflow_id}/dispatches": { - "post": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Create a workflow dispatch event", - "operationId": "ActionsDispatchWorkflow", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, - { - "type": "string", - "description": "id of the workflow", - "name": "workflow_id", - "in": "path", - "required": true - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/CreateActionWorkflowDispatch" - } - }, - { - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id" - } - ], - "responses": { - "422": { - "$ref": "#/responses/validationError" - }, - "204": { - "description": "No Content" - }, - "400": { - "$ref": "#/responses/error" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/notifications": { - "put": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "notification" - ], - "summary": "Mark notification threads as read, pinned or unread on a specific repo", - "operationId": "notifyReadRepoList", - "parameters": [ - { - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "If true, mark all notifications on this repo. Default value is false", - "name": "all", - "in": "query" - }, - { - "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.", - "name": "status-types", - "in": "query", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "type": "string", - "description": "Status to mark notifications as. Defaults to read.", - "name": "to-status", - "in": "query" - }, - { - "format": "date-time", - "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.", - "name": "last_read_at", - "in": "query", - "type": "string" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ], - "responses": { - "205": { - "$ref": "#/responses/NotificationThreadList" - } - } - }, - "get": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "notification" - ], - "summary": "List users's notification threads on a specific repo", - "operationId": "notifyGetRepoList", - "parameters": [ - { - "required": true, - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path" - }, - { - "type": "string", - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true - }, - { - "in": "query", - "type": "boolean", - "description": "If true, show notifications marked as read. Default value is false", - "name": "all" - }, - { - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned", - "name": "status-types", - "in": "query", - "type": "array" - }, - { - "type": "array", - "items": { - "enum": [ - "issue", - "pull", - "commit", - "repository" - ], - "type": "string" - }, - "collectionFormat": "multi", - "description": "filter notifications by subject type", - "name": "subject-type", - "in": "query" - }, - { - "type": "string", - "format": "date-time", - "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format", - "name": "since", - "in": "query" - }, - { - "type": "string", - "format": "date-time", - "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format", - "name": "before", - "in": "query" - }, - { - "name": "page", - "in": "query", - "type": "integer", - "description": "page number of results to return (1-based)" - }, - { - "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/NotificationThreadList" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/actions/secrets": { - "get": { - "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": "page number of results to return (1-based)", - "name": "page", - "in": "query" - }, - { - "type": "integer", - "description": "page size of results", - "name": "limit", - "in": "query" - }, - { - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path", - "description": "group ID of the repo" - } - ], - "responses": { - "200": { - "$ref": "#/responses/SecretList" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "List an repo's actions secrets", - "operationId": "repoListActionsSecrets" - } - }, - "/repos/{owner}/group/{group_id}/{repo}/git/notes/{sha}": { - "get": { - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "Get a note corresponding to a single commit from a repository", - "operationId": "repoGetNote", - "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 - }, - { - "required": true, - "type": "string", - "description": "a git ref or commit sha", - "name": "sha", - "in": "path" - }, - { - "in": "query", - "type": "boolean", - "description": "include verification for every commit (disable for speedup, default 'true')", - "name": "verification" - }, - { - "in": "query", - "type": "boolean", - "description": "include a list of affected files for every commit (disable for speedup, default 'true')", - "name": "files" - }, { "format": "int64", "required": true, @@ -14855,176 +14284,6 @@ "type": "integer" } ], - "responses": { - "200": { - "$ref": "#/responses/Note" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "422": { - "$ref": "#/responses/validationError" - } - } - } - }, - "/repos/{owner}/group/{group_id}/{repo}/wiki/new": { - "post": { - "summary": "Create a wiki page", - "operationId": "repoCreateWikiPage", - "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 - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/CreateWikiPageOptions" - } - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], - "responses": { - "201": { - "$ref": "#/responses/WikiPage" - }, - "400": { - "$ref": "#/responses/error" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - }, - "423": { - "$ref": "#/responses/repoArchivedError" - } - }, - "consumes": [ - "application/json" - ], - "tags": [ - "repository" - ] - } - }, - "/repos/{owner}/group/{group_id}/{repo}/push_mirrors": { - "post": { - "responses": { - "200": { - "$ref": "#/responses/PushMirror" - }, - "400": { - "$ref": "#/responses/error" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "repository" - ], - "summary": "add a push mirror to the repository", - "operationId": "repoAddPushMirror", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "type": "string", - "description": "owner of the repo" - }, - { - "description": "name of the repo", - "name": "repo", - "in": "path", - "required": true, - "type": "string" - }, - { - "in": "body", - "schema": { - "$ref": "#/definitions/CreatePushMirrorOption" - }, - "name": "body" - }, - { - "required": true, - "in": "path", - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64" - } - ] - }, - "get": { - "operationId": "repoListPushMirrors", - "parameters": [ - { - "type": "string", - "description": "owner of the repo", - "name": "owner", - "in": "path", - "required": true - }, - { - "in": "path", - "required": true, - "type": "string", - "description": "name of the repo", - "name": "repo" - }, - { - "type": "integer", - "description": "page number of results to return (1-based)", - "name": "page", - "in": "query" - }, - { - "name": "limit", - "in": "query", - "type": "integer", - "description": "page size of results" - }, - { - "description": "group ID of the repo", - "name": "group_id", - "type": "integer", - "format": "int64", - "required": true, - "in": "path" - } - ], "responses": { "200": { "$ref": "#/responses/PushMirrorList" @@ -15044,8 +14303,749 @@ ], "tags": [ "repository" + ] + }, + "post": { + "consumes": [ + "application/json" ], - "summary": "Get all push mirrors of the repository" + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "add a push mirror to the repository", + "operationId": "repoAddPushMirror", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/CreatePushMirrorOption" + } + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "200": { + "$ref": "#/responses/PushMirror" + }, + "400": { + "$ref": "#/responses/error" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/wiki/revisions/{pageName}": { + "get": { + "summary": "Get revisions of a wiki page", + "operationId": "repoGetWikiPageRevisions", + "parameters": [ + { + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path" + }, + { + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "pageName", + "in": "path", + "required": true, + "type": "string", + "description": "name of the page" + }, + { + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query", + "type": "integer" + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "200": { + "$ref": "#/responses/WikiCommitList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/stargazers": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "List a repo's stargazers", + "operationId": "repoListStargazers", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path" + }, + { + "type": "integer", + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query" + }, + { + "in": "query", + "type": "integer", + "description": "page size of results", + "name": "limit" + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "200": { + "$ref": "#/responses/UserList" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/editorconfig/{filepath}": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get the EditorConfig definitions of a file in a repository", + "operationId": "repoGetEditorConfig", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "filepath of file to get", + "name": "filepath" + }, + { + "type": "string", + "description": "The name of the commit/branch/tag. Default to the repository’s default branch.", + "name": "ref", + "in": "query" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "success" + }, + "404": { + "$ref": "#/responses/notFound" + } + } + } + }, + "/repos/{owner}/group/{group_id}/{repo}/collaborators/{collaborator}": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Check if a user is a collaborator of a repository", + "operationId": "repoCheckCollaborator", + "parameters": [ + { + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "description": "username of the user to check for being a collaborator", + "name": "collaborator", + "in": "path", + "required": true, + "type": "string" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + } + } + }, + "put": { + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo", + "name": "owner" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "description": "username of the user to add or update as a collaborator", + "name": "collaborator", + "in": "path", + "required": true, + "type": "string" + }, + { + "in": "body", + "schema": { + "$ref": "#/definitions/AddCollaboratorOption" + }, + "name": "body" + }, + { + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id", + "type": "integer" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Add or Update a collaborator to a repository", + "operationId": "repoAddCollaborator" + }, + "delete": { + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Delete a collaborator from a repository", + "operationId": "repoDeleteCollaborator", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo", + "name": "repo" + }, + { + "type": "string", + "description": "username of the collaborator to delete", + "name": "collaborator", + "in": "path", + "required": true + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/issues/{index}/timeline": { + "get": { + "responses": { + "200": { + "$ref": "#/responses/TimelineList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "List all comments and events on an issue", + "operationId": "issueGetCommentsAndTimeline", + "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 + }, + { + "name": "index", + "in": "path", + "required": true, + "type": "integer", + "format": "int64", + "description": "index of the issue" + }, + { + "type": "string", + "format": "date-time", + "description": "if provided, only comments updated since the specified time are returned.", + "name": "since", + "in": "query" + }, + { + "type": "integer", + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query" + }, + { + "description": "page size of results", + "name": "limit", + "in": "query", + "type": "integer" + }, + { + "type": "string", + "format": "date-time", + "description": "if provided, only comments updated before the provided time are returned.", + "name": "before", + "in": "query" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}/milestones": { + "get": { + "operationId": "issueGetMilestonesList", + "parameters": [ + { + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "repo", + "in": "path", + "required": true, + "type": "string", + "description": "name of the repo" + }, + { + "name": "state", + "in": "query", + "type": "string", + "description": "Milestone state, Recognized values are open, closed and all. Defaults to \"open\"" + }, + { + "type": "string", + "description": "filter by milestone name", + "name": "name", + "in": "query" + }, + { + "description": "page number of results to return (1-based)", + "name": "page", + "in": "query", + "type": "integer" + }, + { + "description": "page size of results", + "name": "limit", + "in": "query", + "type": "integer" + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "200": { + "$ref": "#/responses/MilestoneList" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Get all of a repository's opened milestones" + }, + "post": { + "produces": [ + "application/json" + ], + "tags": [ + "issue" + ], + "summary": "Create a milestone", + "operationId": "issueCreateMilestone", + "parameters": [ + { + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true, + "type": "string" + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "in": "body", + "schema": { + "$ref": "#/definitions/CreateMilestoneOption" + }, + "name": "body" + }, + { + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo" + } + ], + "responses": { + "201": { + "$ref": "#/responses/Milestone" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "consumes": [ + "application/json" + ] + } + }, + "/repos/{owner}/group/{group_id}/{repo}": { + "get": { + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo" + }, + { + "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/Repository" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Get a repository", + "operationId": "repoGet" + }, + "delete": { + "summary": "Delete a repository", + "operationId": "repoDelete", + "parameters": [ + { + "in": "path", + "required": true, + "type": "string", + "description": "owner of the repo to delete", + "name": "owner" + }, + { + "description": "name of the repo to delete", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "description": "group ID of the repo", + "name": "group_id", + "type": "integer", + "format": "int64", + "required": true, + "in": "path" + } + ], + "responses": { + "204": { + "$ref": "#/responses/empty" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + } + }, + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ] + }, + "patch": { + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Edit a repository's properties. Only fields that are set will be changed.", + "operationId": "repoEdit", + "parameters": [ + { + "type": "string", + "description": "owner of the repo to edit", + "name": "owner", + "in": "path", + "required": true + }, + { + "description": "name of the repo to edit", + "name": "repo", + "in": "path", + "required": true, + "type": "string" + }, + { + "description": "Properties of a repo that you can edit", + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/EditRepoOption" + } + }, + { + "type": "integer", + "format": "int64", + "required": true, + "in": "path", + "description": "group ID of the repo", + "name": "group_id" + } + ], + "responses": { + "200": { + "$ref": "#/responses/Repository" + }, + "403": { + "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" + }, + "422": { + "$ref": "#/responses/validationError" + } + } } } } diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index a892491e1e..9ff4e8ed7b 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -41982,6 +41982,11 @@ "description": "IssueMeta basic issue information", "type": "object", "properties": { + "group_id": { + "type": "integer", + "format": "int64", + "x-go-name": "GroupID" + }, "index": { "type": "integer", "format": "int64",