mizzkey/src/web/docs/api/endpoints/view.pug

65 lines
1.2 KiB
Plaintext
Raw Normal View History

2017-12-14 08:24:41 +01:00
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
| )
2017-12-14 14:36:04 +01:00
else if param.kind == 'entity'
| #{param.type} (
a(href=`/docs/api/entities/${param.entity}`)= param.entity
| )
2017-12-14 08:24:41 +01:00
else if param.kind == 'object'
| #{param.type} (
2017-12-14 14:36:04 +01:00
a(href=`#${param.defName}`)= param.defName
2017-12-14 08:24:41 +01:00
| )
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)