diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2018-07-16 06:19:19 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2018-07-16 06:19:19 +0900 |
| commit | 168d13d6e687b87906b2dfd8f7206d03cec32bdc (patch) | |
| tree | c0564e9ebe3ce92f0154c9e009b7c9b5c1b65178 /src/server | |
| parent | Update docs (diff) | |
| download | sharkey-168d13d6e687b87906b2dfd8f7206d03cec32bdc.tar.gz sharkey-168d13d6e687b87906b2dfd8f7206d03cec32bdc.tar.bz2 sharkey-168d13d6e687b87906b2dfd8f7206d03cec32bdc.zip | |
Improve docs
Diffstat (limited to 'src/server')
| -rw-r--r-- | src/server/api/endpoints/i.ts | 13 | ||||
| -rw-r--r-- | src/server/web/docs.ts | 3 |
2 files changed, 11 insertions, 5 deletions
diff --git a/src/server/api/endpoints/i.ts b/src/server/api/endpoints/i.ts index 150ab34a0f..8219100d60 100644 --- a/src/server/api/endpoints/i.ts +++ b/src/server/api/endpoints/i.ts @@ -1,9 +1,16 @@ import User, { pack, ILocalUser } from '../../../models/user'; import { IApp } from '../../../models/app'; -/** - * Show myself - */ +export const meta = { + desc: { + ja: '自分のアカウント情報を取得します。' + }, + + requireCredential: true, + + params: {} +}; + export default (params: any, user: ILocalUser, app: IApp) => new Promise(async (res, rej) => { const isSecure = user != null && app == null; diff --git a/src/server/web/docs.ts b/src/server/web/docs.ts index f203815a5d..4d212bbeab 100644 --- a/src/server/web/docs.ts +++ b/src/server/web/docs.ts @@ -173,12 +173,11 @@ router.get('/*/api/endpoints/*', async ctx => { const vars = { title: name, - endpoint: name, + endpoint: ep.meta, url: { host: config.api_url, path: name }, - desc: ep.meta.desc, // @ts-ignore params: ep.meta.params ? sortParams(Object.entries(ep.meta.params).map(([k, v]) => parseParamDefinition(k, v))) : null, paramDefs: ep.meta.params ? extractParamDefRef(Object.entries(ep.meta.params).map(([k, v]) => v)) : null, |