Merge pull request #2086 from matrix-org/travis/1.0/fed-content-type
Clarify that the default s2s transport is JSON over HTTP
This commit is contained in:
commit
00588efd3f
3 changed files with 14 additions and 1 deletions
|
@ -0,0 +1 @@
|
||||||
|
Clarify that the default transport is JSON over HTTP.
|
|
@ -57,6 +57,8 @@ The following other versions are also available, in reverse chronological order:
|
||||||
API Standards
|
API Standards
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
|
.. TODO: Move a lot of this to a common area for all specs.
|
||||||
|
|
||||||
.. TODO
|
.. TODO
|
||||||
Need to specify any HMAC or access_token lifetime/ratcheting tricks
|
Need to specify any HMAC or access_token lifetime/ratcheting tricks
|
||||||
We need to specify capability negotiation for extensible transports
|
We need to specify capability negotiation for extensible transports
|
||||||
|
@ -82,7 +84,6 @@ names in JSON objects passed over the API also follow this convention.
|
||||||
``/createRoom``. A future version of this specification will address the
|
``/createRoom``. A future version of this specification will address the
|
||||||
inconsistency.
|
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:
|
||||||
|
|
||||||
|
|
|
@ -83,6 +83,17 @@ The following other versions are also available, in reverse chronological order:
|
||||||
- `r0.1.1 <https://matrix.org/docs/spec/server_server/r0.1.1.html>`_
|
- `r0.1.1 <https://matrix.org/docs/spec/server_server/r0.1.1.html>`_
|
||||||
- `r0.1.0 <https://matrix.org/docs/spec/server_server/r0.1.0.html>`_
|
- `r0.1.0 <https://matrix.org/docs/spec/server_server/r0.1.0.html>`_
|
||||||
|
|
||||||
|
|
||||||
|
API standards
|
||||||
|
-------------
|
||||||
|
|
||||||
|
The mandatory baseline for client-server communication in Matrix is exchanging
|
||||||
|
JSON objects over HTTP APIs. More efficient optional transports will in future
|
||||||
|
be supported as optional extensions - e.g. a packed binary encoding over
|
||||||
|
stream-cipher encrypted TCP socket for low-bandwidth/low-roundtrip mobile usage.
|
||||||
|
For the default HTTP transport, all API calls use a Content-Type of
|
||||||
|
``application/json``. In addition, all strings MUST be encoded as UTF-8.
|
||||||
|
|
||||||
Server discovery
|
Server discovery
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue