summaryrefslogtreecommitdiff
path: root/src/web/docs/api/endpoints/view.pug
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2017-12-15 00:23:45 +0900
committersyuilo <syuilotan@yahoo.co.jp>2017-12-15 00:23:45 +0900
commitd6ec5f2fe13bb1e3f4316f04591bf419f587c2bd (patch)
treee6c027442f2cbc285391e34f927ab6d3f9eb2e1a /src/web/docs/api/endpoints/view.pug
parent:v: (diff)
downloadsharkey-d6ec5f2fe13bb1e3f4316f04591bf419f587c2bd.tar.gz
sharkey-d6ec5f2fe13bb1e3f4316f04591bf419f587c2bd.tar.bz2
sharkey-d6ec5f2fe13bb1e3f4316f04591bf419f587c2bd.zip
:v:
Diffstat (limited to 'src/web/docs/api/endpoints/view.pug')
-rw-r--r--src/web/docs/api/endpoints/view.pug75
1 files changed, 21 insertions, 54 deletions
diff --git a/src/web/docs/api/endpoints/view.pug b/src/web/docs/api/endpoints/view.pug
index 841ca8b3f9..cebef9fa5b 100644
--- a/src/web/docs/api/endpoints/view.pug
+++ b/src/web/docs/api/endpoints/view.pug
@@ -1,63 +1,30 @@
-doctype html
+extends ../../layout.pug
+include ../mixins
-mixin i18n(xs)
- each text, lang in xs
- span(class=`i18n ${lang}`)= text
+block title
+ | #{endpoint} | Misskey API
-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} (
- a(href=`/docs/api/entities/${param.entity}`)= param.entity
- | ID)
- else if param.kind == 'entity'
- | #{param.type} (
- a(href=`/docs/api/entities/${param.entity}`)= param.entity
- | )
- else if param.kind == 'object'
- | #{param.type} (
- a(href=`#${param.defName}`)= param.defName
- | )
- else
- = param.type
- td.optional= param.optional.toString()
- td.desc: +i18n(param.desc)
+block meta
+ link(rel="stylesheet" href="/assets/docs/api/endpoints/style.css")
-html
- head
- meta(charset="UTF-8")
- title #{endpoint} | Misskey API
- link(rel="stylesheet" href="/assets/docs/api/endpoints/style.css")
+block main
+ h1= endpoint
- body
- main
- h1= endpoint
+ p#url= url
- p#url= url
+ p#desc: +i18n(desc)
- p#desc: +i18n(desc)
+ section
+ h2 Params
+ +propTable(params)
- section
- h2 Params
- +table(params)
+ if paramDefs
+ each paramDef in paramDefs
+ section(id= paramDef.name)
+ h3= paramDef.name
+ +propTable(paramDef.params)
- if paramDefs
- each paramDef in paramDefs
- section(id= paramDef.name)
- h3= paramDef.name
- +table(paramDef.params)
-
- section
- h2 Response
- +table(res)
+ section
+ h2 Response
+ +propTable(res)