graphite/Sharkey
1
0
Fork 0
mirror of https://git.joinsharkey.org/Sharkey/Sharkey.git synced 2024-12-23 21:43:09 +02:00
Code Issues Projects Releases Packages Wiki Activity

Improve doc

Browse source
This commit is contained in:
syuilo 2018-07-18 00:47:09 +09:00
parent 481f1a7c36
commit f9d5d9e30b
3 changed files with 19 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
locales/ja.yml
View file

@ -1101,6 +1101,7 @@ docs:
no-params: "パラメータはありません" no-params: "パラメータはありません"
res: "レスポンス" res: "レスポンス"
require-credential: "このエンドポイントは認証情報が必須です。" require-credential: "このエンドポイントは認証情報が必須です。"
require-permission: "このエンドポイントは{permission}の権限を必要とします。"
has-limit: "レートリミットがあります。" has-limit: "レートリミットがあります。"
duration-limit: "直近{duration}ミリ秒の間のこのエンドポイントへのリクエスト数の合計が{max}を超える場合はリクエストできません。" duration-limit: "直近{duration}ミリ秒の間のこのエンドポイントへのリクエスト数の合計が{max}を超える場合はリクエストできません。"
min-interval-limit: "前回のリクエストから{interval}ミリ秒経っていない場合はリクエストできません。" min-interval-limit: "前回のリクエストから{interval}ミリ秒経っていない場合はリクエストできません。"

4
src/docs/api/endpoints/style.styl
View file

@ -6,12 +6,14 @@
color #fff color #fff
background #222e40 background #222e40
border-radius 4px border-radius 4px
overflow auto
white-space nowrap
> .method > .method
display inline-block display inline-block
margin 0 8px 0 0 margin 0 8px 0 0
padding 0 6px padding 0 6px
color #f4fcff color #fff
background #17afc7 background #17afc7
border-radius 4px border-radius 4px
user-select none user-select none

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

@ -18,16 +18,23 @@ block main
p#desc= endpoint.desc[lang] || endpoint.desc['ja'] p#desc= endpoint.desc[lang] || endpoint.desc['ja']
if endpoint.requireCredential 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 if endpoint.limit
div.ui.info.warn div.ui.info.warn: p
p i.far.fa-clock(style="margin-right: 4px")
b!= i18n('docs.api.endpoints.has-limit') b!= i18n('docs.api.endpoints.has-limit')
if endpoint.limit.duration if endpoint.limit.duration
!= i18n('docs.api.endpoints.duration-limit').replace('{duration}', endpoint.limit.duration).replace('{max}', endpoint.limit.max) != i18n('docs.api.endpoints.duration-limit').replace('{duration}', endpoint.limit.duration).replace('{max}', endpoint.limit.max)
if endpoint.limit.minInterval if endpoint.limit.minInterval
!= i18n('docs.api.endpoints.min-interval-limit').replace('{interval}', endpoint.limit.minInterval) != i18n('docs.api.endpoints.min-interval-limit').replace('{interval}', endpoint.limit.minInterval)
if params && Object.keys(params).length > 0 if params && Object.keys(params).length > 0
section section