feat(api): 从 OpenAPI 生成 TypeScript 类型包(6 模块 + base + barrel)

This commit is contained in:
zizi 2026-05-24 14:14:22 +08:00
parent af2b2b1ba3
commit ebe439e419
8 changed files with 3378 additions and 0 deletions

View File

@ -0,0 +1,343 @@
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/app-api/account/entitlements": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取当前用户权益列表 */
get: operations["listEntitlements"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/account/quotas": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取当前用户配额 */
get: operations["listQuotas"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/account/usage/summary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取用量摘要 */
get: operations["getUsageSummary"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/account/usage/tokens": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取 Token 用量明细 */
get: operations["getTokenUsage"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/account/security-events": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取安全事件列表 */
get: operations["listSecurityEvents"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/admin-api/account/entitlements/{userId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 查看用户权益(管理端) */
get: operations["adminGetUserEntitlements"];
/** 修改用户权益(管理端) */
put: operations["adminUpdateUserEntitlements"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
Entitlement: {
/** Format: uuid */
id: string;
/** @description 权益资源类型 */
resourceType: string;
/** @description 额度上限(-1 表示无限制) */
limit: number;
/** @description 已使用量 */
used: number;
/** Format: date-time */
expiresAt: string;
};
Quota: {
/** Format: uuid */
id: string;
resourceType: string;
total: number;
remaining: number;
/**
* Format: date-time
* @description 配额重置时间
*/
resetAt: string;
};
UsageSummary: {
totalTokens?: number;
totalGenerations?: number;
/** @description 按模型的用量分布 */
byModel?: Record<string, never>;
byDate?: {
/** Format: date */
date?: string;
tokens?: number;
generations?: number;
}[];
};
CommonResult: {
/**
* @description 业务状态码,0 表示成功
* @example 0
*/
code: number;
/**
* @description 提示信息
* @example 操作成功
*/
message: string;
/** @description 响应数据,类型视具体接口而定 */
data?: unknown;
};
};
responses: never;
parameters: {
/** @description 页码,从 1 开始 */
pageNo: number;
/** @description 每页条数,上限 100 */
pageSize: number;
};
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
listEntitlements: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 权益列表 */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"] & {
data?: components["schemas"]["Entitlement"][];
};
};
};
};
};
listQuotas: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 配额列表 */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"] & {
data?: components["schemas"]["Quota"][];
};
};
};
};
};
getUsageSummary: {
parameters: {
query?: {
period?: "today" | "week" | "month" | "billing_cycle";
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 用量摘要 */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"] & {
data?: components["schemas"]["UsageSummary"];
};
};
};
};
};
getTokenUsage: {
parameters: {
query?: {
startDate?: string;
endDate?: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Token 用量明细 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
listSecurityEvents: {
parameters: {
query?: {
/** @description 页码,从 1 开始 */
pageNo?: components["parameters"]["pageNo"];
/** @description 每页条数,上限 100 */
pageSize?: components["parameters"]["pageSize"];
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 安全事件分页列表 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminGetUserEntitlements: {
parameters: {
query?: never;
header?: never;
path: {
userId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 用户权益详情 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminUpdateUserEntitlements: {
parameters: {
query?: never;
header?: never;
path: {
userId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
entitlements: {
resourceType?: string;
limit?: number;
/** Format: date-time */
expiresAt?: string;
}[];
/** @description 变更原因(写入审计日志) */
reason?: string;
};
};
};
responses: {
/** @description 更新成功 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
}

View File

@ -0,0 +1,811 @@
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/app-api/ai/generations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** 提交 AI 生成请求 */
post: operations["requestGeneration"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/ai/generations/{generationId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取生成任务状态 */
get: operations["getGenerationStatus"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/ai/generations/{generationId}/stream": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** AI 生成 SSE 流 */
get: operations["streamGeneration"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/ai/candidates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取候选列表 */
get: operations["listCandidates"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/ai/candidates/{candidateId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取候选详情 */
get: operations["getCandidate"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/ai/candidates/{candidateId}/accept": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** 接受候选 */
post: operations["acceptCandidate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/ai/candidates/{candidateId}/reject": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** 拒绝候选 */
post: operations["rejectCandidate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/ai/agents": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取智能体列表 */
get: operations["listAgents"];
put?: never;
/** 创建自定义智能体 */
post: operations["createAgent"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/ai/agents/{agentId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取智能体详情 */
get: operations["getAgent"];
/** 更新智能体配置 */
put: operations["updateAgent"];
post?: never;
/** 删除自定义智能体 */
delete: operations["deleteAgent"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/admin-api/ai/prompt-templates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取 Prompt 模板列表(管理端) */
get: operations["adminListPromptTemplates"];
put?: never;
/** 创建 Prompt 模板(管理端) */
post: operations["adminCreatePromptTemplate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/admin-api/ai/prompt-templates/{templateId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** 更新 Prompt 模板(管理端) */
put: operations["adminUpdatePromptTemplate"];
post?: never;
/** 删除 Prompt 模板(管理端) */
delete: operations["adminDeletePromptTemplate"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/admin-api/ai/quality-gates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取质量门控维度列表 */
get: operations["adminListQualityGates"];
put?: never;
/** 创建质量门控维度 */
post: operations["adminCreateQualityGate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/admin-api/ai/protection-nodes": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取保护节点列表 */
get: operations["adminListProtectionNodes"];
put?: never;
/** 注册保护节点 */
post: operations["adminCreateProtectionNode"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
Generation: {
/** Format: uuid */
id: string;
/** Format: uuid */
blockId: string;
/** Format: uuid */
agentId: string;
/** @enum {string} */
status: "pending" | "streaming" | "completed" | "failed";
/**
* Format: uuid
* @description 生成完成后关联的候选 ID
*/
candidateId?: string;
errorMessage?: string;
/** Format: date-time */
createdAt: string;
};
Candidate: {
/** Format: uuid */
id: string;
/** Format: uuid */
blockId: string;
/** Format: uuid */
generationId: string;
/** Format: uuid */
agentId?: string;
agentName?: string;
/** @enum {string} */
status: "pending" | "accepted" | "rejected";
/** @description 生成时的源 Block 版本号 */
sourceVersion?: number;
/** @description 变更摘要 */
diffSummary?: string;
/** @description 各质量维度的评分 */
qualityScores?: Record<string, never>;
/** Format: date-time */
createdAt: string;
};
CommonResult: {
/**
* @description 业务状态码,0 表示成功
* @example 0
*/
code: number;
/**
* @description 提示信息
* @example 操作成功
*/
message: string;
/** @description 响应数据,类型视具体接口而定 */
data?: unknown;
};
ErrorResponse: {
/**
* @description 错误码格式: {system}-{module}-{category}-{sequence}
* 示例: MUSE-CONTENT-001-0001
* @example MUSE-CONTENT-001-0001
*/
code: string;
/** @description 人类可读的错误描述 */
message: string;
/** @description 详细错误信息(仅开发环境返回) */
detail?: string;
};
};
responses: {
/** @description 资源冲突 */
Conflict: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
};
parameters: {
/** @description 页码,从 1 开始 */
pageNo: number;
/** @description 每页条数,上限 100 */
pageSize: number;
};
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
requestGeneration: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/**
* Format: uuid
* @description 目标 Block
*/
blockId: string;
/**
* Format: uuid
* @description 使用的智能体
*/
agentId: string;
/** @description 用户附加的提示词 */
prompt?: string;
/** @description 上下文 Block ID 列表 */
contextBlocks?: string[];
};
};
};
responses: {
/** @description 生成任务已提交 */
202: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"] & {
data?: {
/** Format: uuid */
generationId?: string;
};
};
};
};
};
};
getGenerationStatus: {
parameters: {
query?: never;
header?: never;
path: {
generationId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 生成状态 */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"] & {
data?: components["schemas"]["Generation"];
};
};
};
};
};
streamGeneration: {
parameters: {
query?: never;
header?: never;
path: {
generationId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description SSE 事件流 */
200: {
headers: {
[name: string]: unknown;
};
content: {
"text/event-stream": string;
};
};
};
};
listCandidates: {
parameters: {
query: {
blockId: string;
status?: "pending" | "accepted" | "rejected";
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 候选列表 */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"] & {
data?: components["schemas"]["Candidate"][];
};
};
};
};
};
getCandidate: {
parameters: {
query?: never;
header?: never;
path: {
candidateId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 候选详情(含生成内容 diff) */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
acceptCandidate: {
parameters: {
query?: never;
header?: never;
path: {
candidateId: string;
};
cookie?: never;
};
requestBody?: {
content: {
"application/json": {
/** @description 用户在接受前对候选内容的手动修改 */
modifications?: string;
};
};
};
responses: {
/** @description 候选已接受,Block 正文更新 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description 源版本已变更,需重新对比 */
409: components["responses"]["Conflict"];
};
};
rejectCandidate: {
parameters: {
query?: never;
header?: never;
path: {
candidateId: string;
};
cookie?: never;
};
requestBody?: {
content: {
"application/json": {
/** @description 拒绝原因(可选,用于改进生成质量) */
reason?: string;
};
};
};
responses: {
/** @description 已拒绝 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
listAgents: {
parameters: {
query?: {
/** @description 页码,从 1 开始 */
pageNo?: components["parameters"]["pageNo"];
/** @description 每页条数,上限 100 */
pageSize?: components["parameters"]["pageSize"];
/** @description 智能体类型 */
type?: "config" | "custom";
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 智能体分页列表 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
createAgent: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
name: string;
description?: string;
/** @description 系统提示词模板 */
promptTemplate?: string;
/** @description 槽位绑定配置(知识库/MetaSchema/模型参数) */
slotBindings?: Record<string, never>;
};
};
};
responses: {
/** @description 创建成功 */
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
getAgent: {
parameters: {
query?: never;
header?: never;
path: {
agentId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 智能体详情 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
updateAgent: {
parameters: {
query?: never;
header?: never;
path: {
agentId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
name?: string;
description?: string;
promptTemplate?: string;
slotBindings?: Record<string, never>;
/** @enum {string} */
status?: "active" | "archived";
};
};
};
responses: {
/** @description 更新成功 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
deleteAgent: {
parameters: {
query?: never;
header?: never;
path: {
agentId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 删除成功 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminListPromptTemplates: {
parameters: {
query?: {
/** @description 页码,从 1 开始 */
pageNo?: components["parameters"]["pageNo"];
/** @description 每页条数,上限 100 */
pageSize?: components["parameters"]["pageSize"];
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 模板分页列表 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminCreatePromptTemplate: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
name: string;
template: string;
variables?: {
name?: string;
/** @enum {string} */
type?: "string" | "number" | "boolean";
required?: boolean;
defaultValue?: string;
}[];
};
};
};
responses: {
/** @description 创建成功 */
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminUpdatePromptTemplate: {
parameters: {
query?: never;
header?: never;
path: {
templateId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 更新成功 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminDeletePromptTemplate: {
parameters: {
query?: never;
header?: never;
path: {
templateId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 删除成功 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminListQualityGates: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 质量门控维度列表 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminCreateQualityGate: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 创建成功 */
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminListProtectionNodes: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 保护节点列表 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminCreateProtectionNode: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 注册成功 */
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
}

View File

@ -0,0 +1,137 @@
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export type paths = Record<string, never>;
export type webhooks = Record<string, never>;
export interface components {
schemas: {
CommonResult: {
/**
* @description 业务状态码,0 表示成功
* @example 0
*/
code: number;
/**
* @description 提示信息
* @example 操作成功
*/
message: string;
/** @description 响应数据,类型视具体接口而定 */
data?: unknown;
};
PaginatedResult: {
/**
* @description 总记录数
* @example 150
*/
total: number;
/**
* @description 当前页码
* @example 1
*/
pageNo: number;
/**
* @description 每页条数
* @example 20
*/
pageSize: number;
/** @description 当前页数据列表 */
list: unknown[];
};
ErrorResponse: {
/**
* @description 错误码格式: {system}-{module}-{category}-{sequence}
* 示例: MUSE-CONTENT-001-0001
* @example MUSE-CONTENT-001-0001
*/
code: string;
/** @description 人类可读的错误描述 */
message: string;
/** @description 详细错误信息(仅开发环境返回) */
detail?: string;
};
TimestampMixin: {
/**
* Format: date-time
* @description 创建时间
*/
createdAt?: string;
/**
* Format: date-time
* @description 最后更新时间
*/
updatedAt?: string;
};
};
responses: {
/** @description 请求参数有误 */
BadRequest: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
/** @description 未认证或 token 过期 */
Unauthorized: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
/** @description 无权限 */
Forbidden: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
/** @description 资源不存在 */
NotFound: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
/** @description 资源冲突 */
Conflict: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
/** @description 服务器内部错误 */
InternalError: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
};
parameters: {
/** @description API 版本号,格式 YYYY-MM-DD */
XApiVersion: string;
/** @description 页码,从 1 开始 */
pageNo: number;
/** @description 每页条数,上限 100 */
pageSize: number;
};
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export type operations = Record<string, never>;

View File

@ -0,0 +1,858 @@
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/app-api/content/works": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取作品列表 */
get: operations["listWorks"];
put?: never;
/** 创建新作品 */
post: operations["createWork"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/content/works/{workId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取作品详情 */
get: operations["getWork"];
/** 更新作品 */
put: operations["updateWork"];
post?: never;
/** 删除作品 */
delete: operations["deleteWork"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/content/works/{workId}/chapters": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取作品章节列表 */
get: operations["listChapters"];
put?: never;
/** 创建章节 */
post: operations["createChapter"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/content/chapters/{chapterId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取章节详情 */
get: operations["getChapter"];
/** 更新章节 */
put: operations["updateChapter"];
post?: never;
/** 删除章节 */
delete: operations["deleteChapter"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/content/chapters/{chapterId}/reorder": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** 调整章节排序 */
put: operations["reorderChapters"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/content/chapters/{chapterId}/blocks": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取章节 Block 列表 */
get: operations["listBlocks"];
put?: never;
/** 创建 Block */
post: operations["createBlock"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/content/blocks/{blockId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取 Block 详情 */
get: operations["getBlock"];
/** 保存 Block 正文 */
put: operations["saveBlock"];
post?: never;
/** 删除 Block */
delete: operations["deleteBlock"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/content/blocks/{blockId}/split": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** 分割 Block */
post: operations["splitBlock"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/content/blocks/{blockId}/merge": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** 合并 Block */
post: operations["mergeBlocks"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/content/works/{workId}/export": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** 导出作品 */
post: operations["exportWork"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
Work: {
/** Format: uuid */
id: string;
title: string;
description?: string;
genre?: string;
/** Format: uri */
coverImageUrl?: string;
/** @enum {string} */
status: "draft" | "active" | "archived";
/** @description 总字数 */
wordCount?: number;
/** @description 章节数 */
chapterCount?: number;
/** Format: date-time */
createdAt: string;
/** Format: date-time */
updatedAt: string;
};
WorkSummary: {
/** Format: uuid */
id: string;
title: string;
genre?: string;
/** @enum {string} */
status: "draft" | "active" | "archived";
wordCount?: number;
chapterCount?: number;
/** Format: date-time */
updatedAt: string;
};
Chapter: {
/** Format: uuid */
id: string;
/** Format: uuid */
workId: string;
title: string;
sortOrder: number;
/** @enum {string} */
status: "draft" | "completed";
wordCount?: number;
blockCount?: number;
/** Format: date-time */
createdAt: string;
/** Format: date-time */
updatedAt: string;
};
ChapterDetail: components["schemas"]["Chapter"] & {
blocks?: components["schemas"]["Block"][];
};
Block: {
/** Format: uuid */
id: string;
/** Format: uuid */
chapterId: string;
/** @enum {string} */
blockType: "scene" | "section" | "note";
title?: string;
/** @description ProseMirror JSON 格式的正文内容 */
content: string;
sortOrder: number;
/** @description 乐观锁版本号,每次保存 +1 */
version: number;
wordCount?: number;
/** Format: date-time */
createdAt: string;
/** Format: date-time */
updatedAt: string;
};
PaginatedResult: {
/**
* @description 总记录数
* @example 150
*/
total: number;
/**
* @description 当前页码
* @example 1
*/
pageNo: number;
/**
* @description 每页条数
* @example 20
*/
pageSize: number;
/** @description 当前页数据列表 */
list: unknown[];
};
CommonResult: {
/**
* @description 业务状态码,0 表示成功
* @example 0
*/
code: number;
/**
* @description 提示信息
* @example 操作成功
*/
message: string;
/** @description 响应数据,类型视具体接口而定 */
data?: unknown;
};
ErrorResponse: {
/**
* @description 错误码格式: {system}-{module}-{category}-{sequence}
* 示例: MUSE-CONTENT-001-0001
* @example MUSE-CONTENT-001-0001
*/
code: string;
/** @description 人类可读的错误描述 */
message: string;
/** @description 详细错误信息(仅开发环境返回) */
detail?: string;
};
};
responses: {
/** @description 资源不存在 */
NotFound: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
};
parameters: {
/** @description 页码,从 1 开始 */
pageNo: number;
/** @description 每页条数,上限 100 */
pageSize: number;
};
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
listWorks: {
parameters: {
query?: {
/** @description 页码,从 1 开始 */
pageNo?: components["parameters"]["pageNo"];
/** @description 每页条数,上限 100 */
pageSize?: components["parameters"]["pageSize"];
/** @description 作品状态过滤 */
status?: "draft" | "active" | "archived";
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 作品分页列表 */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaginatedResult"] & {
list?: components["schemas"]["WorkSummary"][];
};
};
};
};
};
createWork: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
title: string;
description?: string;
genre?: string;
/** Format: uri */
coverImageUrl?: string;
};
};
};
responses: {
/** @description 作品创建成功 */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"] & {
data?: components["schemas"]["Work"];
};
};
};
};
};
getWork: {
parameters: {
query?: never;
header?: never;
path: {
workId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 作品详情 */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"] & {
data?: components["schemas"]["Work"];
};
};
};
};
};
updateWork: {
parameters: {
query?: never;
header?: never;
path: {
workId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
title?: string;
description?: string;
genre?: string;
/** Format: uri */
coverImageUrl?: string;
/** @enum {string} */
status?: "draft" | "active" | "archived";
};
};
};
responses: {
/** @description 更新成功 */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"];
};
};
};
};
deleteWork: {
parameters: {
query?: never;
header?: never;
path: {
workId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 删除成功 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
404: components["responses"]["NotFound"];
};
};
listChapters: {
parameters: {
query?: never;
header?: never;
path: {
workId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 章节列表(按 sortOrder 排序) */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"] & {
data?: components["schemas"]["Chapter"][];
};
};
};
};
};
createChapter: {
parameters: {
query?: never;
header?: never;
path: {
workId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
title: string;
/** @description 插入位置,默认追加到末尾 */
sortOrder?: number;
};
};
};
responses: {
/** @description 创建成功 */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"] & {
data?: components["schemas"]["Chapter"];
};
};
};
};
};
getChapter: {
parameters: {
query?: never;
header?: never;
path: {
chapterId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 章节详情(含 Block 列表) */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"] & {
data?: components["schemas"]["ChapterDetail"];
};
};
};
};
};
updateChapter: {
parameters: {
query?: never;
header?: never;
path: {
chapterId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
title?: string;
sortOrder?: number;
/** @enum {string} */
status?: "draft" | "completed";
};
};
};
responses: {
/** @description 更新成功 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
deleteChapter: {
parameters: {
query?: never;
header?: never;
path: {
chapterId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 删除成功 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
reorderChapters: {
parameters: {
query?: never;
header?: never;
path: {
chapterId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
newSortOrder: number;
};
};
};
responses: {
/** @description 排序更新成功 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
listBlocks: {
parameters: {
query?: never;
header?: never;
path: {
chapterId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Block 列表 */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"] & {
data?: components["schemas"]["Block"][];
};
};
};
};
};
createBlock: {
parameters: {
query?: never;
header?: never;
path: {
chapterId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** @description Block 正文内容(JSON 格式的 ProseMirror 文档) */
content: string;
/**
* @description Block 类型
* @enum {string}
*/
blockType: "scene" | "section" | "note";
sortOrder?: number;
title?: string;
};
};
};
responses: {
/** @description 创建成功 */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"] & {
data?: components["schemas"]["Block"];
};
};
};
};
};
getBlock: {
parameters: {
query?: never;
header?: never;
path: {
blockId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Block 详情 */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"] & {
data?: components["schemas"]["Block"];
};
};
};
};
};
saveBlock: {
parameters: {
query?: never;
header?: never;
path: {
blockId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** @description Block 正文(ProseMirror JSON) */
content: string;
/** @description 客户端持有的版本号,用于乐观锁冲突检测 */
sourceVersion: number;
};
};
};
responses: {
/** @description 保存成功 */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CommonResult"] & {
data?: {
/** @description 保存后的新版本号 */
newVersion?: number;
};
};
};
};
/** @description 版本冲突,需客户端处理 */
409: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
};
};
deleteBlock: {
parameters: {
query?: never;
header?: never;
path: {
blockId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 删除成功 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
splitBlock: {
parameters: {
query?: never;
header?: never;
path: {
blockId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** @description 分割位置(字符偏移量) */
splitPosition: number;
};
};
};
responses: {
/** @description 分割成功,返回两个新 Block */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
mergeBlocks: {
parameters: {
query?: never;
header?: never;
path: {
/** @description 与下一个 Block 合并 */
blockId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 合并成功 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
exportWork: {
parameters: {
query?: never;
header?: never;
path: {
workId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** @enum {string} */
format: "txt" | "epub" | "docx";
/** @description 指定导出章节,空数组表示导出全部 */
includeChapters?: string[];
};
};
};
responses: {
/** @description 导出任务已创建,返回任务 ID 供轮询 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description 导出文件二进制流(小文件直接返回) */
202: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
}

View File

@ -0,0 +1,11 @@
// Muse API TypeScript 类型包入口
// 从 OpenAPI 3.0 契约自动生成,请勿手动编辑
// 生成命令: npx openapi-typescript <yaml> --output <target>
export type * from './base';
export type * from './content';
export type * from './ai';
export type * from './knowledge';
export type * from './market';
export type * from './account';
export type * from './meta';

View File

@ -0,0 +1,367 @@
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/app-api/knowledge/works/{workId}/entities": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取作品知识实体列表 */
get: operations["listEntities"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/knowledge/entities/{entityId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取知识实体详情 */
get: operations["getEntity"];
/** 更新知识实体 */
put: operations["updateEntity"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/knowledge/entities/{entityId}/confirm": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* 手动确认知识实体
* @description 知识实体的默认确认规则:
* - 无冲突 + 非外部来源 + 置信度 > 阈值 → 自动确认
* - 有冲突 或 外部来源 或 低置信度 → 需手动确认
*/
post: operations["confirmEntity"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/knowledge/entities/{entityId}/reject": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** 拒绝知识实体草稿 */
post: operations["rejectEntity"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/knowledge/entities/{entityId}/relations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取实体关联关系 */
get: operations["listRelations"];
put?: never;
/** 创建知识关系 */
post: operations["createRelation"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/knowledge/works/{workId}/graph": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* 获取知识图谱数据
* @description 返回节点和边的 JSON,用于前端可视化渲染
*/
get: operations["getKnowledgeGraph"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/knowledge/works/{workId}/drafts": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取待处理知识草稿列表 */
get: operations["listDrafts"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: never;
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
listEntities: {
parameters: {
query?: {
status?: "confirmed" | "draft" | "conflicted";
type?: "character" | "location" | "event" | "item" | "concept" | "note";
};
header?: never;
path: {
workId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 实体列表 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
getEntity: {
parameters: {
query?: never;
header?: never;
path: {
entityId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 实体详情(含关联关系和来源引用) */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
updateEntity: {
parameters: {
query?: never;
header?: never;
path: {
entityId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
name?: string;
description?: string;
/** @description 自定义属性键值对 */
attributes?: Record<string, never>;
};
};
};
responses: {
/** @description 更新成功 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
confirmEntity: {
parameters: {
query?: never;
header?: never;
path: {
entityId: string;
};
cookie?: never;
};
requestBody?: {
content: {
"application/json": {
/** @description 手动修正的属性值 */
overrides?: Record<string, never>;
};
};
};
responses: {
/** @description 确认成功 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
rejectEntity: {
parameters: {
query?: never;
header?: never;
path: {
entityId: string;
};
cookie?: never;
};
requestBody?: {
content: {
"application/json": {
reason?: string;
};
};
};
responses: {
/** @description 已拒绝 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
listRelations: {
parameters: {
query?: never;
header?: never;
path: {
entityId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 关系列表 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
createRelation: {
parameters: {
query?: never;
header?: never;
path: {
/** @description 源实体 */
entityId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** Format: uuid */
targetEntityId: string;
/** @example knows */
relationType: string;
description?: string;
};
};
};
responses: {
/** @description 创建成功 */
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
getKnowledgeGraph: {
parameters: {
query?: {
/** @description 图谱展开深度 */
depth?: number;
};
header?: never;
path: {
workId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 图谱数据(nodes + edges) */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
listDrafts: {
parameters: {
query?: never;
header?: never;
path: {
workId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 草稿列表 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
}

View File

@ -0,0 +1,509 @@
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/app-api/market/assets": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 浏览市场资产 */
get: operations["listAssets"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/market/assets/{assetId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取资产详情 */
get: operations["getAsset"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/market/assets/{assetId}/install": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** 安装资产到我的工作区 */
post: operations["installAsset"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/market/installations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取我的已安装资产 */
get: operations["listInstallations"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/market/installations/{installationId}/bindings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取资产的作品绑定列表 */
get: operations["listBindings"];
put?: never;
/** 绑定已安装资产到作品 */
post: operations["bindInstallation"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/app-api/market/publish": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** 发布资产到市场 */
post: operations["publishAsset"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/admin-api/market/reviews": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取待审核资产列表 */
get: operations["adminListReviews"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/admin-api/market/reviews/{reviewId}/approve": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** 审核通过 */
post: operations["adminApproveAsset"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/admin-api/market/reviews/{reviewId}/reject": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** 审核驳回 */
post: operations["adminRejectAsset"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/admin-api/market/assets/{assetId}/delist": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** 下架资产 */
post: operations["adminDelistAsset"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/admin-api/market/assets/{assetId}/recall": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** 召回已安装资产 */
post: operations["adminRecallAsset"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: never;
responses: never;
parameters: {
/** @description 页码,从 1 开始 */
pageNo: number;
/** @description 每页条数,上限 100 */
pageSize: number;
};
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
listAssets: {
parameters: {
query?: {
/** @description 页码,从 1 开始 */
pageNo?: components["parameters"]["pageNo"];
/** @description 每页条数,上限 100 */
pageSize?: components["parameters"]["pageSize"];
type?: "agent" | "prompt_template" | "knowledge_source" | "metaschema";
/** @description 搜索关键词 */
keyword?: string;
sortBy?: "popular" | "newest" | "rating";
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 资产分页列表 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
getAsset: {
parameters: {
query?: never;
header?: never;
path: {
assetId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 资产详情 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
installAsset: {
parameters: {
query?: never;
header?: never;
path: {
assetId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 安装成功 */
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
listInstallations: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 已安装资产列表 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
listBindings: {
parameters: {
query?: never;
header?: never;
path: {
installationId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 绑定列表 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
bindInstallation: {
parameters: {
query?: never;
header?: never;
path: {
installationId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** Format: uuid */
workId: string;
/** @description 槽位配置 */
slotConfig?: Record<string, never>;
};
};
};
responses: {
/** @description 绑定成功 */
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
publishAsset: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
name: string;
description?: string;
/** @enum {string} */
type: "agent" | "prompt_template" | "knowledge_source" | "metaschema";
/**
* Format: uuid
* @description 来源对象 ID
*/
sourceId: string;
tags?: string[];
/** Format: uri */
coverImageUrl?: string;
};
};
};
responses: {
/** @description 发布申请已提交,待审核 */
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminListReviews: {
parameters: {
query?: {
/** @description 页码,从 1 开始 */
pageNo?: components["parameters"]["pageNo"];
/** @description 每页条数,上限 100 */
pageSize?: components["parameters"]["pageSize"];
status?: "pending" | "approved" | "rejected";
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 审核列表 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminApproveAsset: {
parameters: {
query?: never;
header?: never;
path: {
reviewId: string;
};
cookie?: never;
};
requestBody?: {
content: {
"application/json": {
note?: string;
};
};
};
responses: {
/** @description 已上架 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminRejectAsset: {
parameters: {
query?: never;
header?: never;
path: {
reviewId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
reason: string;
};
};
};
responses: {
/** @description 已驳回 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminDelistAsset: {
parameters: {
query?: never;
header?: never;
path: {
assetId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
reason: string;
};
};
};
responses: {
/** @description 已下架 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminRecallAsset: {
parameters: {
query?: never;
header?: never;
path: {
assetId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
reason: string;
};
};
};
responses: {
/** @description 已触发召回 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
}

View File

@ -0,0 +1,342 @@
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/admin-api/meta/schemas": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取 MetaSchema 列表 */
get: operations["adminListSchemas"];
put?: never;
/** 创建 MetaSchema 定义 */
post: operations["adminCreateSchema"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/admin-api/meta/schemas/{schemaId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取 MetaSchema 详情 */
get: operations["adminGetSchema"];
/** 更新 MetaSchema 定义 */
put: operations["adminUpdateSchema"];
post?: never;
/** 删除 MetaSchema 定义 */
delete: operations["adminDeleteSchema"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/admin-api/meta/schemas/{schemaId}/versions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取 MetaSchema 版本历史 */
get: operations["adminListSchemaVersions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/admin-api/meta/schemas/{schemaId}/versions/{version}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** 获取指定版本详情 */
get: operations["adminGetSchemaVersion"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/admin-api/meta/schemas/{schemaId}/rollback": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** 回滚到指定版本 */
post: operations["adminRollbackSchema"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
ErrorResponse: {
/**
* @description 错误码格式: {system}-{module}-{category}-{sequence}
* 示例: MUSE-CONTENT-001-0001
* @example MUSE-CONTENT-001-0001
*/
code: string;
/** @description 人类可读的错误描述 */
message: string;
/** @description 详细错误信息(仅开发环境返回) */
detail?: string;
};
};
responses: {
/** @description 资源冲突 */
Conflict: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
};
parameters: {
/** @description 页码,从 1 开始 */
pageNo: number;
/** @description 每页条数,上限 100 */
pageSize: number;
};
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
adminListSchemas: {
parameters: {
query?: {
/** @description 页码,从 1 开始 */
pageNo?: components["parameters"]["pageNo"];
/** @description 每页条数,上限 100 */
pageSize?: components["parameters"]["pageSize"];
scope?: "global" | "tenant" | "user" | "work";
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description MetaSchema 分页列表 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminCreateSchema: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** @description 字段名(英文标识) */
name: string;
/** @description 显示名称 */
displayName?: string;
/** @enum {string} */
fieldType: "string" | "text" | "number" | "boolean" | "date" | "enum" | "relation" | "json";
/**
* @description 作用域
* @enum {string}
*/
scope: "global" | "tenant" | "user" | "work";
/** @description 默认值 */
defaultValue?: unknown;
/** @default false */
required?: boolean;
/** @description fieldType=enum 时的可选值 */
enumValues?: string[];
/** @description 校验规则(min/max/pattern 等) */
validationRules?: Record<string, never>;
};
};
};
responses: {
/** @description 创建成功 */
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminGetSchema: {
parameters: {
query?: never;
header?: never;
path: {
schemaId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description MetaSchema 详情(含版本历史) */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminUpdateSchema: {
parameters: {
query?: never;
header?: never;
path: {
schemaId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
displayName?: string;
/** @description 默认值 */
defaultValue?: unknown;
required?: boolean;
enumValues?: string[];
validationRules?: Record<string, never>;
};
};
};
responses: {
/** @description 更新成功(自动创建新版本) */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminDeleteSchema: {
parameters: {
query?: never;
header?: never;
path: {
schemaId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 删除成功(软删除,已有数据不受影响) */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description 有数据引用时不允许删除 */
409: components["responses"]["Conflict"];
};
};
adminListSchemaVersions: {
parameters: {
query?: never;
header?: never;
path: {
schemaId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 版本历史列表 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminGetSchemaVersion: {
parameters: {
query?: never;
header?: never;
path: {
schemaId: string;
version: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 版本详情 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
adminRollbackSchema: {
parameters: {
query?: never;
header?: never;
path: {
schemaId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
targetVersion: number;
reason?: string;
};
};
};
responses: {
/** @description 回滚成功,创建新版本指向目标版本配置 */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
}