natty
/
misskey-awawa
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve doc

This commit is contained in:
syuilo 2019-02-25 09:37:22 +09:00
parent 28086111e1
commit c4ddfef2ed
No known key found for this signature in database
GPG Key ID: BDC4C49D06AB9D69
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/server/api/openapi/gen-spec.ts
View File

@ -108,10 +108,14 @@ export function genOpenapiSpec(lang = 'ja-JP') {
const resSchema = endpoint.meta.res ? convertOpenApiSchema(endpoint.meta.res) : {}; const resSchema = endpoint.meta.res ? convertOpenApiSchema(endpoint.meta.res) : {};
let desc = (endpoint.meta.desc ? endpoint.meta.desc[lang] : 'No description provided.') + '\n\n';
desc += `**Credential required**: *${endpoint.meta.requireCredential ? 'Yes' : 'No'}*`;
if (endpoint.meta.kind) desc += ` / **Permission**: *${endpoint.meta.kind}*`;
const info = { const info = {
operationId: endpoint.name, operationId: endpoint.name,
summary: endpoint.name, summary: endpoint.name,
description: endpoint.meta.desc ? endpoint.meta.desc[lang] : 'No description provided.', description: desc,
externalDocs: { externalDocs: {
description: 'Source code', description: 'Source code',
url: `https://github.com/syuilo/misskey/blob/develop/src/server/api/endpoints/${endpoint.name}.ts` url: `https://github.com/syuilo/misskey/blob/develop/src/server/api/endpoints/${endpoint.name}.ts`