diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2018-07-18 00:47:09 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2018-07-18 00:47:09 +0900 |
| commit | f9d5d9e30bbd06a5d3c5d914334ea416b5b3bcee (patch) | |
| tree | 0fe8bc615e98ac5d5ee73c93654e73c1c4b428be | |
| parent | 4.21.0 (diff) | |
| download | misskey-f9d5d9e30bbd06a5d3c5d914334ea416b5b3bcee.tar.gz misskey-f9d5d9e30bbd06a5d3c5d914334ea416b5b3bcee.tar.bz2 misskey-f9d5d9e30bbd06a5d3c5d914334ea416b5b3bcee.zip | |
Improve doc
| -rw-r--r-- | locales/ja.yml | 1 | ||||
| -rw-r--r-- | src/docs/api/endpoints/style.styl | 4 | ||||
| -rw-r--r-- | src/docs/api/endpoints/view.pug | 23 |
3 files changed, 19 insertions, 9 deletions
diff --git a/locales/ja.yml b/locales/ja.yml index 22514db507..3575379345 100644 --- a/locales/ja.yml +++ b/locales/ja.yml @@ -1101,6 +1101,7 @@ docs: no-params: "パラメータはありません" res: "レスポンス" require-credential: "このエンドポイントは認証情報が必須です。" + require-permission: "このエンドポイントは{permission}の権限を必要とします。" has-limit: "レートリミットがあります。" duration-limit: "直近{duration}ミリ秒の間のこのエンドポイントへのリクエスト数の合計が{max}を超える場合はリクエストできません。" min-interval-limit: "前回のリクエストから{interval}ミリ秒経っていない場合はリクエストできません。" diff --git a/src/docs/api/endpoints/style.styl b/src/docs/api/endpoints/style.styl index 2af9fe9a77..e7e32b3395 100644 --- a/src/docs/api/endpoints/style.styl +++ b/src/docs/api/endpoints/style.styl @@ -6,12 +6,14 @@ color #fff background #222e40 border-radius 4px + overflow auto + white-space nowrap > .method display inline-block margin 0 8px 0 0 padding 0 6px - color #f4fcff + color #fff background #17afc7 border-radius 4px user-select none diff --git a/src/docs/api/endpoints/view.pug b/src/docs/api/endpoints/view.pug index 4a11c4cd02..1d7801ab4b 100644 --- a/src/docs/api/endpoints/view.pug +++ b/src/docs/api/endpoints/view.pug @@ -18,16 +18,23 @@ block main p#desc= endpoint.desc[lang] || endpoint.desc['ja'] if endpoint.requireCredential - div.ui.info: p= i18n('docs.api.endpoints.require-credential') + div.ui.info: p + i.fas.fa-id-card-alt(style="margin-right: 4px") + = i18n('docs.api.endpoints.require-credential') + + if endpoint.kind + div.ui.info: p + i.fas.fa-unlock-alt(style="margin-right: 4px") + != i18n('docs.api.endpoints.require-permission').replace('{permission}', `<code>${endpoint.kind}</code>`) if endpoint.limit - 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) + div.ui.info.warn: p + i.far.fa-clock(style="margin-right: 4px") + 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 |