Files
cnb/docs/api-groups/issues/api.json
2026-01-16 13:03:57 +08:00

1830 lines
47 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
{
"swagger": "2.0",
"info": {
"title": "CNB OPENAPI",
"contact": {
"name": "Open API Support",
"url": "https://docs.cnb.cool/",
"email": "cnb@tencent.com"
},
"version": "1.0"
},
"paths": {
"/{repo}/-/files/{filePath}": {
"delete": {
"security": [
{
"BearerAuth": []
}
],
"description": "删除 UploadFiles 上传的附件\n访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-manage:rw",
"tags": [
"Pulls",
"Issues"
],
"summary": "删除 UploadFiles 上传的附件",
"operationId": "DeleteRepoFiles",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "string",
"description": "文件访问链接的files后半部分比如链接是 https://cnb.cool/cnb/feedback/-/files/abc/1234abcd/test.zipfilePath 就是 abc/1234abcd/test.zip",
"name": "filePath",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/{repo}/-/imgs/{imgPath}": {
"delete": {
"security": [
{
"BearerAuth": []
}
],
"description": "删除 UploadImgs 上传的图片\n访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-manage:rw",
"tags": [
"Pulls",
"Issues"
],
"summary": "删除 UploadImgs 上传的图片",
"operationId": "DeleteRepoImgs",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "string",
"description": "图片访问链接的imgs后半部分比如链接是 https://cnb.cool/cnb/feedback/-/imgs/abc/1234abcd.pngimgPath 就是 abc/1234abcd.png",
"name": "imgPath",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/{repo}/-/issues": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "查询仓库的 Issues。List issues.",
"operationId": "ListIssues",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
"default": 1,
"description": "pagination page number. If the value is less than 1, it will automatically be adjusted to 1",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 30,
"description": "pagination page size. If the value is more than 100, it will automatically be adjusted to 100",
"name": "page_size",
"in": "query"
},
{
"type": "string",
"description": "issue state open or closed",
"name": "state",
"in": "query"
},
{
"type": "string",
"description": "issue search key",
"name": "keyword",
"in": "query"
},
{
"type": "string",
"description": "issue priority example: -1P, -2P, P0, P1, P2, P3",
"name": "priority",
"in": "query"
},
{
"type": "string",
"description": "issue labels example: git,bug,feature",
"name": "labels",
"in": "query"
},
{
"type": "string",
"description": "issue labels operator example: contains_any,contains_all default: contains_any",
"name": "labels_operator",
"in": "query"
},
{
"type": "string",
"description": "issue authors name, example: 张三,李四",
"name": "authors",
"in": "query"
},
{
"type": "string",
"description": "issue assignees name, example: 张三,李四,-; - means assign to nobody",
"name": "assignees",
"in": "query"
},
{
"type": "string",
"description": "issue filter update time begin example: 2022-01-31",
"name": "updated_time_begin",
"in": "query"
},
{
"type": "string",
"description": "issue filter update time end, example: 2022-01-31",
"name": "updated_time_end",
"in": "query"
},
{
"type": "string",
"description": "issue filter close time begin example: 2022-01-31",
"name": "close_time_begin",
"in": "query"
},
{
"type": "string",
"description": "issue filter close time end, example: 2022-01-31",
"name": "close_time_end",
"in": "query"
},
{
"type": "string",
"description": "issue order, example: created_at, -updated_at, reference_count。- prefix means descending order",
"name": "order_by",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/api.Issue"
}
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:r"
},
"post": {
"security": [
{
"BearerAuth": []
}
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "创建一个 Issue。Create an issue.",
"operationId": "CreateIssue",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"description": "Post Issue Form",
"name": "post_issue_form",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.PostIssueForm"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/api.IssueDetail"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:rw"
}
},
"/{repo}/-/issues/{number}": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "查询指定的 Issues。Get an issue.",
"operationId": "GetIssue",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "issue number",
"name": "number",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.IssueDetail"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:r"
},
"patch": {
"security": [
{
"BearerAuth": []
}
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "更新一个 Issue。Update an issue.",
"operationId": "UpdateIssue",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "issue number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Patch Issue Form",
"name": "patch_issue_form",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.PatchIssueForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.IssueDetail"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:rw"
}
},
"/{repo}/-/issues/{number}/assignees": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "查询指定 issue 的处理人。 List repository issue assignees.",
"operationId": "ListIssueAssignees",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "string",
"description": "issue number",
"name": "number",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/git_woa_com_cnb_monorepo_git_internal_app_vcs_service_bff_api.UserInfo"
}
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:r"
},
"post": {
"security": [
{
"BearerAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "添加处理人到指定的 issue。 Adds up to assignees to a issue, Users already assigned to an issue are not replaced.",
"operationId": "PostIssueAssignees",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "string",
"description": "issue number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Post Issue Assignees Form",
"name": "post_issue_assignees_form",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.PostIssueAssigneesForm"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/api.IssueDetail"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:rw"
},
"delete": {
"security": [
{
"BearerAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "删除 issue 中的处理人。 Removes one or more assignees from an issue.",
"operationId": "DeleteIssueAssignees",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "string",
"description": "issue number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Delete Issue Assignees Form",
"name": "delete_issue_assignees_form",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.DeleteIssueAssigneesForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.IssueDetail"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:rw"
},
"patch": {
"security": [
{
"BearerAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "更新 issue 中的处理人。 Updates the assignees of an issue.",
"operationId": "PatchIssueAssignees",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "string",
"description": "issue number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Patch Issue Assignees Form",
"name": "patch_issue_assignees_form",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.PatchIssueAssigneesForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.IssueDetail"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:rw"
}
},
"/{repo}/-/issues/{number}/assignees/{assignee}": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "检查用户是否可以被添加到 issue 的处理人中。 Checks if a user can be assigned to an issue.",
"operationId": "CanUserBeAssignedToIssue",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "string",
"description": "issue number",
"name": "number",
"in": "path",
"required": true
},
{
"type": "string",
"description": "assignee",
"name": "assignee",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:r"
}
},
"/{repo}/-/issues/{number}/comments": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "查询仓库的 issue 评论列表。List repository issue comments.",
"operationId": "ListIssueComments",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "issue number",
"name": "number",
"in": "path",
"required": true
},
{
"type": "integer",
"default": 1,
"description": "pagination page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 30,
"description": "pagination page size",
"name": "page_size",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/api.IssueComment"
}
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:r"
},
"post": {
"security": [
{
"BearerAuth": []
}
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "创建一个 issue 评论。Create an issue comment.",
"operationId": "PostIssueComment",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Post Issue Comment Form",
"name": "post_issue_comment_form",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.PostIssueCommentForm"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/api.IssueComment"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:rw"
}
},
"/{repo}/-/issues/{number}/comments/{comment_id}": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "获取指定 issue 评论。Get an issue comment.",
"operationId": "GetIssueComment",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "string",
"description": "number",
"name": "number",
"in": "path",
"required": true
},
{
"type": "string",
"description": "comment_id",
"name": "comment_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.IssueComment"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:r"
},
"patch": {
"security": [
{
"BearerAuth": []
}
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "修改一个 issue 评论。Update an issue comment.",
"operationId": "PatchIssueComment",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "number",
"name": "number",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "comment_id",
"name": "comment_id",
"in": "path",
"required": true
},
{
"description": "Patch Issue Comment Form",
"name": "patch_issue_comment_form",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.PatchIssueCommentForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.IssueComment"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:rw"
}
},
"/{repo}/-/issues/{number}/labels": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "查询 issue 的标签列表。List labels for an issue.",
"operationId": "ListIssueLabels",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "number",
"name": "number",
"in": "path",
"required": true
},
{
"type": "integer",
"default": 1,
"description": "pagination page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 30,
"description": "pagination page size",
"name": "page_size",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/api.Label"
}
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:r"
},
"put": {
"security": [
{
"BearerAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "设置 issue 标签。 Set the new labels for an issue.",
"operationId": "PutIssueLabels",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Put Issue Labels Form",
"name": "put_issue_labels_form",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.PutIssueLabelsForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.Label"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:rw"
},
"post": {
"security": [
{
"BearerAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "新增 issue 标签。Add labels to an issue.",
"operationId": "PostIssueLabels",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Post Issue Labels Form",
"name": "post_issue_labels_form",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.PostIssueLabelsForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.Label"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:rw"
},
"delete": {
"security": [
{
"BearerAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "清空 issue 标签。Remove all labels from an issue.",
"operationId": "DeleteIssueLabels",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "number",
"name": "number",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:rw"
}
},
"/{repo}/-/issues/{number}/labels/{name}": {
"delete": {
"security": [
{
"BearerAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "删除 issue 标签。Remove a label from an issue.",
"operationId": "DeleteIssueLabel",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "number",
"name": "number",
"in": "path",
"required": true
},
{
"type": "string",
"description": "label name",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.Label"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-notes:rw"
}
},
"/{repo}/-/issues/{number}/property": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "为指定Issue批量设置多个自定义属性的值key 不存在则创建,存在则更新\n访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-manage:rw",
"consumes": [
"application/json"
],
"produces": [
"application/vnd.cnb.api+json"
],
"tags": [
"Issues"
],
"summary": "批量设置Issue自定义属性值",
"operationId": "CreateIssueProperties",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "issue number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Issue Properties Form",
"name": "issue_properties_form",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openapi.IssuePropertiesForm"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/die.WebError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/die.WebError"
}
}
}
}
},
"/{repo}/-/upload/files": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Pulls",
"Issues"
],
"summary": "发起一个上传 files 的请求返回上传文件的url请使用 put 发起流式上传。Initiate a request to upload files,returns upload URL.Use PUT to initiate a stream upload.",
"operationId": "UploadFiles",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"description": "UploadRequestParams",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dto.UploadRequestParams"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/dto.UploadAssetsResponse"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-contents:rw"
}
},
"/{repo}/-/upload/imgs": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Pulls",
"Issues"
],
"summary": "发起一个上传 imgs 的请求返回上传文件的url请使用 put 发起流式上传。Initiate a request to upload images,returns upload URL.Use PUT to initiate a stream upload.",
"operationId": "UploadImgs",
"parameters": [
{
"type": "string",
"description": "repo",
"name": "repo",
"in": "path",
"required": true
},
{
"description": "UploadRequestParams",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dto.UploadRequestParams"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/dto.UploadAssetsResponse"
}
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-contents:rw"
}
}
},
"definitions": {
"api.Issue": {
"type": "object",
"properties": {
"assignees": {
"type": "array",
"items": {
"$ref": "#/definitions/git_woa_com_cnb_monorepo_git_internal_app_vcs_service_bff_api.UserInfo"
}
},
"author": {
"$ref": "#/definitions/git_woa_com_cnb_monorepo_git_internal_app_vcs_service_bff_api.UserInfo"
},
"comment_count": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"ended_at": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/api.Label"
}
},
"last_acted_at": {
"type": "string"
},
"number": {
"type": "string"
},
"priority": {
"type": "string"
},
"started_at": {
"type": "string"
},
"state": {
"type": "string"
},
"state_reason": {
"type": "string"
},
"title": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"die.WebError": {
"type": "object",
"properties": {
"errcode": {
"type": "integer"
},
"errmsg": {
"type": "string"
},
"errparam": {
"type": "object",
"additionalProperties": {}
}
}
},
"api.PostIssueForm": {
"type": "object",
"properties": {
"assignees": {
"type": "array",
"items": {
"type": "string"
}
},
"body": {
"type": "string"
},
"end_date": {
"type": "string"
},
"invisible": {
"description": "是否可见",
"type": "boolean"
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"priority": {
"description": "Priority of this issue. Can be one of: `-1P`, `-2P`, `P0`, `P1`, `P2`, `P3`, `\"\"`.",
"type": "string"
},
"start_date": {
"type": "string"
},
"title": {
"type": "string"
}
}
},
"api.IssueDetail": {
"type": "object",
"properties": {
"assignees": {
"type": "array",
"items": {
"$ref": "#/definitions/git_woa_com_cnb_monorepo_git_internal_app_vcs_service_bff_api.UserInfo"
}
},
"author": {
"$ref": "#/definitions/git_woa_com_cnb_monorepo_git_internal_app_vcs_service_bff_api.UserInfo"
},
"body": {
"type": "string"
},
"comment_count": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"ended_at": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/api.Label"
}
},
"last_acted_at": {
"type": "string"
},
"number": {
"type": "string"
},
"priority": {
"type": "string"
},
"started_at": {
"type": "string"
},
"state": {
"type": "string"
},
"state_reason": {
"type": "string"
},
"title": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"api.PatchIssueForm": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"end_date": {
"description": "end time",
"type": "string"
},
"priority": {
"description": "Priority of this issue. Can be one of: `-1P`, `-2P`, `P0`, `P1`, `P2`, `P3`, `\"\"`.",
"type": "string"
},
"start_date": {
"description": "start time",
"type": "string"
},
"state": {
"description": "State of this issue. Either `open` or `closed`.",
"type": "string"
},
"state_reason": {
"description": "StateReason can be one of: `completed`, `not_planned`, `reopened`",
"type": "string"
},
"title": {
"type": "string"
}
}
},
"git_woa_com_cnb_monorepo_git_internal_app_vcs_service_bff_api.UserInfo": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"api.PostIssueAssigneesForm": {
"type": "object",
"properties": {
"assignees": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"api.DeleteIssueAssigneesForm": {
"type": "object",
"properties": {
"assignees": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"api.PatchIssueAssigneesForm": {
"type": "object",
"properties": {
"assignees": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"api.IssueComment": {
"type": "object",
"properties": {
"author": {
"$ref": "#/definitions/git_woa_com_cnb_monorepo_git_internal_app_vcs_service_bff_api.UserInfo"
},
"body": {
"type": "string"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"api.PostIssueCommentForm": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"api.PatchIssueCommentForm": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"api.Label": {
"type": "object",
"properties": {
"color": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"api.PutIssueLabelsForm": {
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"api.PostIssueLabelsForm": {
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openapi.IssuePropertiesForm": {
"type": "object",
"properties": {
"properties": {
"type": "array",
"items": {
"$ref": "#/definitions/openapi.PropertyForm"
}
}
}
},
"dto.UploadRequestParams": {
"type": "object",
"properties": {
"ext": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"size": {
"type": "integer"
}
}
},
"dto.UploadAssetsResponse": {
"type": "object",
"properties": {
"assets": {
"$ref": "#/definitions/dto.Assets"
},
"form": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"token": {
"description": "后续调用 confirm 接口用的",
"type": "string"
},
"upload_url": {
"type": "string"
}
}
},
"dto.Assets": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"ext": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"path": {
"type": "string",
"example": "/{slug}/-/assets/xxx/xxx/xxxx-xxx.png"
},
"size": {
"type": "integer"
}
}
}
}
}