diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2019-02-25 04:18:09 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2019-02-25 04:18:09 +0900 |
| commit | 60c9a6528f10ab63ca03fd1012a63c08727492fb (patch) | |
| tree | 4066f51ce838649564b3db3606730c02e4d4fec2 /src/server/api/openapi/gen-spec.ts | |
| parent | Improve doc (diff) | |
| download | sharkey-60c9a6528f10ab63ca03fd1012a63c08727492fb.tar.gz sharkey-60c9a6528f10ab63ca03fd1012a63c08727492fb.tar.bz2 sharkey-60c9a6528f10ab63ca03fd1012a63c08727492fb.zip | |
Improve doc
Diffstat (limited to 'src/server/api/openapi/gen-spec.ts')
| -rw-r--r-- | src/server/api/openapi/gen-spec.ts | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/src/server/api/openapi/gen-spec.ts b/src/server/api/openapi/gen-spec.ts index c8b1c21de4..64da6edbeb 100644 --- a/src/server/api/openapi/gen-spec.ts +++ b/src/server/api/openapi/gen-spec.ts @@ -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; } |