diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2017-12-14 16:24:41 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2017-12-14 16:24:41 +0900 |
| commit | 5166fc92b64af25946b9c5a55ee05cebca0d24fa (patch) | |
| tree | 76f81e15699273bf2baa2dc3e237adc95a097183 /src/web/docs/api/endpoints/view.pug | |
| parent | Merge branch 'master' of https://github.com/syuilo/misskey (diff) | |
| download | sharkey-5166fc92b64af25946b9c5a55ee05cebca0d24fa.tar.gz sharkey-5166fc92b64af25946b9c5a55ee05cebca0d24fa.tar.bz2 sharkey-5166fc92b64af25946b9c5a55ee05cebca0d24fa.zip | |
:pizza:
Diffstat (limited to 'src/web/docs/api/endpoints/view.pug')
| -rw-r--r-- | src/web/docs/api/endpoints/view.pug | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/src/web/docs/api/endpoints/view.pug b/src/web/docs/api/endpoints/view.pug new file mode 100644 index 0000000000..d9de9cb74a --- /dev/null +++ b/src/web/docs/api/endpoints/view.pug @@ -0,0 +1,60 @@ +doctype html + +mixin i18n(xs) + each text, lang in xs + span(class=`i18n ${lang}`)= text + +mixin table(params) + table + thead: tr + th Name + th Type + th Optional + th Description + tbody + each param in params + tr + td.name= param.name + td.type + if param.kind == 'id' + | #{param.type} (ID of + = ' ' + a(href=`/docs/api/entities/${param.entity}`)= param.entity + | ) + else if param.kind == 'object' + | #{param.type} ( + a(href=`#${param.def}`)= param.def + | ) + else + = param.type + td.optional= param.optional.toString() + td.desc: +i18n(param.desc) + +html + head + meta(charset="UTF-8") + title #{endpoint} | Misskey API + link(rel="stylesheet" href="/assets/docs/api/endpoints/style.css") + + body + main + h1= endpoint + + p#url= url + + p#desc: +i18n(desc) + + section + h2 Params + +table(params) + + if paramDefs + each paramDef in paramDefs + section(id= paramDef.name) + h3= paramDef.name + +table(paramDef.params) + + section + h2 Response + +table(res) + |