2022-05-23 13:05:59 +08:00
|
|
|
|
import { IWiki } from '../models';
|
|
|
|
|
export declare const WikiApiDefinition: {
|
|
|
|
|
/**
|
|
|
|
|
* 获取用户所有知识库(创建的、参与的)
|
|
|
|
|
*/
|
|
|
|
|
getAllWikis: {
|
2022-05-23 16:20:56 +08:00
|
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
|
server: "list/all";
|
|
|
|
|
client: () => string;
|
|
|
|
|
};
|
|
|
|
|
/**
|
|
|
|
|
* 获取用户创建的知识库
|
|
|
|
|
*/
|
|
|
|
|
getOwnWikis: {
|
2022-05-23 16:20:56 +08:00
|
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
|
server: "list/own";
|
|
|
|
|
client: () => string;
|
|
|
|
|
};
|
|
|
|
|
/**
|
|
|
|
|
* 获取用户参与的知识库
|
|
|
|
|
*/
|
|
|
|
|
getJoinWikis: {
|
2022-05-23 16:20:56 +08:00
|
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
|
server: "list/join";
|
|
|
|
|
client: () => string;
|
|
|
|
|
};
|
|
|
|
|
/**
|
|
|
|
|
* 新建知识库
|
|
|
|
|
*/
|
|
|
|
|
add: {
|
2022-05-23 16:20:56 +08:00
|
|
|
|
method: "post";
|
2022-05-23 13:05:59 +08:00
|
|
|
|
server: "add";
|
|
|
|
|
client: () => string;
|
|
|
|
|
};
|
|
|
|
|
/**
|
|
|
|
|
* 获取知识库首页文档
|
|
|
|
|
*/
|
|
|
|
|
getHomeDocumentById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
|
server: "homedoc/:id";
|
|
|
|
|
client: (id: IWiki['id']) => string;
|
|
|
|
|
};
|
|
|
|
|
/**
|
|
|
|
|
* 获取知识库目录
|
|
|
|
|
*/
|
|
|
|
|
getTocsById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
|
server: "tocs/:id";
|
|
|
|
|
client: (id: IWiki['id']) => string;
|
|
|
|
|
};
|
|
|
|
|
/**
|
|
|
|
|
* 更新知识库目录
|
|
|
|
|
*/
|
|
|
|
|
updateTocsById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
|
method: "patch";
|
2022-05-23 13:05:59 +08:00
|
|
|
|
server: "tocs/:id/update";
|
|
|
|
|
client: (id: IWiki['id']) => string;
|
|
|
|
|
};
|
|
|
|
|
/**
|
|
|
|
|
* 获取知识库所有文档
|
|
|
|
|
*/
|
|
|
|
|
getDocumentsById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
|
server: "documents/:id";
|
|
|
|
|
client: (id: IWiki['id']) => 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: IWiki['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: IWiki['id']) => string;
|
|
|
|
|
};
|
|
|
|
|
/**
|
|
|
|
|
* 删除知识库
|
|
|
|
|
*/
|
|
|
|
|
deleteById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
|
method: "delete";
|
2022-05-23 13:05:59 +08:00
|
|
|
|
server: "delet/:id";
|
|
|
|
|
client: (id: IWiki['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: IWiki['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: IWiki['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: IWiki['id']) => string;
|
|
|
|
|
};
|
|
|
|
|
/**
|
|
|
|
|
* 删除知识库成员
|
|
|
|
|
*/
|
|
|
|
|
deleteMemberById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
|
method: "delete";
|
2022-05-23 13:05:59 +08:00
|
|
|
|
server: "member/:id/delete";
|
|
|
|
|
client: (id: IWiki['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: IWiki['id']) => string;
|
|
|
|
|
};
|
|
|
|
|
/**
|
|
|
|
|
* 获取公开知识库首页文档
|
|
|
|
|
*/
|
|
|
|
|
getPublicHomeDocumentById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
|
server: "/public/homedoc/:id";
|
|
|
|
|
client: (id: IWiki['id']) => string;
|
|
|
|
|
};
|
|
|
|
|
/**
|
|
|
|
|
* 获取公开知识库目录
|
|
|
|
|
*/
|
|
|
|
|
getPublicTocsById: {
|
2022-05-23 16:20:56 +08:00
|
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
|
server: "/public/tocs/:id";
|
|
|
|
|
client: (id: IWiki['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: IWiki['id']) => string;
|
|
|
|
|
};
|
|
|
|
|
/**
|
|
|
|
|
* 获取所有公开知识库
|
|
|
|
|
*/
|
|
|
|
|
getPublicWikis: {
|
2022-05-23 16:20:56 +08:00
|
|
|
|
method: "get";
|
2022-05-23 13:05:59 +08:00
|
|
|
|
server: "/public/wikis";
|
2022-05-23 16:20:56 +08:00
|
|
|
|
client: () => string;
|
2022-05-23 13:05:59 +08:00
|
|
|
|
};
|
|
|
|
|
};
|