diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2019-02-24 12:40:17 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2019-02-24 12:40:17 +0900 |
| commit | b8e0ec9edc6788dfea4dec02cb93558e7f5d2736 (patch) | |
| tree | abae00d84a790cbf4494817a596e76c723a0d536 /src/server/api/endpoints | |
| parent | Update typescript to 3.3.3333 :rocket: (diff) | |
| download | sharkey-b8e0ec9edc6788dfea4dec02cb93558e7f5d2736.tar.gz sharkey-b8e0ec9edc6788dfea4dec02cb93558e7f5d2736.tar.bz2 sharkey-b8e0ec9edc6788dfea4dec02cb93558e7f5d2736.zip | |
Improve doc
Diffstat (limited to 'src/server/api/endpoints')
| -rw-r--r-- | src/server/api/endpoints/auth/session/generate.ts | 6 | ||||
| -rw-r--r-- | src/server/api/endpoints/auth/session/show.ts | 6 | ||||
| -rw-r--r-- | src/server/api/endpoints/auth/session/userkey.ts | 12 |
3 files changed, 20 insertions, 4 deletions
diff --git a/src/server/api/endpoints/auth/session/generate.ts b/src/server/api/endpoints/auth/session/generate.ts index b6bfb5590b..9473aa943a 100644 --- a/src/server/api/endpoints/auth/session/generate.ts +++ b/src/server/api/endpoints/auth/session/generate.ts @@ -13,7 +13,11 @@ export const meta = { params: { appSecret: { - validator: $.str + validator: $.str, + desc: { + 'ja-JP': 'アプリケーションのシークレットキー', + 'en-US': 'The secret key of your application.' + } } }, diff --git a/src/server/api/endpoints/auth/session/show.ts b/src/server/api/endpoints/auth/session/show.ts index 4287950f3e..992e0a499e 100644 --- a/src/server/api/endpoints/auth/session/show.ts +++ b/src/server/api/endpoints/auth/session/show.ts @@ -10,7 +10,11 @@ export const meta = { params: { token: { - validator: $.str + validator: $.str, + desc: { + 'ja-JP': 'セッションのトークン', + 'en-US': 'The token of a session.' + } } }, diff --git a/src/server/api/endpoints/auth/session/userkey.ts b/src/server/api/endpoints/auth/session/userkey.ts index d4c3d77772..49dde23ede 100644 --- a/src/server/api/endpoints/auth/session/userkey.ts +++ b/src/server/api/endpoints/auth/session/userkey.ts @@ -13,11 +13,19 @@ export const meta = { params: { appSecret: { - validator: $.str + validator: $.str, + desc: { + 'ja-JP': 'アプリケーションのシークレットキー', + 'en-US': 'The secret key of your application.' + } }, token: { - validator: $.str + validator: $.str, + desc: { + 'ja-JP': 'セッションのトークン', + 'en-US': 'The token of a session.' + } } }, |