Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-31 21:18:38 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
2961 commits 31 branches 42 tags 32 MiB
Commit graph

835 commits

Author SHA1 Message Date
Travis Ralston 5027a9a59a Improve documentation around EDUs and PDUs 
Clarify fields, improve examples, and make the tables in the spec be generated rather than duplicated.
 2018-07-31 13:58:23 -06:00
Travis Ralston 7679b4f1d1 Improve documentation on how Transactions work 
The response is based upon various sections of the Synapse code in how it generates a response.

There are no new fields added to the transaction. Originally, `previous_ids` and `pdu_failures` were to be documented however neither of these are used in the real world.
 2018-07-30 16:58:13 -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 9fdd8a6f96 Document how leaving rooms/rejecting invites over federation works 
Fixes https://github.com/matrix-org/matrix-doc/issues/1401

This is very similar to the joining rooms handshake, and much of it is a near copy/paste of the make_join and send_join API. The major difference is the send_leave API doesn't return anything.

References:
* Handling of make_leave: d69decd5c7/synapse/handlers/federation.py (L1285-L1310)
* send_leave route: d69decd5c7/synapse/federation/transport/client.py (L267)
* make_leave route: d69decd5c7/synapse/federation/transport/server.py (L396)
* send_leave returning nothing: d69decd5c7/synapse/handlers/federation.py (L1346)
 2018-07-26 14:59:43 -06:00
Travis Ralston f873bae0cc Improve documentation for how non-third party invites work 
The details are fairly straightforward. An `event` has been added to the response body because that's what Synapse returns, despite the spec saying otherwise until now: d69decd5c7/synapse/federation/federation_server.py (L339)
 2018-07-26 08:44:10 -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
Will Hunt bdb881420c
Merge branch 'master' into hs/dns-to-be-hostname 2018-07-24 23:12:12 +01: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
Will Hunt 26505533dd drop dns_name = host in favour of host 2018-07-24 16:06:59 +01: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
Will Hunt 92f3989f2b Dirty replace of DNS name -> hostname 2018-07-05 11:37:06 +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
Ben Parsons ee98082a60 update MSC1270 2018-06-04 12:12:48 +01:00
Travis Ralston 8610effad7
Merge branch 'master' into travis/reporting 2018-05-31 10:57:33 -06:00
Ben Parsons 7a44351a34 update following rvdh spec blitz 2018-05-31 16:13:31 +01:00
Ben Parsons 34090b24c4 prepare proposals.py for CI 2018-05-29 14:19:03 +01:00
Travis Ralston 9037f506ac Document how to report content 
Fixes: https://github.com/matrix-org/matrix-doc/issues/739

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-05-27 12:19:30 -06:00
Ben Parsons c3062b7db6 Include Proposals Page Title, update MSC1256 2018-05-24 11:36:56 +01:00
Ben Parsons 434e2949f9 include #1256 2018-05-23 17:00:26 +01:00
Ben Parsons 8d550d2166 force re-render 2018-05-23 09:39:18 +01:00
Ben Parsons 0b776b0e9c link to proposals page from index 2018-05-21 11:01:03 +01:00
Jason Volk 2a6895e759 Fix typo. 2018-05-18 17:06:22 -07:00
Ben Parsons 663e1a5ebe Update some text 2018-05-18 10:17:54 +01:00
Ben Parsons 9873a2a0ac link from the spec intro page 2018-05-17 18:33:12 +01:00
Ben Parsons 38adc7df06 latest generated proposals 2018-05-17 18:25:13 +01:00
Matthew Hodgson 8440179ecf clarify shepherds and clarify 'greater benefit' 
as per https://github.com/matrix-org/matrix-doc/pull/1240#discussion_r188459957
 2018-05-17 18:21:39 +01:00
