node-cnb
Version:
node sdk for cnb open api
2,025 lines (2,023 loc) • 272 kB
JavaScript
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
//#region \0rolldown/runtime.js
var __create = Object.create;
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __getProtoOf = Object.getPrototypeOf;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __copyProps = (to, from, except, desc) => {
if (from && typeof from === "object" || typeof from === "function") {
for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
key = keys[i];
if (!__hasOwnProp.call(to, key) && key !== except) {
__defProp(to, key, {
get: ((k) => from[k]).bind(null, key),
enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
});
}
}
}
return to;
};
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
value: mod,
enumerable: true
}) : target, mod));
//#endregion
let ky = require("ky");
ky = __toESM(ky);
//#region src/paths.json
var paths_default = {
"events.repo.get": {
"tags": ["Event"],
"summary": "获取仓库动态预签名地址，并返回内容。Get events pre-signed URL and return content.",
"operationId": "GetEvents",
"parameters": [{
"type": "string",
"description": "repo path",
"name": "repo",
"in": "path",
"required": true
}, {
"type": "string",
"description": "动态日期,支持按天或小时为维度获取,格式为yy-mm-dd-h or yy-mm-dd, eg:2025-09-11-5",
"name": "date",
"in": "path",
"required": true
}],
"responses": { "200": { "description": "OK" } },
"path": "/events/{repo}/-/{date}",
"method": "get"
},
"groups.post": {
"tags": ["Organizations"],
"summary": "创建新组织。Create new organization.",
"operationId": "CreateOrganization",
"parameters": [{
"description": "group information",
"name": "request",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/dto.CreateGroupReq" }
}],
"responses": { "201": { "description": "Created" } },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \ngroup-manage:rw",
"path": "/groups",
"method": "post"
},
"ranks.repo.annual.get": {
"tags": ["Rank"],
"summary": "获取公仓年榜",
"operationId": "GetRepoAnnualRank",
"parameters": [
{
"type": "string",
"default": "all-languages",
"description": "语言",
"name": "language",
"in": "query"
},
{
"enum": [
"KnowledgeBase",
"NPC",
"Skills"
],
"type": "string",
"description": "仓库类型",
"name": "flags",
"in": "query"
},
{
"type": "string",
"default": "",
"description": "年榜年份，格式为2006，不填默认为本年",
"name": "year",
"in": "query"
},
{
"type": "integer",
"default": 100,
"description": "排行前n名",
"name": "topN",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": { "$ref": "#/definitions/dto.GetRankResult" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-basic-info:r",
"path": "/ranks/repo/annual",
"method": "get"
},
"ranks.repo.daily.get": {
"tags": ["Rank"],
"summary": "获取公仓日榜",
"operationId": "GetRepoDailyRank",
"parameters": [
{
"type": "string",
"default": "all-languages",
"description": "语言",
"name": "language",
"in": "query"
},
{
"enum": [
"KnowledgeBase",
"NPC",
"Skills"
],
"type": "string",
"description": "仓库类型",
"name": "flags",
"in": "query"
},
{
"type": "string",
"description": "日榜日期，默认为昨天",
"name": "date",
"in": "query"
},
{
"type": "integer",
"default": 100,
"description": "排行前n名",
"name": "topN",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": { "$ref": "#/definitions/dto.GetRankResult" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-basic-info:r",
"path": "/ranks/repo/daily",
"method": "get"
},
"ranks.repo.languageList.get": {
"tags": ["Rank"],
"summary": "获取排行榜语言",
"operationId": "GetLanguageList",
"parameters": [{
"enum": [
"daily",
"weekly",
"monthly",
"annual"
],
"type": "string",
"description": "排行榜类型",
"name": "rankType",
"in": "query",
"required": true
}, {
"type": "string",
"description": "日期",
"name": "date",
"in": "query"
}],
"responses": { "200": {
"description": "OK",
"schema": { "$ref": "#/definitions/dto.RankLanguageList" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-basic-info:r",
"path": "/ranks/repo/language-list",
"method": "get"
},
"ranks.repo.monthly.get": {
"tags": ["Rank"],
"summary": "获取公仓月榜",
"operationId": "GetRepoMonthlyRank",
"parameters": [
{
"type": "string",
"default": "all-languages",
"description": "语言",
"name": "language",
"in": "query"
},
{
"enum": [
"KnowledgeBase",
"NPC",
"Skills"
],
"type": "string",
"description": "仓库类型",
"name": "flags",
"in": "query"
},
{
"type": "string",
"default": "",
"description": "月榜月份，格式为200601，不填默认为本月",
"name": "month",
"in": "query"
},
{
"type": "integer",
"default": 100,
"description": "排行前n名",
"name": "topN",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": { "$ref": "#/definitions/dto.GetRankResult" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-basic-info:r",
"path": "/ranks/repo/monthly",
"method": "get"
},
"ranks.repo.weekly.get": {
"tags": ["Rank"],
"summary": "获取公仓周榜",
"operationId": "GetRepoWeeklyRank",
"parameters": [
{
"type": "string",
"default": "all-languages",
"description": "语言",
"name": "language",
"in": "query"
},
{
"enum": [
"KnowledgeBase",
"NPC",
"Skills"
],
"type": "string",
"description": "仓库类型",
"name": "flags",
"in": "query"
},
{
"type": "string",
"default": "",
"description": "周榜周一日期，格式为20060102，不填默认为本周",
"name": "start",
"in": "query"
},
{
"type": "integer",
"default": 100,
"description": "排行前n名",
"name": "topN",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": { "$ref": "#/definitions/dto.GetRankResult" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-basic-info:r",
"path": "/ranks/repo/weekly",
"method": "get"
},
"search.npc.list": {
"tags": ["KnowledgeBase"],
"summary": "全局语义搜索 NPC 角色",
"operationId": "SearchNpc",
"parameters": [{
"type": "string",
"description": "搜索关键词",
"name": "key",
"in": "query",
"required": true
}, {
"type": "integer",
"description": "返回结果数量，最大20",
"name": "top_n",
"in": "query"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/dto.SearchNpcRes" }
}
},
"400": { "description": "Bad Request" },
"500": { "description": "Internal Server Error" }
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-basic-info:r,repo-code:r",
"path": "/search/npc",
"method": "get"
},
"search.publicRepos.list": {
"tags": ["Search"],
"summary": "Search resource with the key",
"operationId": "ListPublicRepos",
"parameters": [
{
"type": "string",
"description": "key",
"name": "key",
"in": "query"
},
{
"enum": [
"KnowledgeBase",
"NPC",
"Skills"
],
"type": "string",
"description": "仓库类型标记，逗号分隔。Repository type flags, comma separated",
"name": "flags",
"in": "query"
},
{
"enum": ["intersection", "union"],
"type": "string",
"default": "intersection",
"description": "flags 多值匹配模式。Flags match mode when multiple flags provided",
"name": "flags_match",
"in": "query"
},
{
"enum": [
"created_at",
"last_updated_at",
"stars",
"forks"
],
"type": "string",
"description": "排序类型，默认last_updated_at",
"name": "order_by",
"in": "query"
},
{
"type": "boolean",
"default": false,
"description": "排序顺序",
"name": "desc",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "排行前N位，默认10，最大值100",
"name": "topN",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/dto.Repos4UserBase" }
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-base-info:r",
"path": "/search/public-repos",
"method": "get"
},
"user.get": {
"tags": ["Users"],
"summary": "获取指定用户的详情信息。Get detailed information for a specified user.",
"operationId": "GetUserInfo",
"responses": { "200": {
"description": "OK",
"schema": { "$ref": "#/definitions/dto.UsersResult" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-profile:r",
"path": "/user",
"method": "get"
},
"user.post": {
"tags": ["Users"],
"summary": "更新指定用户的详情信息。Updates the specified user's profile information.",
"operationId": "UpdateUserInfo",
"parameters": [{
"description": "user info",
"name": "request",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/dto.UpdateUserInfoPayload" }
}],
"responses": { "200": { "description": "OK" } },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-profile:rw",
"path": "/user",
"method": "post"
},
"user.autocompleteSource.list": {
"tags": ["Users"],
"summary": "查询当前用户用户拥有指定权限的所有资源列表。List resources that the current user has specified permissions for.",
"operationId": "AutoCompleteSource",
"parameters": [
{
"enum": [
"Group",
"Repo",
"RootGroup"
],
"type": "string",
"default": "Group",
"description": "Source type",
"name": "source_type",
"in": "query"
},
{
"type": "integer",
"default": 1,
"description": "Pagination page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "Pagination page size",
"name": "page_size",
"in": "query"
},
{
"type": "string",
"default": "",
"description": "Filter by resources.",
"name": "search",
"in": "query"
},
{
"enum": [
"Guest",
"Reporter",
"Developer",
"Master",
"Owner"
],
"type": "string",
"default": "Owner",
"description": "最小仓库权限，默认owner。Minima repository permissions",
"name": "access",
"in": "query"
},
{
"enum": ["created_at", "slug_path"],
"type": "string",
"default": "created_at",
"description": "Order field",
"name": "order_by",
"in": "query"
},
{
"type": "boolean",
"default": false,
"description": "排序顺序。Ordering.",
"name": "desc",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "type": "string" }
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:r",
"path": "/user/autocomplete_source",
"method": "get"
},
"user.emails.get": {
"tags": ["Users"],
"summary": "获取用户邮箱列表",
"operationId": "ListEmail",
"responses": { "200": {
"description": "获取用户邮箱列表",
"schema": { "$ref": "#/definitions/dto.UserEmails" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-email:r",
"path": "/user/emails",
"method": "get"
},
"user.gpgKeys.get": {
"tags": ["Users"],
"summary": "获取用户 GPG keys 列表。List GPG Keys.",
"operationId": "ListGPGKeys",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "pagination page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "pagination page size",
"name": "page_size",
"in": "query"
},
{
"type": "string",
"description": "gpg search key",
"name": "keyword",
"in": "query"
}
],
"responses": {
"201": {
"description": "Created",
"schema": { "$ref": "#/definitions/api.GPGPublicKey" }
},
"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. \naccount-profile:r",
"path": "/user/gpg-keys",
"method": "get"
},
"user.groups.list": {
"tags": ["Organizations"],
"summary": "获取当前用户拥有权限的顶层组织列表。Get top-level organizations list that the current user has access to.",
"operationId": "ListTopGroups",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "Pagination page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "Pagination page size",
"name": "page_size",
"in": "query"
},
{
"type": "string",
"default": "",
"description": "Filter by organizations.",
"name": "search",
"in": "query"
},
{
"enum": [
"Guest",
"Reporter",
"Developer",
"Master",
"Owner"
],
"type": "string",
"description": "Filter by role.",
"name": "role",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/dto.OrganizationAccess" }
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:r",
"path": "/user/groups",
"method": "get"
},
"user.groups.listByGroup": {
"tags": ["Organizations"],
"summary": "查询当前用户在指定组织下拥有指定权限的子组织列表。Get the list of sub-organizations that the current user has access to in the specified organization.",
"operationId": "ListGroups",
"parameters": [
{
"type": "string",
"description": "Group slug",
"name": "slug",
"in": "path",
"required": true
},
{
"type": "integer",
"default": 1,
"description": "Pagination page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "Pagination page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "access level",
"name": "access",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/dto.OrganizationAccess" }
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:r",
"path": "/user/groups/{slug}",
"method": "get"
},
"user.issues.list": {
"tags": ["Issues"],
"summary": "查询当前用户相关的 Issues。List issues for the authenticated user across all repositories.",
"operationId": "ListUserIssues",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "分页页码，输入值小于1，则调整为1。",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "分页页大小，输入值小于0，则调整为10;输入值大于100，则调整为100。",
"name": "page_size",
"in": "query"
},
{
"type": "string",
"default": "assigned",
"description": "Issue筛选类型。可选值：`created`（我创建的）、`assigned`（分配给我的）",
"name": "filter",
"in": "query"
},
{
"type": "string",
"default": "open",
"description": "Issue状态过滤。可选值：`open`、`closed`",
"name": "state",
"in": "query"
},
{
"type": "string",
"description": "Issue优先级过滤。示例：`-2P,-1P,P0,P1,P2,P3`",
"name": "priority",
"in": "query"
},
{
"type": "string",
"description": "Issue标签过滤。示例：`git,bug,feature`",
"name": "labels",
"in": "query"
},
{
"type": "string",
"default": "contains_any",
"description": "标签过滤操作符。可选值：`contains_any`,`contains_all`",
"name": "labels_operator",
"in": "query"
},
{
"type": "string",
"description": "Issue更新时间范围开始。示例：`2022-01-31`",
"name": "updated_time_begin",
"in": "query"
},
{
"type": "string",
"description": "Issue更新时间范围结束。示例：`2022-02-16`",
"name": "updated_time_end",
"in": "query"
},
{
"type": "string",
"description": "Issue关闭时间范围开始。示例：`2022-01-31`",
"name": "close_time_begin",
"in": "query"
},
{
"type": "string",
"description": "Issue关闭时间范围结束。示例：`2022-02-16`",
"name": "close_time_end",
"in": "query"
},
{
"type": "string",
"default": "-created_at",
"description": "Issue排序字段，-前缀表示倒序。可选值：`created_at`,`-created_at`,`-updated_at`",
"name": "order_by",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/api.UserIssue" }
}
},
"401": {
"description": "Unauthorized",
"schema": { "$ref": "#/definitions/die.WebError" }
},
"500": {
"description": "Internal Server Error",
"schema": { "$ref": "#/definitions/die.WebError" }
}
},
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nrepo-issue:r",
"path": "/user/issues",
"method": "get"
},
"user.repos.list": {
"tags": ["Repositories"],
"summary": "获取当前用户拥有指定权限及其以上权限的仓库。List repositories owned by the current user with the specified permissions or higher.",
"operationId": "GetRepos",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "Pagination page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "Pagination page size",
"name": "page_size",
"in": "query"
},
{
"type": "string",
"default": "",
"description": "Filter by repositories",
"name": "search",
"in": "query"
},
{
"enum": [
"private",
"public",
"secret"
],
"type": "string",
"description": "RType",
"name": "filter_type",
"in": "query"
},
{
"enum": [
"Guest",
"Reporter",
"Developer",
"Master",
"Owner"
],
"type": "string",
"default": "Owner",
"description": "最小仓库权限，默认owner。Minima repository permissions",
"name": "role",
"in": "query"
},
{
"enum": [
"KnowledgeBase",
"NPC",
"Skills"
],
"type": "string",
"description": "仓库类型标记，逗号分隔。Repository type flags, comma separated",
"name": "flags",
"in": "query"
},
{
"enum": ["intersection", "union"],
"type": "string",
"default": "intersection",
"description": "flags 多值匹配模式。Flags match mode when multiple flags provided",
"name": "flags_match",
"in": "query"
},
{
"enum": ["active", "archived"],
"type": "string",
"description": "仓库状态。Repository status",
"name": "status",
"in": "query"
},
{
"enum": [
"created_at",
"last_updated_at",
"stars",
"slug_path",
"forks"
],
"type": "string",
"default": "last_updated_at",
"description": "Order field",
"name": "order_by",
"in": "query"
},
{
"type": "boolean",
"default": false,
"description": "排序顺序。Ordering.",
"name": "desc",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/dto.Repos4User" }
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:r",
"path": "/user/repos",
"method": "get"
},
"user.staredRepos.list": {
"tags": ["Starring"],
"summary": "获取当前用户 star 的仓库列表。List all stared repositories.",
"operationId": "GetUserAllStaredRepos",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "Pagination page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "Pagination page size",
"name": "page_size",
"in": "query"
},
{
"type": "string",
"default": "",
"description": "Filter by repositories",
"name": "search",
"in": "query"
},
{
"enum": [
"KnowledgeBase",
"NPC",
"Skills"
],
"type": "string",
"default": "",
"description": "仓库类型标记，逗号分隔。Repository type flags, comma separated",
"name": "flags",
"in": "query"
},
{
"enum": ["intersection", "union"],
"type": "string",
"default": "intersection",
"description": "flags 多值匹配模式。Flags match mode when multiple flags provided",
"name": "flags_match",
"in": "query"
},
{
"enum": ["active", "archived"],
"type": "string",
"description": "仓库状态。Repository status",
"name": "status",
"in": "query"
},
{
"type": "boolean",
"default": false,
"description": "排序顺序。Ordering.",
"name": "desc",
"in": "query"
},
{
"enum": [
"created_at",
"last_updated_at",
"stared_time",
"stars",
"forks"
],
"type": "string",
"default": "last_updated_at",
"description": "Order field",
"name": "order_by",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/dto.Repos4User" }
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:r",
"path": "/user/stared-repos",
"method": "get"
},
"users.get": {
"tags": ["Users"],
"summary": "获取指定用户的详情信息。Get detailed information for a specified user.",
"operationId": "GetUserInfoByName",
"parameters": [{
"type": "string",
"description": "User Name",
"name": "username",
"in": "path",
"required": true
}],
"responses": { "200": {
"description": "OK",
"schema": { "$ref": "#/definitions/dto.UsersResult" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-profile:r",
"path": "/users/{username}",
"method": "get"
},
"users.activities.get": {
"tags": ["Activities"],
"summary": "获取个人动态活跃详情汇总。Get user activities by date.",
"operationId": "GetUserActivitiesByDate",
"parameters": [{
"type": "string",
"description": "UserName",
"name": "username",
"in": "path",
"required": true
}, {
"type": "string",
"description": "查询日期，格式 yyyyMM，或者 yyyyMMdd",
"name": "date",
"in": "query"
}],
"responses": { "200": {
"description": "OK",
"schema": { "$ref": "#/definitions/dto.ActivityDate" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:r",
"path": "/users/{username}/activities",
"method": "get"
},
"users.followers.list": {
"tags": ["Followers"],
"summary": "获取指定用户的粉丝列表。Get the followers list of specified user.",
"operationId": "GetFollowersByUserID",
"parameters": [
{
"type": "string",
"description": "Username",
"name": "username",
"in": "path",
"required": true
},
{
"type": "integer",
"default": 1,
"description": "Pagination page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "Pagination page size",
"name": "page_size",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/dto.UserFollowResult" }
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:r",
"path": "/users/{username}/followers",
"method": "get"
},
"users.following.list": {
"tags": ["Followers"],
"summary": "获取指定用户的关注人列表。Get the list of users that the specified user is following.",
"operationId": "GetFollowingByUserID",
"parameters": [
{
"type": "string",
"description": "Username",
"name": "username",
"in": "path",
"required": true
},
{
"type": "integer",
"default": 1,
"description": "Pagination page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "Pagination page size",
"name": "page_size",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/dto.UserFollowResult" }
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:r",
"path": "/users/{username}/following",
"method": "get"
},
"users.groups.get": {
"tags": ["Organizations"],
"summary": "获取指定用户拥有权限的顶层组织列表。 Get a list of top-level organizations that the specified user has permissions to access.",
"operationId": "GetGroupsByUserID",
"parameters": [
{
"type": "string",
"description": "UserName",
"name": "username",
"in": "path",
"required": true
},
{
"type": "string",
"default": "",
"description": "Filter organizations.",
"name": "search",
"in": "query"
},
{
"type": "integer",
"default": 1,
"description": "Pagination page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "Pagination page size",
"name": "page_size",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": { "$ref": "#/definitions/dto.OrganizationUnion" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:r",
"path": "/users/{username}/groups",
"method": "get"
},
"users.pinnedRepos.list": {
"tags": ["Repositories"],
"summary": "获取指定用户的用户仓库墙。 Get a list of repositories that the specified user has pinned.",
"operationId": "GetPinnedRepoByID",
"parameters": [{
"type": "string",
"description": "User Name",
"name": "username",
"in": "path",
"required": true
}],
"responses": { "200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/dto.Repos4User" }
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:r",
"path": "/users/{username}/pinned-repos",
"method": "get"
},
"users.repoActivities.list": {
"tags": ["Activities"],
"summary": "个人仓库动态详情列表。List of personal repository activity details.",
"operationId": "GetUserRepoActivityDetails",
"parameters": [
{
"type": "string",
"description": "UserName",
"name": "username",
"in": "path",
"required": true
},
{
"enum": [
"issue",
"pull_request",
"code_review"
],
"type": "string",
"description": "activity type",
"name": "activityType",
"in": "path",
"required": true
},
{
"type": "string",
"description": "仓库路径",
"name": "slug",
"in": "query",
"required": true
},
{
"type": "string",
"description": "查询日期，格式 yyyyMM，或者 yyyyMMdd",
"name": "date",
"in": "query",
"required": true
}
],
"responses": { "200": {
"description": "返回 []dto.ActivityPullRequestDetail|[]dto.ActivityIssueDetail",
"schema": {
"type": "array",
"items": {}
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:r",
"path": "/users/{username}/repo-activities/{activityType}",
"method": "get"
},
"users.repos.list": {
"tags": ["Repositories"],
"summary": "获取指定用户有指定以上权限并且客人态可见的仓库。List repositories where the specified user has the specified permission level or higher and are visible to guests.",
"operationId": "GetReposByUserName",
"parameters": [
{
"type": "string",
"description": "UserName",
"name": "username",
"in": "path",
"required": true
},
{
"type": "string",
"default": "",
"description": "Filter by repositories",
"name": "search",
"in": "query"
},
{
"enum": [
"private",
"public",
"secret"
],
"type": "string",
"description": "Repositories type",
"name": "filter_type",
"in": "query"
},
{
"enum": [
"KnowledgeBase",
"NPC",
"Skills"
],
"type": "string",
"description": "仓库类型标记，逗号分隔。Repository type flags, comma separated",
"name": "flags",
"in": "query"
},
{
"enum": ["intersection", "union"],
"type": "string",
"default": "intersection",
"description": "flags 多值匹配模式。Flags match mode when multiple flags provided",
"name": "flags_match",
"in": "query"
},
{
"enum": ["active", "archived"],
"type": "string",
"description": "仓库状态。Repository status",
"name": "status",
"in": "query"
},
{
"enum": [
"Guest",
"Reporter",
"Developer",
"Master",
"Owner"
],
"type": "string",
"default": "Owner",
"description": "最小仓库权限，默认owner。Minima repository permissions.",
"name": "role",
"in": "query"
},
{
"type": "integer",
"default": 1,
"description": "Pagination page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "Pagination page size",
"name": "page_size",
"in": "query"
},
{
"type": "boolean",
"default": false,
"description": "排序顺序。Ordering.",
"name": "desc",
"in": "query"
},
{
"enum": [
"created_at",
"last_updated_at",
"stars",
"slug_path",
"forks"
],
"type": "string",
"default": "last_updated_at",
"description": "Order field",
"name": "order_by",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/dto.Repos4User" }
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:r",
"path": "/users/{username}/repos",
"method": "get"
},
"users.staredRepos.list": {
"tags": ["Starring"],
"summary": "获取指定用户的 star 仓库列表。Get the list of repositories starred by the specified user.",
"operationId": "GetUserStaredRepos",
"parameters": [
{
"type": "string",
"description": "UserName",
"name": "username",
"in": "path",
"required": true
},
{
"type": "string",
"default": "",
"description": "过滤仓库。Filter by repositories",
"name": "search",
"in": "query"
},
{
"enum": [
"KnowledgeBase",
"NPC",
"Skills"
],
"type": "string",
"default": "",
"description": "仓库类型标记，逗号分隔。Repository type flags, comma separated",
"name": "flags",
"in": "query"
},
{
"enum": ["intersection", "union"],
"type": "string",
"default": "intersection",
"description": "flags 多值匹配模式。Flags match mode when multiple flags provided",
"name": "flags_match",
"in": "query"
},
{
"enum": ["active", "archived"],
"type": "string",
"description": "仓库状态。Repository status",
"name": "status",
"in": "query"
},
{
"type": "integer",
"default": 1,
"description": "Pagination page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "Pagination page size",
"name": "page_size",
"in": "query"
},
{
"type": "boolean",
"default": false,
"description": "Ordering",
"name": "desc",
"in": "query"
},
{
"enum": [
"created_at",
"last_updated_at",
"stars",
"forks"
],
"type": "string",
"default": "last_updated_at",
"description": "Order field",
"name": "order_by",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/dto.Repos4User" }
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:r",
"path": "/users/{username}/stared-repos",
"method": "get"
},
"workspace.delete.post": {
"tags": ["Workspace"],
"summary": "删除我的云原生开发环境。Delete my workspace.",
"operationId": "DeleteWorkspace",
"parameters": [{
"description": "params",
"name": "request",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/dto.WorkspaceDeleteReq" }
}],
"responses": { "200": {
"description": "OK",
"schema": { "$ref": "#/definitions/dto.WorkspaceDeleteResult" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:rw",
"path": "/workspace/delete",
"method": "post"
},
"workspace.list.get": {
"tags": ["Workspace"],
"summary": "获取我的云原生开发环境列表。List my workspaces.",
"operationId": "ListWorkspaces",
"parameters": [
{
"type": "string",
"description": "Git branch name, e.g. \"main\"",
"name": "branch",
"in": "query"
},
{
"type": "string",
"description": "查询结束时间。Query end time. format YYYY-MM-DD HH:mm:ssZZ, e.g. 2024-12-01 00:00:00+0800",
"name": "end",
"in": "query"
},
{
"type": "integer",
"description": "Pagination page number, default(1)",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "Pagination page size, default(20), max(100)",
"name": "page_size",
"in": "query"
},
{
"type": "string",
"description": "Repository path, e.g. \"groupname/reponame\"",
"name": "slug",
"in": "query"
},
{
"type": "string",
"description": "查询开始时间。Query start time. format YYYY-MM-DD HH:mm:ssZZ, e.g. 2024-12-01 00:00:00+0800",
"name": "start",
"in": "query"
},
{
"type": "string",
"description": "开发环境状态，running: 开发环境已启动，closed：开发环境已关闭。Workspace status: \"running\" for started, \"closed\" for stopped.",
"name": "status",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": { "$ref": "#/definitions/dto.WorkspaceListResult" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:r",
"path": "/workspace/list",
"method": "get"
},
"workspace.stop.post": {
"tags": ["Workspace"],
"summary": "停止/关闭我的云原生开发环境。Stop/close my workspace.",
"operationId": "WorkspaceStop",
"parameters": [{
"description": "params",
"name": "request",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/dto.WorkspaceStopReq" }
}],
"responses": { "200": {
"description": "OK",
"schema": { "$ref": "#/definitions/dto.WorkspaceStopResult" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \naccount-engage:rw",
"path": "/workspace/stop",
"method": "post"
},
"group.get": {
"tags": ["Organizations"],
"summary": "获取指定组织信息。Get information for the specified organization.",
"operationId": "GetGroup",
"parameters": [{
"type": "string",
"description": "group path",
"name": "group",
"in": "path",
"required": true
}],
"responses": { "200": {
"description": "group",
"schema": { "$ref": "#/definitions/dto.OrganizationAccess" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \ngroup-resource:r",
"path": "/{group}",
"method": "get"
},
"group.put": {
"tags": ["Organizations"],
"summary": "更新组织信息, 可更新的内容为: 组织描述, 组织展示名称, 组织网站, 组织联系邮箱。Updates organization information including: description, display name, website URL and contact email.",
"operationId": "UpdateOrganization",
"parameters": [{
"type": "string",
"description": "slug",
"name": "group",
"in": "path",
"required": true
}, {
"description": "group information to update",
"name": "request",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/dto.UpdateGroupReq" }
}],
"responses": { "200": { "description": "OK" } },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \ngroup-manage:rw",
"path": "/{group}",
"method": "put"
},
"group.delete": {
"tags": ["Organizations"],
"summary": "删除指定组织。Delete the specified organization.",
"operationId": "DeleteOrganization",
"parameters": [{
"type": "string",
"description": "group path",
"name": "group",
"in": "path",
"required": true
}, {
"type": "string",
"description": "微信身份验证票据，首次请求不传会返回新票据。WeChat auth ticket, will return new ticket if not provided in first request.",
"name": "x-cnb-identity-ticket",
"in": "header"
}],
"responses": { "200": { "description": "OK" } },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \ngroup-delete:rw",
"path": "/{group}",
"method": "delete"
},
"group.inheritMembers.list": {
"tags": ["Members"],
"summary": "获取指定组织的继承成员。List inherited members within specified organization",
"operationId": "ListInheritMembersOfGroup",
"parameters": [
{
"type": "string",
"description": "slug",
"name": "group",
"in": "path",
"required": true
},
{
"type": "string",
"default": "",
"description": "过滤成员。Filter by member",
"name": "search",
"in": "query"
},
{
"enum": [
"Guest",
"Reporter",
"Developer",
"Master",
"Owner"
],
"type": "string",
"description": "Role",
"name": "role",
"in": "query"
},
{
"type": "integer",
"default": 1,
"description": "Pagination page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "Pagination page size",
"name": "page_size",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/dto.ListInheritMembers" }
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \ngroup-manage:r",
"path": "/{group}/-/inherit-members",
"method": "get"
},
"group.members.list": {
"tags": ["Members"],
"summary": "获取指定组织内的所有直接成员。List all direct members within specified organization.",
"operationId": "ListMembersOfGroup",
"parameters": [
{
"type": "string",
"description": "slug",
"name": "group",
"in": "path",
"required": true
},
{
"type": "integer",
"default": 1,
"description": "Pagination page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "Pagination page size",
"name": "page_size",
"in": "query"
},
{
"enum": [
"Guest",
"Reporter",
"Developer",
"Master",
"Owner"
],
"type": "string",
"description": "Role",
"name": "role",
"in": "query"
},
{
"type": "string",
"default": "",
"description": "过滤成员。Filter by member.",
"name": "search",
"in": "query"
}
],
"responses": { "200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/dto.UsersWithAccessLevelInSlug" }
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \ngroup-manage:r",
"path": "/{group}/-/members",
"method": "get"
},
"group.members.accessLevel.get": {
"tags": ["Members"],
"summary": "获取指定组织内, 访问成员在当前层级内的权限信息。Get permission information for accessing members at current level.",
"operationId": "GetMemberAccessLevelOfGroup",
"parameters": [{
"type": "string",
"description": "slug",
"name": "group",
"in": "path",
"required": true
}, {
"type": "boolean",
"default": true,
"description": "是否包含继承的权限。If inherited permissions are included.",
"name": "include_inherit",
"in": "query"
}],
"responses": { "200": {
"description": "OK",
"schema": { "$ref": "#/definitions/dto.MemberAccessLevelInSlugUnion" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \ngroup-manage:r",
"path": "/{group}/-/members/access-level",
"method": "get"
},
"group.members.put": {
"tags": ["Members"],
"summary": "更新指定组织的直接成员权限信息。Update permission information for direct members in specified organization.",
"operationId": "UpdateMembersOfGroup",
"parameters": [
{
"type": "string",
"description": "slug",
"name": "group",
"in": "path",
"required": true
},
{
"type": "string",
"description": "username",
"name": "username",
"in": "path",
"required": true
},
{
"description": "member information",
"name": "request",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/dto.UpdateMembersRequest" }
}
],
"responses": { "200": { "description": "OK" } },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \ngroup-manage:rw",
"path": "/{group}/-/members/{username}",
"method": "put"
},
"group.members.post": {
"tags": ["Members"],
"summary": "添加成员。Add members.",
"operationId": "AddMembersOfGroup",
"parameters": [
{
"type": "string",
"description": "slug",
"name": "group",
"in": "path",
"required": true
},
{
"type": "string",
"description": "username",
"name": "username",
"in": "path",
"required": true
},
{
"description": "member information",
"name": "request",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/dto.UpdateMembersRequest" }
}
],
"responses": { "200": { "description": "OK" } },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \ngroup-manage:rw",
"path": "/{group}/-/members/{username}",
"method": "post"
},
"group.members.delete": {
"tags": ["Members"],
"summary": "删除指定组织的直接成员。Remove direct members from specified organization.",
"operationId": "DeleteMembersOfGroup",
"parameters": [{
"type": "string",
"description": "slug",
"name": "group",
"in": "path",
"required": true
}, {
"type": "string",
"description": "username",
"name": "username",
"in": "path",
"required": true
}],
"responses": { "200": { "description": "OK" } },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \ngroup-manage:rw",
"path": "/{group}/-/members/{username}",
"method": "delete"
},
"group.members.accessLevel.list": {
"tags": ["Members"],
"summary": "获取指定组织内指定成员的权限信息, 结果按组织层级来展示, 包含上层组织的权限继承信息。Get specified member's permissions with organizational hierarchy.",
"operationId": "ListMemberAccessLevelOfGroup",
"parameters": [{
"type": "string",
"description": "slug",
"name": "group",
"in": "path",
"required": true
}, {
"type": "string",
"description": "username",
"name": "username",
"in": "path",
"required": true
}],
"responses": { "200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/dto.MemberAccessLevel" }
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \ngroup-manage:r",
"path": "/{group}/-/members/{username}/access-level",
"method": "get"
},
"group.transfer.post": {
"tags": ["Organizations"],
"summary": "转移组织。Transfer an organization.",
"operationId": "TransferGroup",
"parameters": [{
"type": "string",
"description": "slug",
"name": "group",
"in": "path",
"required": true
}, {
"description": "request",
"name": "request",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/dto.TransferSlugReq" }
}],
"responses": { "200": { "description": "OK" } },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \ngroup-manage:rw",
"path": "/{group}/-/transfer",
"method": "post"
},
"group.upload.logos.post": {
"tags": ["Organizations"],
"summary": "发起一个上传 logo 的请求，返回上传文件的url，请使用 put 发起流式上传。Initiate a request to upload logo,returns upload URL.Use PUT to initiate a stream upload.",
"operationId": "UploadLogos",
"parameters": [{
"type": "string",
"description": "group",
"name": "group",
"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. \ngroup-manage:rw",
"path": "/{group}/-/upload/logos",
"method": "post"
},
"mission.delete": {
"tags": ["Missions"],
"summary": "删除指定任务集。Delete the specified mission.",
"operationId": "DeleteMission",
"parameters": [{
"type": "string",
"description": "mission path",
"name": "mission",
"in": "path",
"required": true
}, {
"type": "string",
"description": "微信身份验证票据，首次请求不传会返回新票据。WeChat auth ticket, will return new ticket if not provided in first request.",
"name": "x-cnb-identity-ticket",
"in": "header"
}],
"responses": { "200": { "description": "OK" } },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nmission-delete:rw",
"path": "/{mission}",
"method": "delete"
},
"mission.members.post": {
"tags": ["Members"],
"summary": "添加成员。Add members.",
"operationId": "AddMembersOfMission",
"parameters": [
{
"type": "string",
"description": "slug",
"name": "mission",
"in": "path",
"required": true
},
{
"type": "string",
"description": "username",
"name": "username",
"in": "path",
"required": true
},
{
"description": "member information",
"name": "request",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/dto.UpdateMembersRequest" }
}
],
"responses": { "200": { "description": "OK" } },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nmission-manage:rw",
"path": "/{mission}/-/members/{username}",
"method": "post"
},
"mission.mission.view.get": {
"tags": ["Missions"],
"summary": "查询任务集视图配置信息。Get mission view config.",
"operationId": "GetMissionViewConfig",
"parameters": [{
"type": "string",
"description": "Mission slug",
"name": "mission",
"in": "path",
"required": true
}, {
"type": "string",
"description": "View ID",
"name": "id",
"in": "query",
"required": true
}],
"responses": { "200": {
"description": "OK",
"schema": { "$ref": "#/definitions/dto.MissionViewConfig" }
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nmission-manage:r",
"path": "/{mission}/-/mission/view",
"method": "get"
},
"mission.mission.view.post": {
"tags": ["Missions"],
"summary": "设置任务集视图配置信息。Set mission view config.",
"operationId": "PostMissionViewConfig",
"parameters": [{
"type": "string",
"description": "Mission slug",
"name": "mission",
"in": "path",
"required": true
}, {
"description": "Params",
"name": "request",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/dto.MissionViewConfig" }
}],
"responses": { "200": { "description": "OK" } },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nmission-manage:rw",
"path": "/{mission}/-/mission/view",
"method": "post"
},
"mission.mission.viewList.list": {
"tags": ["Missions"],
"summary": "获取任务集视图列表。Get view list of a mission.",
"operationId": "GetMissionViewList",
"parameters": [{
"type": "string",
"description": "mission",
"name": "mission",
"in": "path",
"required": true
}],
"responses": { "200": {
"description": "OK",
"schema": {
"type": "array",
"items": { "$ref": "#/definitions/dto.MissionView" }
}
} },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nmission-manage:r",
"path": "/{mission}/-/mission/view-list",
"method": "get"
},
"mission.mission.viewList.put": {
"tags": ["Missions"],
"summary": "添加、修改任务集视图。Update a mission view or add a new one.",
"operationId": "PutMissionViewList",
"parameters": [{
"type": "string",
"description": "Mission slug",
"name": "mission",
"in": "path",
"required": true
}, {
"description": "Params",
"name": "request",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/dto.MissionView" }
}],
"responses": { "200": { "description": "OK" } },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nmission-manage:rw",
"path": "/{mission}/-/mission/view-list",
"method": "put"
},
"mission.mission.viewList.post": {
"tags": ["Missions"],
"summary": "排序任务集视图。Sort mission view list.",
"operationId": "PostMissionViewList",
"parameters": [{
"type": "string",
"description": "Mission slug",
"name": "mission",
"in": "path",
"required": true
}, {
"description": "Params",
"name": "request",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/dto.MissionPostViewReq" }
}],
"responses": { "200": { "description": "OK" } },
"description": "访问令牌调用此接口需包含以下权限。Required permissions for access token. \nmission-manage:rw",
"path": "/{mission}/-/mission/view-list",
"method": "post"
},
"mission.settings.setVisibility.post": {
"tags": ["Missions"],
"summary": "改变任务集可见性。Update the visibility of a mission.",
"operationId": "SetMissionVisibility",
"parameters": [{
"type": "string",
"description": "mission path",
"name": "mission",
"in": "path",
"required": true
}, {
"enum": ["Private", "Public"],
"type": "string",
"description": "任务集可见性",
"name": "visibility",
"in": "query",
"required": true
}],