Commit graph

782 commits

Author SHA1 Message Date
Travis Ralston 53d4003d3a manual merge of master into travis/s2s/query 2018-08-02 16:48:32 -06:00
Travis Ralston 48972addbf
Merge pull request #1428 from turt2live/travis/s2s/joining-rooms
Improve the documentation for joining rooms
2018-08-02 16:44:31 -06:00
Travis Ralston a9258ed195 an -> a 2018-08-02 16:43:29 -06:00
Travis Ralston b96ee3e393
Merge pull request #1423 from turt2live/travis/s2s/keys
Improve the server key exchange portion of the s2s specification
2018-08-01 07:44:57 -06:00
David Baker 2dc51d416d Ignore stuff in m. you don't understand 2018-07-27 12:27:30 +01:00
David Baker f90ed4b77d Make non-namespaced tags verboten 2018-07-27 12:08:04 +01:00
David Baker e4fd088fcc Fix room tags spec 2018-07-27 12:05:30 +01:00
Travis Ralston 8f1a4ae0ea Formatting 2018-07-26 16:43:51 -06:00
Travis Ralston c2f1c6e78d Improve the joining rooms handshake documentation
There isn't a whole lot to this section that needed work. The section overall lost the table schema in favour of having the endpoints close by.

The directory query is improved in https://github.com/matrix-org/matrix-doc/pull/1443
2018-07-26 08:43:08 -06:00
Travis Ralston 8e97b0ca81 Improve the server key exchange portion of the s2s specification
Most of the text has been shuffled into the swagger definitions to bring it closer to where it matters.

This also attempts to clarify what is out in the wild. Most importantly, the first version of the key exchange is outright removed from the specification. Other research points/questions are:

* What is a "Key ID"?
  * 1241156c82/synapse/rest/key/v2/local_key_resource.py (L81-L83)
  * 1241156c82/synapse/rest/key/v2/local_key_resource.py (L88-L91)
* Returning a cached response if the server throws a 400, 500, or otherwise not-offline status code
  * 1241156c82/synapse/rest/key/v2/remote_key_resource.py (L227-L229)
* `minimum_valid_until_ts` default
  * This branch of the ladder: 1241156c82/synapse/rest/key/v2/remote_key_resource.py (L192)
* Returning empty arrays when querying offline/no servers
  * Queried by hand against matrix.org as a notary server with a fake domain name to query
* Returning all keys even when querying for specific keys
  * Queried by hand using matrix.org as a notary server against a server publishing multiple keys.

The examples and descriptions were also improved as part of this commit.
2018-07-26 08:41:00 -06:00
Travis Ralston 0ddf578b61 Combine all queries into their own section
This removes the Directory and Profile sections, instead opting to document them as Queries. 

The behaviour of profile queries is based on Synapse's behaviour. A few issues have been opened to improve the behaviour:
* https://github.com/matrix-org/matrix-doc/issues/1434
* https://github.com/matrix-org/matrix-doc/issues/1435
* https://github.com/matrix-org/matrix-doc/issues/1436
* https://github.com/matrix-org/matrix-doc/issues/1437

This fixes https://github.com/matrix-org/matrix-doc/issues/1404
2018-07-26 08:40:39 -06:00
Travis Ralston 004998b98f Convert invites to swagger
The whole section reads like a description for the endpoint, and has been replaced by the swagger definition now (rather than at a later stage). All the same information should be kept.
2018-07-24 10:58:15 -06:00
Travis Ralston f09c4fd286 Convert joins to swagger 2018-07-24 10:58:15 -06:00
Travis Ralston 24e531a896
Merge pull request #1406 from turt2live/travis/s2s/transactions-swagger
Convert things that mention "Transaction" to swagger
2018-07-24 10:38:55 -06:00
Michael Telatynski 2790c1f069
Merge pull request #1289 from matrix-org/t3chguy/group_id
basic spec for group IDs, mostly copied from User IDs as they share grammar
2018-07-24 16:20:18 +01:00
Travis Ralston cb4fcd1d09 Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger 2018-07-24 09:15:36 -06:00
Ben Parsons 01d01cfbbb
Merge pull request #1440 from matrix-org/benp/clarifyintro
Improve discoverability of /docs/spec/intro/ document by including content in /docs/spec/
2018-07-24 11:43:43 +01:00
Ben Parsons 07aeaadef9 update links which used to point to docs/spec/intro 2018-07-24 11:41:03 +01:00
Travis Ralston 2aafde4549
Merge pull request #1419 from turt2live/travis/s2s/3pinvites-swagger
Convert third party invite exchange to swagger
2018-07-23 10:33:00 -06:00
Ben Parsons e7c79f2bd4 avoid .rst link conflict warnings 2018-07-20 15:30:58 +01:00
Ben Parsons 54d6d58fff naively move content from intro.rst to index.rst 2018-07-20 14:15:47 +01:00
Travis Ralston e226b60c7f Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger 2018-07-18 10:59:39 -06:00
Travis Ralston 7cb918407d Merge remote-tracking branch 'matrix-org/master' into travis/s2s/keys-swagger 2018-07-18 10:32:46 -06:00
Travis Ralston cf93c88337 Convert third party invite exchange to swagger 2018-07-13 15:44:33 -06:00
Travis Ralston 51faf8ed2e Convert the general query API to swagger
Includes "moving" the directory query API into the same area. This will make more sense once the other query types are specified.
2018-07-12 13:46:42 -06:00
Travis Ralston 91c59e7384
Merge pull request #1353 from matrix-org/anoa/as_thirdparty_lookup
Thirdparty Entity Lookup API
2018-07-12 11:19:12 -06:00
Andrew Morgan 291a4dfc76 Third party lookup module. Fix wording 2018-07-12 16:59:30 +01:00
Andrew Morgan 114bcf1a2e Use $ref, clean up, fix errors, AS is now a C-S module. 2018-07-12 14:31:34 +01:00
Travis Ralston 374ec00046 Convert things that mention "Transaction" to swagger
There's two kinds of transactions currently: one with EDUs and one without. The one with EDUs is only used on /send, however the schema is still somewhat worth splitting out for simplicity.

The examples are brought apart to make them slightly more reusable for when they get dumped into the relevant sections of the spec (see TODO in server_server_api.rst)

Further, the Transactions stuff introduces tuples to the spec. The units.py has been updated to support this.
2018-07-11 16:52:27 -06:00
Travis Ralston 96889f16e9 Split out and fix the /server and /query key APIs 2018-07-11 13:20:44 -06:00
Travis Ralston bd2c0b7c98 Convert server keys to swagger 2018-07-11 13:09:19 -06:00
Travis Ralston 423d5593f5 Generify how OPTIONS and CORS are handled 2018-07-09 15:40:03 -06:00
Travis Ralston dd9414472b Merge remote-tracking branch 'matrix-org/master' into travis/cors 2018-07-06 08:51:32 -06:00
Andrew Morgan 8e22e9e85a Fix title underline length 2018-07-05 12:00:20 +01:00
Andrew Morgan cc3724b54a fix indentation, error messages. add rest of PR 2018-07-05 11:55:25 +01:00
Travis Ralston 0779d81e52 Clarify which requests should have CORS headers
Spoilers: all of them.
2018-07-04 14:30:39 -06:00
Travis Ralston 2fc2926461 Clearly say that the server/server API is unstable and subject to change 2018-07-04 11:33:51 -06:00
Travis Ralston 4ca54404fa Document the CORS/preflight headers
Fixes https://github.com/matrix-org/matrix-doc/issues/1006
2018-07-03 16:15:55 -06:00
Andrew Morgan d73b247688 3PE lookup service 2018-07-03 14:40:28 +01:00
Travis Ralston d647169806
Add more strength to the suggestion to find existing issues
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-06-18 13:20:42 -06:00
Travis Ralston fc402c296b
Don't suggest reusing old issues for spec proposals
In practice this was confusing for people, so instead we should encourage people to create new issues and reference the existing ones.

Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-06-18 12:03:14 -06:00
user 54c3003b74 newly joined -> newly-joined 2018-06-17 16:35:23 +01:00
user 5ab5fe08d1 Small grammatical and stylistic fixes 2018-06-17 15:49:39 +01:00
Andrew Morgan 2e5cdaf51c
Fix typo
"To stream events all the events" -> "To stream all the events"
2018-06-11 14:25:05 +01:00
Michael Telatynski c3f66e1814
basic spec for group IDs, mostly copied from User IDs as they share grammar 2018-06-11 12:40:04 +01:00
Michael Kaye 72282577bf Add back proposals.rst with a link to the actual location 2018-06-07 16:35:11 +01:00
Ben Parsons 18ba0d6d81 remove propsals.rst as it will be regenerated 2018-06-07 15:32:18 +01:00
Ben Parsons a552c1853e update for MSC 701 2018-06-07 14:07:02 +01:00
Richard van der Hoff cefd1a832e
server_server_api: fix typo in auth section
fixes "destintation" typo
2018-06-05 17:55:21 +01:00
Ben Parsons ffb8037af2 update MSC list 2018-06-05 16:43:42 +01:00