From 1d867b8aca33233ab1c0de18eecbeeadfdb47fa5 Mon Sep 17 00:00:00 2001 From: syuilo Date: Tue, 17 Jul 2018 00:46:06 +0900 Subject: [PATCH] Improve doc --- locales/ja.yml | 4 +++- src/docs/api/endpoints/view.pug | 8 +++++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/locales/ja.yml b/locales/ja.yml index 136554a5c..cb09b8446 100644 --- a/locales/ja.yml +++ b/locales/ja.yml @@ -1101,7 +1101,9 @@ docs: no-params: "パラメータはありません" res: "レスポンス" require-credential: "このエンドポイントは認証情報が必須です。" - limit: "レートリミットがあります。直近{duration}ミリ秒の間のこのエンドポイントへのリクエスト数の合計が{max}を超える場合はリクエストできません。" + has-limit: "レートリミットがあります。" + duration-limit: "直近{duration}ミリ秒の間のこのエンドポイントへのリクエスト数の合計が{max}を超える場合はリクエストできません。" + min-interval-limit: "前回のリクエストから{interval}ミリ秒経っていない場合はリクエストできません。" props: name: "名前" type: "型" diff --git a/src/docs/api/endpoints/view.pug b/src/docs/api/endpoints/view.pug index 0ae78a02a..b8955511f 100644 --- a/src/docs/api/endpoints/view.pug +++ b/src/docs/api/endpoints/view.pug @@ -21,7 +21,13 @@ block main div.ui.info: p= i18n('docs.api.endpoints.require-credential') if endpoint.limit - div.ui.warn: p!= i18n('docs.api.endpoints.limit').replace('{duration}', endpoint.limit.duration).replace('{max}', endpoint.limit.max) + div.ui.info.warn + p + b!= i18n('docs.api.endpoints.has-limit') + if endpoint.limit.duration + != i18n('docs.api.endpoints.duration-limit').replace('{duration}', endpoint.limit.duration).replace('{max}', endpoint.limit.max) + if endpoint.limit.minInterval + != i18n('docs.api.endpoints.min-interval-limit').replace('{interval}', endpoint.limit.minInterval) if params && Object.keys(params).length > 0 section