mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-04-22 18:54:09 +02:00
29 lines
1.1 KiB
Cheetah
29 lines
1.1 KiB
Cheetah
``{{endpoint.method}} {{endpoint.path}}``
|
|
{{(5 + (endpoint.path | length) + (endpoint.method | length)) * title_kind}}
|
|
|
|
{{endpoint.desc | wrap(80)}}
|
|
|
|
{{":Rate-limited: Yes." if endpoint.rate_limited else "" }}
|
|
{{":Requires auth: Yes." if endpoint.requires_auth else "" }}
|
|
|
|
Request format:
|
|
|
|
================== ================= ===========================================
|
|
Parameter Value Description
|
|
================== ================= ===========================================
|
|
{% for loc in endpoint.req_param_by_loc -%}
|
|
**{{loc}} parameters**
|
|
--------------------------------------------------------------------------------
|
|
{% for param in endpoint.req_param_by_loc[loc] -%}
|
|
{{param.name}}{{param.type|indent(19-param.name|length)}}{{param.desc|indent(18-param.type|length)|wrap(43)|indent_block(37)}}
|
|
{% endfor %}
|
|
{% endfor %}
|
|
================== ================= ===========================================
|
|
|
|
Example request::
|
|
|
|
{{endpoint.example.req | indent_block(2)}}
|
|
|
|
Example response::
|
|
|
|
{{endpoint.example.res | indent_block(2)}} |