APIドキュメントの説明とか一部追記 (#4702)

* Define description in generate.ts

* Add description in create.ts
This commit is contained in:
YuzuRyo61 2019-04-15 23:26:20 +09:00 committed by syuilo
parent 168c22fc98
commit 71df3e1566
2 changed files with 53 additions and 4 deletions

View file

@ -9,25 +9,69 @@ export const meta = {
tags: ['app'], tags: ['app'],
requireCredential: false, requireCredential: false,
desc: {
'ja-JP': 'アプリを作成します。',
'en-US': 'Create a application.'
},
params: { params: {
name: { name: {
validator: $.str validator: $.str,
desc: {
'ja-JP': 'アプリの名前',
'en-US': 'Name of application'
}
}, },
description: { description: {
validator: $.str validator: $.str,
desc: {
'ja-JP': 'アプリの説明',
'en-US': 'Description of application'
}
}, },
permission: { permission: {
validator: $.arr($.str).unique() validator: $.arr($.str).unique(),
desc: {
'ja-JP': 'このアプリに割り当てる権限(権限については"Permissions"を参照)',
'en-US': 'Permissions assigned to this app (see "Permissions" for the permissions)'
}
}, },
// TODO: Check it is valid url // TODO: Check it is valid url
callbackUrl: { callbackUrl: {
validator: $.optional.nullable.str, validator: $.optional.nullable.str,
default: null as any default: null as any,
desc: {
'ja-JP': 'アプリ認証時にコールバックするURL',
'en-US': 'URL to call back at app authentication'
}
}, },
},
res: {
type: 'object',
properties: {
id: {
type: 'string',
description: 'アプリケーションのID'
},
name: {
type: 'string',
description: 'アプリケーションの名前'
},
callbackUrl: {
type: 'string',
nullable: true,
description: 'コールバックするURL'
},
secret: {
type: 'string',
description: 'アプリケーションのシークレットキー'
}
}
} }
}; };

View file

@ -10,6 +10,11 @@ export const meta = {
tags: ['auth'], tags: ['auth'],
requireCredential: false, requireCredential: false,
desc: {
'ja-JP': 'アプリを認証するためのトークンを作成します。',
'en-US': 'Generate a token for authorize application.'
},
params: { params: {
appSecret: { appSecret: {