e2net/iceshrimp-legacy
2
0
Fork 0
Code Issues Pull requests Packages Projects Releases Activity

Improve doc

Browse source
This commit is contained in:
syuilo 2018-07-17 00:46:06 +09:00
parent 4cad36572c
commit 1d867b8aca
2 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
locales/ja.yml
View file

@ -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: "型"

8
src/docs/api/endpoints/view.pug
View file

@ -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