diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2018-07-16 06:19:19 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2018-07-16 06:19:19 +0900 |
| commit | 168d13d6e687b87906b2dfd8f7206d03cec32bdc (patch) | |
| tree | c0564e9ebe3ce92f0154c9e009b7c9b5c1b65178 /src/docs/api/endpoints | |
| parent | Update docs (diff) | |
| download | sharkey-168d13d6e687b87906b2dfd8f7206d03cec32bdc.tar.gz sharkey-168d13d6e687b87906b2dfd8f7206d03cec32bdc.tar.bz2 sharkey-168d13d6e687b87906b2dfd8f7206d03cec32bdc.zip | |
Improve docs
Diffstat (limited to 'src/docs/api/endpoints')
| -rw-r--r-- | src/docs/api/endpoints/view.pug | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/src/docs/api/endpoints/view.pug b/src/docs/api/endpoints/view.pug index 809fc07204..e7bfba086e 100644 --- a/src/docs/api/endpoints/view.pug +++ b/src/docs/api/endpoints/view.pug @@ -5,7 +5,7 @@ block meta link(rel="stylesheet" href="/docs/assets/api/endpoints/style.css") block main - h1= endpoint + h1= title p#url span.method POST @@ -14,10 +14,13 @@ block main | / span.path= url.path - if desc - p#desc= desc[lang] || desc['ja'] + if endpoint.desc + p#desc= endpoint.desc[lang] || endpoint.desc['ja'] - if params + if endpoint.requireCredential + div.ui.info: p= i18n('docs.api.endpoints.require-credential') + + if params && Object.keys(params).length > 0 section h2= i18n('docs.api.endpoints.params') +propTable(params) @@ -27,6 +30,10 @@ block main section(id= paramDef.name) h3= paramDef.name +propTable(paramDef.params) + if params && Object.keys(params).length == 0 + section + h2= i18n('docs.api.endpoints.params') + p= i18n('docs.api.endpoints.no-params') if res section |