2022-05-23 13:05:59 +08:00
|
|
|
import { IDocument } from '../models';
|
|
|
|
export declare const DocumentApiDefinition: {
|
|
|
|
/**
|
|
|
|
* 搜索文档
|
|
|
|
*/
|
|
|
|
search: {
|
2022-05-23 16:20:56 +08:00
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
server: "search";
|
|
|
|
client: () => string;
|
|
|
|
};
|
|
|
|
/**
|
|
|
|
* 获取用户最近访问的文档
|
|
|
|
*/
|
|
|
|
recent: {
|
2022-05-23 16:20:56 +08:00
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
server: "recent";
|
|
|
|
client: () => string;
|
|
|
|
};
|
|
|
|
/**
|
|
|
|
* 新建文档
|
|
|
|
*/
|
|
|
|
create: {
|
2022-05-23 16:20:56 +08:00
|
|
|
method: "post";
|
2022-05-23 13:05:59 +08:00
|
|
|
server: "create";
|
|
|
|
client: () => string;
|
|
|
|
};
|
|
|
|
/**
|
|
|
|
* 获取文档详情
|
|
|
|
*/
|
|
|
|
getDetailById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
server: "detail/:id";
|
|
|
|
client: (id: IDocument['id']) => string;
|
|
|
|
};
|
|
|
|
/**
|
|
|
|
* 更新文档
|
|
|
|
*/
|
|
|
|
updateById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
method: "patch";
|
2022-05-23 13:05:59 +08:00
|
|
|
server: "update/:id";
|
|
|
|
client: (id: IDocument['id']) => string;
|
|
|
|
};
|
|
|
|
/**
|
|
|
|
* 获取文档版本记录
|
|
|
|
*/
|
|
|
|
getVersionById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
server: "version/:id";
|
|
|
|
client: (id: IDocument['id']) => string;
|
|
|
|
};
|
|
|
|
/**
|
|
|
|
* 获取文档成员
|
|
|
|
*/
|
|
|
|
getMemberById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
server: "member/:id";
|
|
|
|
client: (id: IDocument['id']) => string;
|
|
|
|
};
|
|
|
|
/**
|
|
|
|
* 添加文档成员
|
|
|
|
*/
|
|
|
|
addMemberById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
method: "post";
|
2022-05-23 13:05:59 +08:00
|
|
|
server: "member/:id/add";
|
|
|
|
client: (id: IDocument['id']) => string;
|
|
|
|
};
|
|
|
|
/**
|
|
|
|
* 更新文档成员
|
|
|
|
*/
|
|
|
|
updateMemberById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
method: "patch";
|
2022-05-23 13:05:59 +08:00
|
|
|
server: "member/:id/update";
|
|
|
|
client: (id: IDocument['id']) => string;
|
|
|
|
};
|
|
|
|
/**
|
|
|
|
* 删除文档成员
|
|
|
|
*/
|
|
|
|
deleteMemberById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
method: "post";
|
2022-05-23 13:05:59 +08:00
|
|
|
server: "member/:id/delete";
|
|
|
|
client: (id: IDocument['id']) => string;
|
|
|
|
};
|
|
|
|
/**
|
|
|
|
* 获取子文档
|
|
|
|
*/
|
|
|
|
getChildren: {
|
2022-05-23 16:20:56 +08:00
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
server: "children";
|
|
|
|
client: () => string;
|
|
|
|
};
|
|
|
|
/**
|
|
|
|
* 删除文档
|
|
|
|
*/
|
|
|
|
deleteById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
method: "delete";
|
2022-05-23 13:05:59 +08:00
|
|
|
server: "delete/:id";
|
|
|
|
client: (id: IDocument['id']) => string;
|
|
|
|
};
|
|
|
|
/**
|
|
|
|
* 分享文档
|
|
|
|
*/
|
|
|
|
shareById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
method: "post";
|
2022-05-23 13:05:59 +08:00
|
|
|
server: "share/:id";
|
|
|
|
client: (id: IDocument['id']) => string;
|
|
|
|
};
|
|
|
|
/**
|
|
|
|
* 获取公开文档详情
|
|
|
|
*/
|
|
|
|
getPublicDetailById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
server: "public/detail/:id";
|
|
|
|
client: (id: IDocument['id']) => string;
|
|
|
|
};
|
|
|
|
/**
|
|
|
|
* 获取公开文档的子文档
|
|
|
|
*/
|
|
|
|
getPublicChildren: {
|
2022-05-23 16:20:56 +08:00
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
server: "public/children";
|
|
|
|
client: () => string;
|
|
|
|
};
|
|
|
|
};
|