Remove RST alert directives, replace with simple Markdown formatting
This commit is contained in:
parent
00c6a866e2
commit
c7cf90abfa
11 changed files with 68 additions and 70 deletions
|
@ -96,11 +96,11 @@ paths:
|
||||||
This endpoint is deprecated in favour of the more specific ``/3pid/add``
|
This endpoint is deprecated in favour of the more specific ``/3pid/add``
|
||||||
and ``/3pid/bind`` endpoints.
|
and ``/3pid/bind`` endpoints.
|
||||||
|
|
||||||
.. Note::
|
**Note:**
|
||||||
Previously this endpoint supported a ``bind`` parameter. This parameter
|
Previously this endpoint supported a ``bind`` parameter. This parameter
|
||||||
has been removed, making this endpoint behave as though it was ``false``.
|
has been removed, making this endpoint behave as though it was ``false``.
|
||||||
This results in this endpoint being an equivalent to ``/3pid/bind`` rather
|
This results in this endpoint being an equivalent to ``/3pid/bind`` rather
|
||||||
than dual-purpose.
|
than dual-purpose.
|
||||||
operationId: post3PIDs
|
operationId: post3PIDs
|
||||||
deprecated: true
|
deprecated: true
|
||||||
security:
|
security:
|
||||||
|
|
|
@ -347,11 +347,11 @@ paths:
|
||||||
Get information about a URL for the client. Typically this is called when a
|
Get information about a URL for the client. Typically this is called when a
|
||||||
client sees a URL in a message and wants to render a preview for the user.
|
client sees a URL in a message and wants to render a preview for the user.
|
||||||
|
|
||||||
.. Note::
|
**Note:**
|
||||||
Clients should consider avoiding this endpoint for URLs posted in encrypted
|
Clients should consider avoiding this endpoint for URLs posted in encrypted
|
||||||
rooms. Encrypted rooms often contain more sensitive information the users
|
rooms. Encrypted rooms often contain more sensitive information the users
|
||||||
do not want to share with the homeserver, and this can mean that the URLs
|
do not want to share with the homeserver, and this can mean that the URLs
|
||||||
being shared should also not be shared with the homeserver.
|
being shared should also not be shared with the homeserver.
|
||||||
|
|
||||||
operationId: getUrlPreview
|
operationId: getUrlPreview
|
||||||
produces: ["application/json"]
|
produces: ["application/json"]
|
||||||
|
|
|
@ -132,12 +132,12 @@ paths:
|
||||||
Servers may choose to implement additional access control checks here, for instance that
|
Servers may choose to implement additional access control checks here, for instance that
|
||||||
room aliases can only be deleted by their creator or a server administrator.
|
room aliases can only be deleted by their creator or a server administrator.
|
||||||
|
|
||||||
.. Note::
|
**Note:**
|
||||||
Servers may choose to update the ``alt_aliases`` for the ``m.room.canonical_alias``
|
Servers may choose to update the ``alt_aliases`` for the ``m.room.canonical_alias``
|
||||||
state event in the room when an alias is removed. Servers which choose to update the
|
state event in the room when an alias is removed. Servers which choose to update the
|
||||||
canonical alias event are recommended to, in addition to their other relevant permission
|
canonical alias event are recommended to, in addition to their other relevant permission
|
||||||
checks, delete the alias and return a successful response even if the user does not
|
checks, delete the alias and return a successful response even if the user does not
|
||||||
have permission to update the ``m.room.canonical_alias`` event.
|
have permission to update the ``m.room.canonical_alias`` event.
|
||||||
|
|
||||||
operationId: deleteRoomAlias
|
operationId: deleteRoomAlias
|
||||||
security:
|
security:
|
||||||
|
@ -184,10 +184,10 @@ paths:
|
||||||
such as allowing server administrators to view aliases regardless of
|
such as allowing server administrators to view aliases regardless of
|
||||||
membership.
|
membership.
|
||||||
|
|
||||||
.. Note::
|
**Note:**
|
||||||
Clients are recommended not to display this list of aliases prominently
|
Clients are recommended not to display this list of aliases prominently
|
||||||
as they are not curated, unlike those listed in the ``m.room.canonical_alias``
|
as they are not curated, unlike those listed in the ``m.room.canonical_alias``
|
||||||
state event.
|
state event.
|
||||||
|
|
||||||
operationId: getLocalAliases
|
operationId: getLocalAliases
|
||||||
security:
|
security:
|
||||||
|
|
|
@ -64,13 +64,13 @@ paths:
|
||||||
A transaction containing the PDUs that preceded the given event(s), including the given
|
A transaction containing the PDUs that preceded the given event(s), including the given
|
||||||
event(s), up to the given limit.
|
event(s), up to the given limit.
|
||||||
|
|
||||||
.. Note::
|
**Note:**
|
||||||
Though the PDU definitions require that ``prev_events`` and ``auth_events`` be limited
|
Though the PDU definitions require that ``prev_events`` and ``auth_events`` be limited
|
||||||
in number, the response of backfill MUST NOT be validated on these specific restrictions.
|
in number, the response of backfill MUST NOT be validated on these specific restrictions.
|
||||||
|
|
||||||
Due to historical reasons, it is possible that events which were previously accepted
|
Due to historical reasons, it is possible that events which were previously accepted
|
||||||
would now be rejected by these limitations. The events should be rejected per usual by
|
would now be rejected by these limitations. The events should be rejected per usual by
|
||||||
the ``/send``, ``/get_missing_events``, and remaining endpoints.
|
the ``/send``, ``/get_missing_events``, and remaining endpoints.
|
||||||
schema:
|
schema:
|
||||||
$ref: "definitions/unlimited_pdu_transaction.yaml"
|
$ref: "definitions/unlimited_pdu_transaction.yaml"
|
||||||
"/get_missing_events/{roomId}":
|
"/get_missing_events/{roomId}":
|
||||||
|
|
|
@ -31,9 +31,9 @@ paths:
|
||||||
put:
|
put:
|
||||||
summary: Invites a remote user to a room
|
summary: Invites a remote user to a room
|
||||||
description: |-
|
description: |-
|
||||||
.. Note::
|
**Note:**
|
||||||
This API is nearly identical to the v1 API with the exception of the request
|
This API is nearly identical to the v1 API with the exception of the request
|
||||||
body being different, and the response format fixed.
|
body being different, and the response format fixed.
|
||||||
|
|
||||||
Invites a remote user to a room. Once the event has been signed by both the inviting
|
Invites a remote user to a room. Once the event has been signed by both the inviting
|
||||||
homeserver and the invited homeserver, it can be sent to all of the servers in the
|
homeserver and the invited homeserver, it can be sent to all of the servers in the
|
||||||
|
|
|
@ -171,14 +171,13 @@ paths:
|
||||||
"errcode": "M_NOT_FOUND",
|
"errcode": "M_NOT_FOUND",
|
||||||
"error": "Unknown room",
|
"error": "Unknown room",
|
||||||
}
|
}
|
||||||
|
|
||||||
"/send_join/{roomId}/{eventId}":
|
"/send_join/{roomId}/{eventId}":
|
||||||
put:
|
put:
|
||||||
summary: Submit a signed join event to a resident server
|
summary: Submit a signed join event to a resident server
|
||||||
description: |-
|
description: |-
|
||||||
.. Note::
|
**Note:**
|
||||||
Servers should instead prefer to use the v2 ``/send_join``
|
Servers should instead prefer to use the v2 ``/send_join`` endpoint.
|
||||||
endpoint.
|
|
||||||
|
|
||||||
Submits a signed join event to the resident server for it
|
Submits a signed join event to the resident server for it
|
||||||
to accept it into the room's graph. Note that events have
|
to accept it into the room's graph. Note that events have
|
||||||
|
|
|
@ -33,9 +33,9 @@ paths:
|
||||||
put:
|
put:
|
||||||
summary: Submit a signed join event to a resident server
|
summary: Submit a signed join event to a resident server
|
||||||
description: |-
|
description: |-
|
||||||
.. Note::
|
**Note:**
|
||||||
This API is nearly identical to the v1 API with the
|
This API is nearly identical to the v1 API with the
|
||||||
exception of the response format being fixed.
|
exception of the response format being fixed.
|
||||||
|
|
||||||
This endpoint is preferred over the v1 API as it provides
|
This endpoint is preferred over the v1 API as it provides
|
||||||
a more standarised response format. Senders which receive
|
a more standarised response format. Senders which receive
|
||||||
|
|
|
@ -143,9 +143,8 @@ paths:
|
||||||
put:
|
put:
|
||||||
summary: Submit a signed leave event to a resident server
|
summary: Submit a signed leave event to a resident server
|
||||||
description: |-
|
description: |-
|
||||||
.. Note::
|
**Note:**
|
||||||
Servers should instead prefer to use the v2 ``/send_leave``
|
Servers should instead prefer to use the v2 ``/send_leave`` endpoint.
|
||||||
endpoint.
|
|
||||||
|
|
||||||
Submits a signed leave event to the resident server for it
|
Submits a signed leave event to the resident server for it
|
||||||
to accept it into the room's graph. Note that events have
|
to accept it into the room's graph. Note that events have
|
||||||
|
|
|
@ -33,9 +33,9 @@ paths:
|
||||||
put:
|
put:
|
||||||
summary: Submit a signed leave event to a resident server
|
summary: Submit a signed leave event to a resident server
|
||||||
description: |-
|
description: |-
|
||||||
.. Note::
|
**Note:**
|
||||||
This API is nearly identical to the v1 API with the
|
This API is nearly identical to the v1 API with the
|
||||||
exception of the response format being fixed.
|
exception of the response format being fixed.
|
||||||
|
|
||||||
This endpoint is preferred over the v1 API as it provides
|
This endpoint is preferred over the v1 API as it provides
|
||||||
a more standarised response format. Senders which receive
|
a more standarised response format. Senders which receive
|
||||||
|
|
|
@ -31,16 +31,16 @@ description: |-
|
||||||
``m.room.power_levels`` event, or if the room contains no ``m.room.power_levels``
|
``m.room.power_levels`` event, or if the room contains no ``m.room.power_levels``
|
||||||
event.
|
event.
|
||||||
|
|
||||||
.. NOTE::
|
**Note:**
|
||||||
|
|
||||||
As noted above, in the absence of an ``m.room.power_levels`` event, the
|
As noted above, in the absence of an ``m.room.power_levels`` event, the
|
||||||
``state_default`` is 0, and all users are considered to have power level 0.
|
``state_default`` is 0, and all users are considered to have power level 0.
|
||||||
That means that **any** member of the room can send an
|
That means that **any** member of the room can send an
|
||||||
``m.room.power_levels`` event, changing the permissions in the room.
|
``m.room.power_levels`` event, changing the permissions in the room.
|
||||||
|
|
||||||
Server implementations should therefore ensure that each room has an
|
Server implementations should therefore ensure that each room has an
|
||||||
``m.room.power_levels`` event as soon as it is created. See also the
|
``m.room.power_levels`` event as soon as it is created. See also the
|
||||||
documentation of the ``/createRoom`` API.
|
documentation of the ``/createRoom`` API.
|
||||||
|
|
||||||
properties:
|
properties:
|
||||||
content:
|
content:
|
||||||
|
|
|
@ -22,26 +22,26 @@ description: |-
|
||||||
#. If the server name matches an entry in the ``allow`` list, allow.
|
#. If the server name matches an entry in the ``allow`` list, allow.
|
||||||
#. Otherwise, deny.
|
#. Otherwise, deny.
|
||||||
|
|
||||||
.. Note::
|
**Note:**
|
||||||
Server ACLs do not restrict the events relative to the room DAG via authorisation
|
Server ACLs do not restrict the events relative to the room DAG via authorisation
|
||||||
rules, but instead act purely at the network layer to determine which servers are
|
rules, but instead act purely at the network layer to determine which servers are
|
||||||
allowed to connect and interact with a given room.
|
allowed to connect and interact with a given room.
|
||||||
|
|
||||||
.. WARNING::
|
**Warning:**
|
||||||
Failing to provide an ``allow`` rule of some kind will prevent **all**
|
Failing to provide an ``allow`` rule of some kind will prevent **all**
|
||||||
servers from participating in the room, including the sender. This renders
|
servers from participating in the room, including the sender. This renders
|
||||||
the room unusable. A common allow rule is ``[ "*" ]`` which would still
|
the room unusable. A common allow rule is ``[ "*" ]`` which would still
|
||||||
permit the use of the ``deny`` list without losing the room.
|
permit the use of the ``deny`` list without losing the room.
|
||||||
|
|
||||||
.. WARNING::
|
**Warning:**
|
||||||
All compliant servers must implement server ACLs. However, legacy or noncompliant
|
All compliant servers must implement server ACLs. However, legacy or noncompliant
|
||||||
servers exist which do not uphold ACLs, and these MUST be manually appended to
|
servers exist which do not uphold ACLs, and these MUST be manually appended to
|
||||||
the denied hosts list when setting an ACL to prevent them from leaking events from
|
the denied hosts list when setting an ACL to prevent them from leaking events from
|
||||||
banned servers into a room. Currently, the only way to determine noncompliant hosts is
|
banned servers into a room. Currently, the only way to determine noncompliant hosts is
|
||||||
to check the ``prev_events`` of leaked events, therefore detecting servers which
|
to check the ``prev_events`` of leaked events, therefore detecting servers which
|
||||||
are not upholding the ACLs. Server versions can also be used to try to detect hosts that
|
are not upholding the ACLs. Server versions can also be used to try to detect hosts that
|
||||||
will not uphold the ACLs, although this is not comprehensive. Server ACLs were added
|
will not uphold the ACLs, although this is not comprehensive. Server ACLs were added
|
||||||
in Synapse v0.32.0, although other server implementations and versions exist in the world.
|
in Synapse v0.32.0, although other server implementations and versions exist in the world.
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: core-event-schema/state_event.yaml
|
- $ref: core-event-schema/state_event.yaml
|
||||||
type: object
|
type: object
|
||||||
|
@ -55,7 +55,7 @@ properties:
|
||||||
deny. Defaults to true if missing or otherwise not a boolean.
|
deny. Defaults to true if missing or otherwise not a boolean.
|
||||||
|
|
||||||
This is strongly recommended to be set to ``false`` as servers running
|
This is strongly recommended to be set to ``false`` as servers running
|
||||||
with IP literal names are strongly discouraged in order to require
|
with IP literal names are strongly discouraged in order to require
|
||||||
legitimate homeservers to be backed by a valid registered domain name.
|
legitimate homeservers to be backed by a valid registered domain name.
|
||||||
allow:
|
allow:
|
||||||
type: array
|
type: array
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue