wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #1536 from turt2live/travis/as/user-namespace

Browse source 
Recommend that application services use an underscore for namespacing
This commit is contained in:
Travis Ralston 2018-08-20 10:16:20 -06:00 • committed by GitHub
commit 9ec914956f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
specification/application_service_api.rst
View file

@ -83,7 +83,7 @@ regular expressions and look like:
users: users:
- exclusive: true - exclusive: true
regex: @irc.freenode.net_.* regex: @_irc.freenode.net_.*
The registration is represented by a series of key-value pairs, which this The registration is represented by a series of key-value pairs, which this
@ -105,12 +105,17 @@ traffic to the AS is:
aliases: [] # Namespaces of room aliases which should be delegated to the AS aliases: [] # Namespaces of room aliases which should be delegated to the AS
rooms: [] # Namespaces of room ids which should be delegated to the AS rooms: [] # Namespaces of room ids which should be delegated to the AS
Exclusive user and alias namespaces should begin with an underscore after the
sigil to avoid collisions with other users on the homeserver. Application
services should additionally attempt to identify the service they represent
in the reserved namespace. For example, ``@_irc_.*`` would be a good namespace
to register for an application service which deals with IRC.
.. WARNING:: .. WARNING::
If the homeserver in question has multiple application services, each If the homeserver in question has multiple application services, each
``as_token`` and ``id`` MUST be unique per application service as these are ``as_token`` and ``id`` MUST be unique per application service as these are
used to identify the application service. The homeserver MUST enforce this. used to identify the application service. The homeserver MUST enforce this.
Homeserver -> Application Service API Homeserver -> Application Service API
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~