Clarify when authorization and rate-limiting are not applicable
Fixes https://github.com/matrix-org/matrix-doc/issues/1971
This commit is contained in:
parent
9ac89cc915
commit
79bbb47d9f
2 changed files with 10 additions and 9 deletions
|
@ -0,0 +1 @@
|
||||||
|
Clarify when authorization and rate-limiting are not applicable.
|
|
@ -10,13 +10,13 @@
|
||||||
|
|
||||||
{{endpoint.desc}}
|
{{endpoint.desc}}
|
||||||
|
|
||||||
{{":Rate-limited: Yes." if endpoint.rate_limited else "" }}
|
{{":Rate-limited: Yes." if endpoint.rate_limited else ":Rate-limited: No." }}
|
||||||
{{":Requires auth: Yes." if endpoint.requires_auth else "" }}
|
{{":Requires auth: Yes." if endpoint.requires_auth else ":Requires auth: No." }}
|
||||||
|
|
||||||
.. class:: httpheaders
|
.. class:: httpheaders
|
||||||
|
|
||||||
Request format:
|
Request format:
|
||||||
|
|
||||||
{% if (endpoint.req_param_by_loc | length) %}
|
{% if (endpoint.req_param_by_loc | length) %}
|
||||||
{{ tables.split_paramtable(endpoint.req_param_by_loc) }}
|
{{ tables.split_paramtable(endpoint.req_param_by_loc) }}
|
||||||
{% if (endpoint.req_body_tables) %}
|
{% if (endpoint.req_body_tables) %}
|
||||||
|
@ -33,7 +33,7 @@
|
||||||
{% if endpoint.res_headers is not none -%}
|
{% if endpoint.res_headers is not none -%}
|
||||||
|
|
||||||
.. class:: httpheaders
|
.. class:: httpheaders
|
||||||
|
|
||||||
Response headers:
|
Response headers:
|
||||||
|
|
||||||
{{ tables.paramtable(endpoint.res_headers.rows) }}
|
{{ tables.paramtable(endpoint.res_headers.rows) }}
|
||||||
|
@ -42,7 +42,7 @@
|
||||||
{% if endpoint.res_tables|length > 0 -%}
|
{% if endpoint.res_tables|length > 0 -%}
|
||||||
|
|
||||||
.. class:: httpheaders
|
.. class:: httpheaders
|
||||||
|
|
||||||
Response format:
|
Response format:
|
||||||
|
|
||||||
{% for table in endpoint.res_tables -%}
|
{% for table in endpoint.res_tables -%}
|
||||||
|
@ -54,7 +54,7 @@
|
||||||
{% endif -%}
|
{% endif -%}
|
||||||
|
|
||||||
.. class:: httpheaders
|
.. class:: httpheaders
|
||||||
|
|
||||||
Example request:
|
Example request:
|
||||||
|
|
||||||
.. code:: http
|
.. code:: http
|
||||||
|
@ -64,7 +64,7 @@
|
||||||
{% if endpoint.responses|length > 0 -%}
|
{% if endpoint.responses|length > 0 -%}
|
||||||
|
|
||||||
.. class:: httpheaders
|
.. class:: httpheaders
|
||||||
|
|
||||||
Response{{"s" if endpoint.responses|length > 1 else "" }}:
|
Response{{"s" if endpoint.responses|length > 1 else "" }}:
|
||||||
|
|
||||||
{% endif -%}
|
{% endif -%}
|
||||||
|
@ -78,7 +78,7 @@
|
||||||
{% if res["example"] -%}
|
{% if res["example"] -%}
|
||||||
|
|
||||||
.. class:: httpheaders
|
.. class:: httpheaders
|
||||||
|
|
||||||
Example
|
Example
|
||||||
|
|
||||||
.. code:: json
|
.. code:: json
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue