Deprecated deprecated APIs
This commit is contained in:
parent
678dbbe08a
commit
3e086909f1
4 changed files with 10 additions and 0 deletions
|
@ -89,6 +89,7 @@ paths:
|
||||||
description: "Bad pagination ``from`` parameter."
|
description: "Bad pagination ``from`` parameter."
|
||||||
tags:
|
tags:
|
||||||
- Room participation
|
- Room participation
|
||||||
|
deprecated: true
|
||||||
"/initialSync":
|
"/initialSync":
|
||||||
get:
|
get:
|
||||||
summary: Get the user's current state.
|
summary: Get the user's current state.
|
||||||
|
@ -369,6 +370,7 @@ paths:
|
||||||
description: There is no avatar URL for this user or this user does not exist.
|
description: There is no avatar URL for this user or this user does not exist.
|
||||||
tags:
|
tags:
|
||||||
- Room participation
|
- Room participation
|
||||||
|
deprecated: true
|
||||||
"/events/{eventId}":
|
"/events/{eventId}":
|
||||||
get:
|
get:
|
||||||
summary: Get a single event by event ID.
|
summary: Get a single event by event ID.
|
||||||
|
@ -406,3 +408,4 @@ paths:
|
||||||
description: The event was not found or you do not have permission to read this event.
|
description: The event was not found or you do not have permission to read this event.
|
||||||
tags:
|
tags:
|
||||||
- Room participation
|
- Room participation
|
||||||
|
deprecated: true
|
||||||
|
|
|
@ -432,6 +432,7 @@ paths:
|
||||||
member of the room.
|
member of the room.
|
||||||
tags:
|
tags:
|
||||||
- Room participation
|
- Room participation
|
||||||
|
deprecated: true
|
||||||
"/rooms/{roomId}/members":
|
"/rooms/{roomId}/members":
|
||||||
get:
|
get:
|
||||||
summary: Get the m.room.member events for the room.
|
summary: Get the m.room.member events for the room.
|
||||||
|
|
|
@ -2,6 +2,11 @@
|
||||||
|
|
||||||
``{{endpoint.method}} {{endpoint.path}}``
|
``{{endpoint.method}} {{endpoint.path}}``
|
||||||
{{(5 + (endpoint.path | length) + (endpoint.method | length)) * title_kind}}
|
{{(5 + (endpoint.path | length) + (endpoint.method | length)) * title_kind}}
|
||||||
|
{% if "deprecated" in endpoint and endpoint.deprecated -%}
|
||||||
|
.. WARNING::
|
||||||
|
This API is deprecated and will be removed from a future release.
|
||||||
|
|
||||||
|
{% endif -%}
|
||||||
{% if "alias_for_path" in endpoint -%}
|
{% if "alias_for_path" in endpoint -%}
|
||||||
``{{endpoint.path}}`` is an alias for `{{endpoint.alias_for_path}}`_.
|
``{{endpoint.path}}`` is an alias for `{{endpoint.alias_for_path}}`_.
|
||||||
|
|
||||||
|
|
|
@ -269,6 +269,7 @@ class MatrixUnits(Units):
|
||||||
full_path = api.get("basePath", "").rstrip("/") + path
|
full_path = api.get("basePath", "").rstrip("/") + path
|
||||||
endpoint = {
|
endpoint = {
|
||||||
"title": single_api.get("summary", ""),
|
"title": single_api.get("summary", ""),
|
||||||
|
"deprecated": single_api.get("deprecated", False),
|
||||||
"desc": single_api.get("description", single_api.get("summary", "")),
|
"desc": single_api.get("description", single_api.get("summary", "")),
|
||||||
"method": method.upper(),
|
"method": method.upper(),
|
||||||
"path": full_path.strip(),
|
"path": full_path.strip(),
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue