oscar-surf/misskey
oscar-surf/misskey
0
0
Fork 0
Code Issues Activity

Improve doc

Browse source
This commit is contained in:
syuilo 2019-02-25 04:18:09 +09:00
parent 47d4dcfdf5
commit 60c9a6528f
No known key found for this signature in database
GPG key ID: BDC4C49D06AB9D69
14 changed files with 52 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/server/api/openapi/gen-spec.ts
View file

@ -56,6 +56,7 @@ export function genOpenapiSpec(lang = 'ja-JP') {
return {
description: (param.data || {}).desc,
default: (param.data || {}).default,
deprecated: (param.data || {}).deprecated,
...((param.data || {}).default ? { default: (param.data || {}).default } : {}),
type: param.name === 'ID' ? 'string' : param.name.toLowerCase(),
...(param.name === 'ID' ? { example: 'xxxxxxxxxxxxxxxxxxxxxxxx', format: 'id' } : {}),
@ -97,6 +98,7 @@ export function genOpenapiSpec(lang = 'ja-JP') {
for (const [k, v] of Object.entries(endpoint.meta.params)) {
if (v.validator.data == null) v.validator.data = {};
if (v.desc) v.validator.data.desc = v.desc[lang];
if (v.deprecated) v.validator.data.deprecated = v.deprecated;
if (v.default) v.validator.data.default = v.default;
porops[k] = v.validator;
}