diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2018-07-17 03:57:34 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2018-07-17 03:57:34 +0900 |
| commit | f88ac3c04e5d335860a41e59d3936fa38d1d9989 (patch) | |
| tree | 7a3b63b44381d2e1e509d6b02aa0152f6e652167 /src/server | |
| parent | :art: (diff) | |
| download | misskey-f88ac3c04e5d335860a41e59d3936fa38d1d9989.tar.gz misskey-f88ac3c04e5d335860a41e59d3936fa38d1d9989.tar.bz2 misskey-f88ac3c04e5d335860a41e59d3936fa38d1d9989.zip | |
Improve doc
Diffstat (limited to 'src/server')
| -rw-r--r-- | src/server/api/endpoints/i.ts | 7 | ||||
| -rw-r--r-- | src/server/web/docs.ts | 9 |
2 files changed, 12 insertions, 4 deletions
diff --git a/src/server/api/endpoints/i.ts b/src/server/api/endpoints/i.ts index 8219100d60..7f25c07957 100644 --- a/src/server/api/endpoints/i.ts +++ b/src/server/api/endpoints/i.ts @@ -8,7 +8,12 @@ export const meta = { requireCredential: true, - params: {} + params: {}, + + res: { + type: 'entity', + entity: 'User' + } }; export default (params: any, user: ILocalUser, app: IApp) => new Promise(async (res, rej) => { diff --git a/src/server/web/docs.ts b/src/server/web/docs.ts index 233178eee2..59899c078e 100644 --- a/src/server/web/docs.ts +++ b/src/server/web/docs.ts @@ -182,8 +182,10 @@ router.get('/*/api/endpoints/*', async ctx => { // @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, - res: ep.meta.res && ep.meta.res.props ? sortParams(Object.entries(ep.meta.res.props).map(([k, v]) => parsePropDefinition(k, v))) : null, - resDefs: null//extractPropDefRef(Object.entries(ep.res.props).map(([k, v]) => parsePropDefinition(k, v))) + res: ep.meta.res, + resProps: ep.meta.res && ep.meta.res.props ? sortParams(Object.entries(ep.meta.res.props).map(([k, v]) => parsePropDefinition(k, v))) : null, + resDefs: null,//extractPropDefRef(Object.entries(ep.res.props).map(([k, v]) => parsePropDefinition(k, v))) + src: `https://github.com/syuilo/misskey/tree/master/src/server/api/endpoints/${name}.ts` }; await ctx.render('../../../../src/docs/api/endpoints/view', Object.assign(await genVars(lang), vars)); @@ -227,7 +229,8 @@ router.get('/*/*', async ctx => { await ctx.render('../../../../src/docs/article', Object.assign({ html: conv.makeHtml(md), - title: md.match(/^# (.+?)\r?\n/)[1] + title: md.match(/^# (.+?)\r?\n/)[1], + src: `https://github.com/syuilo/misskey/tree/master/src/docs/${doc}.${lang}.md` }, await genVars(lang))); }); |