matrix-spec-proposals/templating/matrix_templates/templates/http-api.tmpl

``{{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.key}}{{param.type|indent(19-param.key|length)}}{{param.desc|indent(18-param.type|length)|wrap(43)|indent_block(37)}}
{% endfor -%}
{% endfor -%}
================== ================= ===========================================

{% if endpoint.res_params|length > 0 -%}
Response format:

================== ================= ===========================================
   Parameter            Value                        Description
================== ================= ===========================================
{% for param in endpoint.res_params -%}
{{param.key}}{{param.type|indent(19-param.key|length)}}{{param.desc|indent(18-param.type|length)|wrap(43)|indent_block(37)}}
{% endfor -%}
================== ================= ===========================================
{% endif %}

Example request::

  {{endpoint.example.req | indent_block(2)}}

Example response::

  {{endpoint.example.res | indent_block(2)}}