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

Document convention of using underscores in APIs

Browse source 
Everybody has agreed to it. Now we just have to remember to do it.
This commit is contained in:
Richard van der Hoff 2016-10-12 10:29:53 +01:00
parent fcf47386e9
commit 8523af1385
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
specification/client_server_api.rst
View file

@ -72,6 +72,15 @@ MUST be encoded as UTF-8. Clients are authenticated using opaque
``access_token`` strings (see `Client Authentication`_ for details), passed as a ``access_token`` strings (see `Client Authentication`_ for details), passed as a
query string parameter on all requests. query string parameter on all requests.
The names of the API endponts for the HTTP transport follow a convention of
using underscores to separate words (for example ``/delete_devices``).
.. NOTE::
There are a few historical exceptions to this rule, such as
``/createRoom``. A future version of this specification will address the
inconsistency.
Any errors which occur at the Matrix API level MUST return a "standard error Any errors which occur at the Matrix API level MUST return a "standard error
response". This is a JSON object which looks like: response". This is a JSON object which looks like: