misskey/src/docs/api/endpoints/view.pug

41 lines
694 B
Plaintext
Raw Normal View History

2018-07-15 12:05:19 +02:00
extends ../../base
2017-12-14 16:23:45 +01:00
include ../mixins
block meta
2018-04-18 11:39:04 +02:00
link(rel="stylesheet" href="/docs/assets/api/endpoints/style.css")
2017-12-14 16:23:45 +01:00
block main
h1= endpoint
2017-12-16 20:02:30 +01:00
p#url
span.method POST
span.host
= url.host
| /
span.path= url.path
2017-12-14 16:23:45 +01:00
2018-07-15 20:53:03 +02:00
if desc
p#desc= desc[lang] || desc['ja']
2017-12-14 16:23:45 +01:00
2018-07-15 20:53:03 +02:00
if params
section
h2= i18n('docs.api.endpoints.params')
+propTable(params)
if paramDefs
each paramDef in paramDefs
section(id= paramDef.name)
h3= paramDef.name
+propTable(paramDef.params)
2017-12-14 16:23:45 +01:00
2017-12-15 21:04:02 +01:00
if res
section
2018-07-06 05:17:38 +02:00
h2= i18n('docs.api.endpoints.res')
2017-12-15 21:04:02 +01:00
+propTable(res)
2018-07-07 06:34:42 +02:00
if resDefs
each resDef in resDefs
section(id= resDef.name)
h3= resDef.name
+propTable(resDef.props)