Ben Parsons 4d3c4225b2 include proposal template link 2018-05-16 11:12:57 +01:00
Matthew Hodgson 84524df783 spell out requirements for doc editing 2018-05-15 17:38:33 +01:00
Ben Parsons 73b28612ec updates from feedback on pull 2018-05-15 16:07:55 +01:00
Matthew Hodgson 4c0743ef65 fix wording 2018-05-15 15:47:34 +01:00
Matthew Hodgson 10a8cb3f67 put handwavey timings on state transitions 2018-05-15 15:44:47 +01:00
Matthew Hodgson 4cdb4f105c clarify architecture 2018-05-15 15:11:51 +01:00
Matthew Hodgson 8096bf0039 perms and apostrophes 2018-05-15 15:07:47 +01:00
Matthew Hodgson 3e10a5a24a enter #matrix-spec:matrix.org 2018-05-15 15:02:35 +01:00
Matthew Hodgson 42fd3f34e4 shift stuff from contributing.rst to the new proposals page 2018-05-15 14:46:08 +01:00
Matthew Hodgson 3b736388ce clarify governance 2018-05-15 14:17:38 +01:00
Ben Parsons 3cef79f31d sublist formatting 2018-05-15 12:09:35 +01:00
Matthew Hodgson e27f674fb9 incept dates 2018-05-14 23:00:54 +01:00
Matthew Hodgson 29348c6190 improve wording 2018-05-14 22:35:53 +01:00
Matthew Hodgson 714767c95a explain proposal neutrality 2018-05-14 22:32:00 +01:00
Matthew Hodgson 755c9473fb more tweaks 2018-05-14 22:27:43 +01:00
Matthew Hodgson 07bf61b33b more tweaks 2018-05-14 22:22:09 +01:00
Matthew Hodgson 93681458d6 more tweaks 2018-05-14 22:13:28 +01:00
Matthew Hodgson cb882ba12d more tweaks 2018-05-14 22:07:49 +01:00
Matthew Hodgson 8c469e51cb lots of tweaks to the MSC verbiage 2018-05-14 22:05:28 +01:00
Ben Parsons b8f38b21a7 update introductory text 2018-05-14 14:25:12 +01:00
Ben Parsons 120fa92078 update intro 2018-05-14 10:25:10 +01:00
Ben Parsons 867307af8b new flow 2018-05-14 09:57:43 +01:00
Ben Parsons 866b0b6348 I mostly play with ascii art 2018-05-10 16:02:55 +01:00
Ben Parsons 9e37d15c8f little ascii diagram of process 2018-05-08 15:11:15 +01:00
Ben Parsons e18aa30fd2 start generating new proposals page 2018-05-02 13:47:01 +01:00
Jason Volk 2802fdea7e Fix typo. 2018-04-24 19:29:00 -07:00
Richard Lewis 8d05f80cec Sticker messages (m.sticker) (#1158) 2018-03-27 10:00:41 +01:00
Andrew Morgan cd26c170de Specify token used in /login is not an Access Token (#1155) 
* Specify token used in /login is not an Access Token

While working through the implementation of /login in Dendrite, it was
confusing what the contents of the token attribute in the login request
body referred to. Initially, I thought it was an access token, which led
to further confusion. This commit explicitly states that the token is a
login token, which is separate from an access token, hopefully reducing
confusion for future readers.

Signed-off-by: Andrew Morgan (https://amorgan.xyz) <andrew@amorgan.xyz>
 2018-03-23 10:00:49 +00:00
Vyom Sharma 4f5ad35865 fixed minor typo 2018-03-14 20:57:38 +05:30
Travis Ralston 331e49bd0d Improve the documentation of ignored users 
* Fix the event schema to represent the real world
* Add the module to the spec targets
* Remove incomplete thought from the client behaviour
* Link to the account data API
* Minor word choice changes

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-06 09:00:32 -07:00
Travis Ralston d37ed0876f
Merge branch 'master' into travis/m.ignored_user_list 2018-03-05 14:52:37 -07:00
Richard van der Hoff a0dda3cae2
Merge branch 'master' into travis/m.tag 2018-03-05 18:58:53 +00:00
Travis Ralston e862ef60ae Spec ignoring users 
Adds https://github.com/matrix-org/matrix-doc/issues/528

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-03 15:39:10 -07:00