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

1502 commits

Author SHA1 Message Date
Travis Ralston 6b67d501e4
Merge branch 'master' into travis/s2s/query 2018-08-03 08:55:21 -06:00
Travis Ralston 3a9fb11c9b
Merge branch 'master' into travis/s2s/backfill 2018-08-03 08:54:40 -06:00
Travis Ralston 1578da453b
Merge branch 'master' into travis/s2s/get-event 2018-08-03 08:01:43 -06:00
Travis Ralston 86d7f42173
Merge pull request #1455 from turt2live/travis/s2s/leaving-rooms 
Document how leaving rooms/rejecting invites over federation works
 2018-08-03 08:00:56 -06:00
Travis Ralston d48f1e1713
Merge pull request #1461 from turt2live/travis/s2s/transactions 
Improve documentation on how Transactions work
 2018-08-03 07:38:45 -06:00
Travis Ralston cda88f3b3d Document /get_missing_events 
Fixes https://github.com/matrix-org/matrix-doc/issues/1385
 2018-08-02 23:18:08 -06:00
Travis Ralston 05bb7e1050 Spelling and word choice 2018-08-02 18:45:59 -06:00
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 9d474bb819 Document event retrieval endpoints in more detail 
This also adds a previously-undocumented endpoint: /state_ids

Backfill is technically not part of this section, however it is being left untouched to make the merge with #1469 easier (which moves it out of the file).

Reference material:
* Some calls to synapse on these endpoints with a relatively simple private room.
 2018-08-02 12:44:54 -06:00
Travis Ralston 5aef545128 Improve documentation for backfilling rooms 
There's not a whole lot to improve here - most of the changes are about reorganization and minor clarifications.
 2018-08-01 13:31:23 -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
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
Hubert Chathi ce1e2c0904 incorporate feedback from reviewers 2018-07-04 17:58:37 -04: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
Hubert Chathi 0dd330962d initial draft of .well-known discovery 2018-07-03 14:14:26 -04: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
user d6fb5afd16 Clarified group_id group visibility, url possibilities, regex starters 
Changed Application Service capatalization to be consistent with the
rest of the document.
 2018-05-28 23:38:53 +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
Andrew Morgan 9ca62edda0 Document new application service registration file options. 2018-05-25 19:39:54 +01: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
Travis Ralston a3f006353c Tag ordering is defined as a number between 0 and 1, not strings 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-03 12:40:48 -07:00
Maxime Dor c8393306d1 Add IS ping endpoint 2018-02-27 17:54:42 +01:00
Richard van der Hoff 3dfa643b8b Fix membership state names 
It's called 'join', not 'joined'.
 2018-02-20 20:25:31 +00:00
Michael Telatynski 4d90d2b495
fix depr link 2018-02-07 08:26:27 +00:00
Nathan Musoke 7e94cd5a0b
Typo in client-server spec: ether -> either 2018-01-20 19:15:01 +13:00
Richard van der Hoff 73118b6b29
Merge pull request #1096 from t3chguy/user_directory 
add user_directory
 2017-12-29 15:57:59 +00:00
Michael Telatynski 784adade9b
changes based on Pull Request feedback 2017-12-21 17:45:26 +00:00
Richard van der Hoff 15ca952cc3 remove spurious word 2017-12-20 10:10:02 +00:00
Richard van der Hoff 1fb7647021 send_join: clarify auth_chain description 
The auth_chain field should contain all of the auth events required to auth the
state events, as well as those required to auth the join event itself.

(cf https://github.com/matrix-org/synapse/blob/e148438/synapse/handlers/federation.py#L1076-L1077).
 2017-12-18 17:58:35 +00:00
Michael Telatynski 3d8fe6e090
merge profiles with user directory into user data, also fix typo 2017-12-18 17:01:52 +00:00
Michael Telatynski 605510e965
Merge branch 'master' into user_directory 2017-12-18 16:56:04 +00:00
Richard van der Hoff a36f8ba00d Forbid colons in MXIDs 
There is a single (AS) user on matrix.org who has a colon in their localpart,
but I suspect that is an artifact of old bridge code and won't work over
federation anyway.

Colons in MXIDs are particularly harmful because they make it impossible to
split mxids into local- and remote-parts
 2017-12-18 14:16:25 +00:00
Michael Telatynski 97445195f6
add user_directory 2017-12-17 23:42:44 +00:00
Richard van der Hoff 08d137a588 We sign the request body, not the JSON 
when signing federation requests, we put the actual request body into the
canonicaljson to be signed, not the JSON representation of it.
 2017-12-10 23:09:12 +00:00
Richard van der Hoff 56f878842c Add a warning that state resolution has problems 2017-12-10 23:05:55 +00:00
Richard van der Hoff 5ab9ee6b88 Link to auth rules 2017-11-22 22:42:55 +00:00
Richard van der Hoff 0960229a80 Document the state resolution algorithm 
or at least, my understanding of it.
 2017-11-22 22:35:47 +00:00
Maxime Dor e8af5622a7 Use proper room event type for redaction 2017-11-21 20:29:18 +01:00
Richard van der Hoff ec1a12d21b
Merge pull request #1080 from maxidor/max/ss/auth_rules 
Fix auth rules to allow first PL event
 2017-11-20 12:57:57 +00:00
Richard van der Hoff 96d93e11d7
Tweak wording of auth rules slightly 2017-11-20 12:57:34 +00:00
Florian Jacob a0455eb5b1 Threat Model: Wrong word: Banning users is a threat only if you're not authorized 
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
 2017-11-20 13:44:10 +01:00
Florian Jacob 306b3f5d62 Threat Model: Align indentation of Spying Threats. 
“Disclosure to Servers Within Chatroom” was indented lesser
than the surrounding threats.

Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
 2017-11-20 13:36:05 +01:00
Maxime Dor c4f53f58d7 Fix auth rules to allow first PL event 2017-11-18 21:25:18 +01:00
Richard van der Hoff 52dba5d89a
Merge pull request #1076 from florianjacob/fix-cas-url 
Correct CAS spec link
 2017-11-16 22:38:07 +00:00
Richard van der Hoff 58a3fa3d60
Merge pull request #1075 from matrix-org/rav/pdu_fields 
Improve documentation of Transactions and PDUs
 2017-11-16 15:42:36 +00:00
Florian Jacob ac861d9b97 Correct CAS spec link 
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
 2017-11-16 13:44:50 +01:00
Richard van der Hoff 6a653b742c Document auth_events 2017-11-15 23:44:46 +00:00
Richard van der Hoff 632ba032af Improve Transaction and PDU documentation 
Fix a bunch of lies about the fields in these structures.
 2017-11-15 23:44:41 +00:00
Marcus Medom Ryding 8a446fa6df Modify event auth rules not to rely on depth 
Signed-off-by: Marcus Medom Ryding <mrok4a@gmail.com>
 2017-11-15 19:24:46 +01:00
Richard van der Hoff f88185ed89
Merge pull request #1073 from maxidor/max/ss/directory 
Document directory query endpoint
 2017-11-15 17:55:13 +00:00
Richard van der Hoff e9c1b87a1d Remove git log reference 
We keep the changelog up to date anyway, so there's not much point in trying to
get people to use `git log`
 2017-11-15 16:34:18 +00:00
Richard van der Hoff 0ce58fdb28 Prepare for next spec dev cycle 2017-11-15 16:23:14 +00:00
Maxime Dor bb50ec2e88 Document directory query endpoint 2017-11-15 13:40:55 +01:00
Richard van der Hoff 9b0bdb799e
Merge pull request #1054 from vberger/patch-2 
Specify namespaces for tags
 2017-11-15 07:07:45 +00:00
Maxime Dor 1045bc721d Document federation version endpoint 2017-11-15 04:16:30 +01:00
David Baker 14df31458b Attempt to clarify example a little 2017-11-14 15:39:25 +00:00
David Baker 9c5972ffe3 More formatting / grammar 2017-11-14 15:31:02 +00:00
David Baker e12c0b54ff Formatting & grammar 2017-11-14 15:12:30 +00:00
David Baker 4526ff2ea6 Double backticks in rst :/ 2017-11-14 15:11:30 +00:00
David Baker 1e4cba6b55 Don't linkify email addresses in examples 2017-11-14 15:10:11 +00:00
David Baker 3487f5d75a Spell out what we mean by a 3pid 
(and consequently rejig all the fixed-width formatting)
 2017-11-14 15:08:56 +00:00
David Baker ff85ec055e Move 3pid types down 2017-11-14 15:07:22 +00:00
David Baker 8d557ec9dc Actually this isn't necessary in this section 2017-11-14 15:05:58 +00:00
David Baker e80675c9e9 Link in markdown, not swagger 2017-11-14 15:03:51 +00:00
David Baker b789f61522 Make link more specific 2017-11-14 14:58:30 +00:00
David Baker 6edb90a08e Document threepids 
Adds the /msisdn' 3pid type and generally fleshes out what a 3pid
is and how they work.

This merges most of the work from Max Dor in https://github.com/matrix-org/matrix-doc/pull/1039
with some tweaks and additions.
 2017-11-14 14:36:38 +00:00
Travis Ralston b1801ea6db Spec /account/whoami 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-11-12 23:49:40 -07:00
Maxime Dor 68e12feec7 Add explicit examples for JSON encoding 2017-11-05 01:14:44 +01:00
Victor Berger cc8128edad
Specify namespaces for tags 
This is a proposition for closing #931.

This should be a fairly uncontroversial addition (apart from bike-shedding), which only defines behavior for clients that want use tags or expose tagging functionality to their users.

The idea of adding this to the spec is to ensure clients can peacefully share the tag namespace without conflicting with each other, using rules similar to namespaces for state keys.
 2017-11-03 17:03:37 +01:00
Michael Telatynski c2b1b7a10e
mention that we can send tokens via headers 2017-10-27 09:52:53 +01:00
Richard van der Hoff 6b23b7fc0b Merge branch 'client_server/r0.2.0_updates' 2017-10-24 23:26:56 +01:00
Richard van der Hoff b94c4a9f36 Sneaky update to 0.2.0 spec to link unstable 
This doesn't count as a spec release, right??
 2017-10-24 23:21:33 +01:00
Richard van der Hoff 6282a53ca9 Merge pull request #1032 from matrix-org/rav/mxid_grammar 
Indentifier grammar updates
 2017-10-23 10:57:47 +01:00
Richard van der Hoff 44fc033624 Fix broken links in the intro 2017-10-23 01:00:43 +01:00
Richard van der Hoff c08e6616c7 Try to make the intro link more obvious 
Fixes https://github.com/matrix-org/matrix-doc/issues/1031.
 2017-10-23 00:51:41 +01:00
Richard van der Hoff 628e723483 Move the MXID spec to the appendices 
Also link to them from the /register API doc.
 2017-10-23 00:51:40 +01:00
Richard van der Hoff 0a85fbb4f5 Allow slashes in MXIDs 
Because apparently we like slashes now.
 2017-10-23 00:22:25 +01:00
Richard van der Hoff 5fee8e54eb Document the event auth rules (#1027) 
These are a necessary precursor to state resolution.
 2017-10-20 13:36:56 +01:00
Richard van der Hoff c4bcd0a713 Merge pull request #1007 from turt2live/travis/m.room.pinned_events 
Add spec for m.room.pinned_events
 2017-10-17 17:33:27 +01:00
Travis Ralston 5e7df0e87c Update instant_messaging.rst 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-10-17 09:08:50 -06:00
Richard van der Hoff f1139b5b13 fix inter-spec link 2017-10-15 23:42:05 +01:00
Richard van der Hoff 5d473ced58 Merge pull request #1023 from matrix-org/rav/event_size 
Specify max event size more precisely
 2017-10-15 23:35:51 +01:00
Richard van der Hoff a8afbfd27d Avoid external link in search swagger 2017-10-15 23:01:54 +01:00
Richard van der Hoff bf4936d6d7 Specify max event size more precisely 
This is somewhat inelegant, and will please nobody, but I think it's more
important that we specify the current state of the onion than worry about what
would have been nice, and introduce incompatibilities while we do so.
 2017-10-15 22:18:10 +01:00
Michael Telatynski bf3b49f13c document joined_members and joined_rooms endpoints (#999) 2017-10-10 16:16:27 +01:00
Richard van der Hoff cfb547b474 Fix perspectives project link 
The perspectives project seems to be dead :/. We can at least link to the
wayback machine.
 2017-09-27 15:31:55 +01:00
Brendan Abolivier 6b6a941e36
Phrasing 2017-09-15 16:58:34 +01:00
Brendan Abolivier 8de93147b1
Typo 2017-09-15 16:57:05 +01:00
Brendan Abolivier c71575c94d
Remove useless blank line 2017-09-14 19:53:11 +01:00
Brendan Abolivier 4a99691108
Move link to the bottom of the file 2017-09-14 19:48:43 +01:00
Brendan Abolivier 9d90fa2cae
Specify third-party invites 2017-09-14 19:44:49 +01:00
Brendan Abolivier af961321e9
Specify remote invite 2017-09-14 19:15:06 +01:00
Brendan Abolivier 997e76fcf7
Update JSON body for 3PID onbind requests 2017-09-13 19:27:36 +01:00
David Baker 883767a905 Merge pull request #984 from matrix-org/rav/sync_timeout 
Make clear that the /sync timeout is zero by default
 2017-08-31 17:56:20 +01:00
Richard van der Hoff 1e3f5683c8 Make clear that the /sync timeout is zero by default 2017-08-31 16:56:50 +01:00
14mRh4X0r 6570a5c6a3 Update link to WHATWG's Living Standard FAQ entry 2017-08-11 14:22:13 +00:00
Brendan Abolivier 750d980bc0 Room member (#950) 
* Fixed an incorrect membership on example
* Added precision on membership upon profile update
* Changed first example into a join
* Changed the state/{eventType}/{stateKey} example with an actual state key
 2017-07-14 15:30:56 +01:00
Richard van der Hoff da6938b818 Key management APIs (#894) 
Spec the e2e key-management APIs.
 2017-04-20 16:51:42 +01:00
Richard van der Hoff 0a6886e73c Fix broken link in spec 2017-04-19 16:10:31 +01:00
David Baker 6296d676c8 Remove unused ID server file 2017-03-30 13:14:57 +01:00
Richard van der Hoff da686ba4eb Specification of unpadded Base64 2017-03-01 08:50:07 +00:00
Richard van der Hoff a091d86707 Merge pull request #775 from superdump/superdump/fed-pdu-state-update-fix 
server-server api: Fix swapped pdu state update field descriptions
 2017-01-03 12:11:49 +00:00
Robert Swain db26877eee server-server api: Fix swapped pdu state update field descriptions 
Signed-off-by: Robert Swain <robert.swain@gmail.com>
 2017-01-02 23:09:56 +01:00
Robert Swain 5855bf4b16 server-server: PDUs are signed by the origin server's private key 
Not the public key.

Signed-off-by: Robert Swain <robert.swain@gmail.com>
 2017-01-02 22:46:02 +01:00
Richard van der Hoff 5537f7a832 Allow guest access to E2E endpoints 2016-11-30 16:12:17 +00:00
Richard van der Hoff 8a9629167a httpsify the speculator link 2016-11-27 17:28:56 +00:00
Richard van der Hoff 4abdcc6f05 Merge pull request #402 from matrix-org/rav/device_management 
Device management API
 2016-11-09 15:09:46 +00:00
Richard van der Hoff 461bfdb0d8 Merge branch 'master' into rav/device_management 2016-11-09 14:34:04 +00:00
Richard van der Hoff aecac4f931 Merge pull request #723 from matrix-org/markjh/thumbnail_url 
Move m.* thumbnail_url to be inside info to match m.video
 2016-11-07 19:04:14 +00:00
Mark Haines 7025793ca8 Say that thumbnails should be 'mxc://' 2016-11-07 16:17:25 +00:00
Richard van der Hoff 3ee75af06f Move 'Signing JSON' to appendices 
Canonical JSON and JSON signing in general are common to the C-S spec. Move
them to the appendices instead of the S-S spec.
 2016-10-31 12:36:47 +00:00
Richard van der Hoff a5e12814ef Split appendices up 
Split appendices into multiple files
 2016-10-31 12:01:37 +00:00
Richard van der Hoff e8915215a2 Merge pull request #405 from matrix-org/dbkr/push_examples_api_path 
Fix API path in pushrules examples
 2016-10-13 22:13:24 +01:00
Richard van der Hoff 22777970da Fix speculator link 
the link to the 'latest version' was broken
 2016-10-13 17:56:53 +01:00
David Baker 41f4661d1b Fix API path in pushrules examples 2016-10-13 15:14:29 +01:00
Richard van der Hoff af515012ea Device management API 2016-10-12 17:26:01 +01:00
Richard van der Hoff 9265b03008 Client device doc 
Document client devices, and the mods to the login and register apis to support
them.
 2016-10-12 17:26:01 +01:00
Richard van der Hoff cbc5774ade JSON key names also use underscores. 2016-10-12 11:37:41 +01:00
Richard van der Hoff 8523af1385 Document convention of using underscores in APIs 
Everybody has agreed to it. Now we just have to remember to do it.
 2016-10-12 10:29:53 +01:00
Richard van der Hoff 7ed7944ddc Merge pull request #399 from matrix-org/dbkr/identity_api_right_path 
Use the right path for the identity API
 2016-10-10 11:32:40 +01:00
David Baker 49ee00c361 Use the right path for the identity API 2016-10-07 18:17:45 +01:00
Richard van der Hoff 6c88d698ae uia fallback example: check event origin 2016-10-07 16:26:28 +01:00
Richard van der Hoff e850fd718d window.postmessage for Interactive Auth fallback 
Require that User-Interactive auth fallback pages call
`window.postMessage` to notify apps of completion.
 2016-10-06 19:54:49 +01:00
Richard van der Hoff 42616f839c Merge pull request #396 from matrix-org/dbkr/notifs_api 
Spec notifs API
 2016-10-06 17:21:47 +01:00
Richard van der Hoff 909aef2b18 Merge pull request #389 from matrix-org/erikj/create_room_is_direct 
Spec /createRoom is_direct flag, is_direct in member event and m.direct
 2016-10-06 17:19:48 +01:00
Richard van der Hoff 83b89aa1ce dm: clarify client behaviour 2016-10-06 17:17:35 +01:00
David Baker ed2d364440 consistency 2016-10-06 11:17:43 +01:00
David Baker 96b6fb0129 'In the m.room.member' event 2016-10-06 11:16:56 +01:00
David Baker 301595c071 Linkify account_data API 
Also change other links because it turns out the .. isn't part
of the syntax
 2016-10-06 11:15:44 +01:00
David Baker 2a987c3369 Linkify endpoints properly 2016-10-05 18:19:17 +01:00
David Baker 2259a00ba2 links 2016-10-05 13:29:43 +01:00
David Baker 3f66ba713c Reference m.room.member section 2016-10-05 13:25:42 +01:00
David Baker e2024e5829 Add note on how to use the account data event 2016-10-05 13:22:30 +01:00
David Baker d791f35007 Remove unnecessary paragraph 2016-10-05 13:13:50 +01:00
David Baker 4480553bf9 Move m.direct description to the swagger 
Also change the swagger to yaml so I can put that description in it
without having to figure out how to embed that in json.
 2016-10-05 13:12:14 +01:00
Richard van der Hoff a8d35b2409 UI Auth: servers should 401 when a request fails 
(ref https://matrix.org/jira/browse/SYN-744)
 2016-10-05 11:25:49 +01:00
David Baker c16ba9488f Spec notifs API 2016-10-05 10:15:49 +01:00
Richard van der Hoff 37fb1ceb65 Merge pull request #395 from matrix-org/rav/kill_refresh_tokens 
Remove references to refresh tokens and tokenrefresh
 2016-10-04 17:55:38 +01:00
David Baker 8e096bdc48 Link to createRoom, not initialsync 2016-10-04 15:15:01 +01:00
David Baker 85bc989c02 pr feedback 2016-10-04 15:07:14 +01:00
David Baker 976d41351e spelling 2016-10-04 12:43:41 +01:00
David Baker d39f662df5 PR feedback 2016-10-04 11:57:24 +01:00
David Baker 203ea99328 Spec m.direct 2016-10-03 18:17:43 +01:00
Richard van der Hoff f4c7fdfd03 Remove references to refresh tokens and tokenrefresh 
refresh tokens are dead.
 2016-10-03 17:05:56 +01:00
Richard van der Hoff ebaaa7e3b3 Review feedback 
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
 2016-09-29 13:18:45 +01:00
Richard van der Hoff ccd7bb32d5 Specification for direct-to-device messages 2016-09-27 14:27:27 +01:00
David Baker 9a1db01d92 Clarify highlight and sound tweaks. 2016-09-08 11:59:49 +01:00
Benjamin Saunders cade909e25 Fix inconsistencies regarding redacted_because 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-08-30 21:18:55 -07:00
Benjamin Saunders 77b668a5dc Fix some obsolete uses of user_id key in events 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-08-26 23:06:41 -07:00
Richard van der Hoff 2fa7aac3be Merge pull request #377 from Ralith/typos 
Fix typo
 2016-08-26 10:28:52 +01:00
Benjamin Saunders 80bfbbdd33 Fix typo 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-08-26 02:23:16 -07:00
David Baker fd888fcbda Merge pull request #373 from matrix-org/dbkr/contains_display_name_override 
Make the display name rule an override rule
 2016-08-17 09:43:44 +01:00
David Baker b65b0d049e Make the display name rule an override rule 2016-08-15 18:32:35 +01:00
David Baker 6592646ee9 Add dot prefix to .rule.master 
It's a default rule, so it needs a dot
 2016-08-15 18:29:39 +01:00
Richard van der Hoff c51c4acf7f Clarifications to authentication mechanisms 
* Make the purpose of the `auth` key in /register requests explicit, and say
  that it should be empty at first.

* Restructure the UA-auth section a bit.

* In the UA-auth section, say that clients should submit no `auth` to start
  with, and add 'Stage 0' representing  this to the example.

* s/{stage,login} type/authentication type/ in the UA-auth section. Seems
   clearer to me.

* Try to distinguish the example responses from the example requests by giving
  an HTTP header.
 2016-08-15 10:28:15 +01:00
Matthew Hodgson 9cb626982a s/user/username/ typo 2016-08-10 18:09:44 -05:00
Richard van der Hoff 0248afe6ac login with invalid token gives a 403 2016-08-09 16:28:29 +01:00
Richard van der Hoff 1f1dfdd91c More clarifications 2016-08-09 15:51:12 +01:00
Richard van der Hoff ec81b4c9fe More PR feedback 
Add a couple of TODO sections
 2016-08-09 12:16:20 +01:00
Richard van der Hoff 4b0e546eeb PR feedback 
Fix some typos, and clarify several aspects of server behaviour.
 2016-08-09 12:02:38 +01:00
Richard van der Hoff 41368dc5a7 document CAS login 
Following the spirit of "document how it is, not how we wish it was", document
the CAS login bits.
 2016-08-08 17:33:48 +01:00
Richard van der Hoff ec20f15407 /tokenrefresh should expire the access token 
It's possible for clients to call /tokenrefresh before the access_token has
expired, potentially leading to a proliferation of valid access_tokens.
 2016-07-19 09:17:14 +01:00
Richard van der Hoff 2370a4c970 Spell out the state algorithm for createRoom 
Fixes https://matrix.org/jira/browse/SPEC-429.

Synapse currently follows the specified ordering, but does *not* give the
specified error when the state is invalid (instead it creates the room anyway
but gives a 403 M_FORBIDDEN). Still, I don't think that should be a real
problem for any real clients, and nothing would break if we changed this in
synapse, so it might as well go in the spec anyway.
 2016-07-18 13:01:45 +01:00
Matthew Hodgson c0490f2db2 cosmetics 2016-07-14 18:25:34 +01:00
Richard van der Hoff a64f9bbb63 C-S spec: Fix 'unstable' in link to /context API 2016-07-14 16:23:59 +01:00
Richard van der Hoff b5f9e896ba C-S spec: Fix 'unstable' in link to /context API 2016-07-14 16:20:59 +01:00
Richard van der Hoff a2ab6854ff CS spec: Add r0.2.0 to historical version list 2016-07-14 15:40:49 +01:00
Richard van der Hoff ae489260a1 Merge pull request #359 from matrix-org/rav/mxid_grammar 
Define MXID grammar
 2016-07-14 15:16:15 +01:00
Richard van der Hoff 72449294bc Moar TODO 2016-07-14 15:04:16 +01:00
Richard van der Hoff a2f1c6a7a6 Add a TODO about defining non-latin login creds 2016-07-14 14:38:04 +01:00
Richard van der Hoff cdd19dca7f fix typos 2016-07-13 18:32:29 +01:00
Richard van der Hoff f942b6e5c1 remove some redundant words 2016-07-13 18:27:40 +01:00
Richard van der Hoff 001db45046 s/mxid/user id/, and other PR feedback. 2016-07-13 18:20:11 +01:00
Richard van der Hoff e628edfdc6 Define MXID grammar 
Quick! Write down the decisions on the grammar before we get a chance to change
our minds!

Also some placeholder sections for other types of identifier.
 2016-07-13 15:24:31 +01:00
Richard van der Hoff 8ac45d7948 Merge pull request #353 from matrix-org/rav/room_membership 
Clarify the room-membership APIs
 2016-07-13 11:34:14 +01:00
Richard van der Hoff 0c06ea0e67 Merge pull request #356 from matrix-org/rav/fix_redaction 
Fix name of prev_content to preserve on redactions
 2016-07-13 11:14:07 +01:00
Richard van der Hoff a9d3cfd13c Merge branch 'master' into rav/link_undeprecated_endpoints 2016-07-13 11:09:53 +01:00
Richard van der Hoff d92515bce3 Merge pull request #354 from matrix-org/rav/reorder_deprecated_initialsync 
Move /room/x/initialSync to after the undeprecated APIs
 2016-07-13 11:07:11 +01:00
Richard van der Hoff d8a47dbb5d Merge pull request #352 from matrix-org/rav/kill_old_sync 
Remove references to intialSync etc, and rewrite syncing
 2016-07-13 10:54:02 +01:00
Richard van der Hoff 49cd65dd58 Add a license to the spec 
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
 2016-07-12 17:28:30 +01:00
Richard van der Hoff 1c6eed5c35 Fix name of prev_content to preserve on redactions 
The field is called prev_content, not prev_state.
 2016-07-12 16:34:16 +01:00
Richard van der Hoff 6bcb1798f5 Mark deprecated endpoints with their replacements 
Fixes https://matrix.org/jira/browse/SPEC-415
 2016-07-12 16:18:48 +01:00
Richard van der Hoff 9d267795e0 Move /room/x/initialSync to after the undeprecated APIs 
It's a bit incongruous to have to read through the deprecated /initialSync to
get to the good stuff. Separate out intialSync so that we can move it later in
the spec.
 2016-07-12 15:03:20 +01:00
Richard van der Hoff 885e6797f2 Fix double-negative in room naming 2016-07-12 14:50:49 +01:00
Richard van der Hoff 4118ce6680 Add rationale to /sync 2016-07-12 14:48:03 +01:00
Richard van der Hoff 7186ecba7f Clarify the room-membership APIs 
* give join/invite their own subsection
* move ban/unban into the banning section
* document forgettting and kicking
 2016-07-12 14:18:48 +01:00
Richard van der Hoff 017935d8e9 Fix typo 2016-07-12 14:15:52 +01:00
Richard van der Hoff 6dfc923c1d Remove references to intialSync etc, and rewrite syncing 
The 'Events' section of the C-S spec was full of outdated references to the v1
sync api, which is long dead. (https://matrix.org/jira/browse/SPEC-414).

Also, try to clarify why /sync distinguishes state and timeline
(https://matrix.org/jira/browse/SPEC-423).
 2016-07-12 13:10:36 +01:00
Richard van der Hoff 7b4c21fa77 Add link to room name bug 2016-07-12 11:47:39 +01:00
Richard van der Hoff d4194dd24e Clarify the room-naming behaviour 
Make behaviour on empty `m.room.name` and `m.room.canonical_alias` events
explicit.
 2016-07-11 17:49:27 +01:00
David Baker 4812be9142 Missing . 2016-07-07 15:58:20 +01:00
David Baker ead5648b8c Add requestToken endpoints 
For password reset and 3pid adding
 2016-07-07 14:52:45 +01:00
David Baker ef4c03894d Merge pull request #343 from matrix-org/dbkr/threepid_requesttoken 
Spec for endpoint-specific 3pid verification token
 2016-07-05 15:17:18 +01:00
Richard van der Hoff df3f4b4ecf Fix link to draft e2e spec 2016-06-30 18:01:32 +01:00
David Baker e4db7be8e2 Better structure for error response 
& add server not trusted error
 2016-06-30 16:22:01 +01:00
David Baker 572aa24a88 Add M_THREEPID_IN_USE 2016-06-30 15:40:20 +01:00
David Baker b0194a3016 Spec for endpoint-specific 3pid verification token 
As per proposal https://docs.google.com/document/d/13mapDbaOnbob9ZYRDiGm1YbeZhFOBj_R1OvgBA9pA5s/edit?pref=2&pli=1#
 2016-06-30 14:50:17 +01:00
Mark Haines af091ff614 Document changes to the default push rules 2016-06-22 16:34:23 +01:00
Mark Haines 30a3302921 Merge pull request #274 from matrix-org/markjh/default_rules 
Update the predefined push rules in the spec
 2016-06-22 16:14:21 +01:00
Erik Johnston e80e32173f Merge pull request #278 from matrix-org/erikj/presence 
Update presence spec.
 2016-06-22 14:08:44 +01:00
David Baker ec69f04793 Merge pull request #337 from matrix-org/rav/directory_docs 
Improve documentation of directory API
 2016-06-16 14:14:00 +01:00
Richard van der Hoff 7bbb664784 Improve documentation of directory API 2016-06-16 13:58:45 +01:00
David 92bb1c1b43 Update wording as per request from richvdh 2016-06-13 22:59:52 +08:00
David a7e40bed88 Add powerlevel name to value list 2016-06-13 10:34:16 +08:00
Richard van der Hoff 099d356dfb Add r0.1.0 to version list in C-S spec 2016-05-13 10:35:22 +01:00
Richard van der Hoff e7e9f5fa46 Document the /logout api 
We have one, and it's useful, so we really ought to document it
 2016-05-08 22:26:49 +01:00
Richard van der Hoff 3bce28a15c Clarifications to the 'Client authentication' section 
* Use the terminology 'login type' everywhere instead of mixing up 'stage type'
  and 'login type'

* Don't have a separate 'APIs using the User-Interactive Authentication
  mechanism' section, because (a) it doesn't make much sense to organise the
  APIs this way, and (b) it was a set of lies anyway.

* Move '/account/password' definition into registration.yaml so that register
  and password can share a section in the spec; remove duplicate doc for
  /password.

* Write some words on using 3pids for /login
 2016-05-06 17:28:35 +01:00
Richard van der Hoff 5cc9066159 Add git versions to other parts of the spec 2016-05-06 09:49:26 +01:00
Richard van der Hoff 01f8173c84 Put each bit of spec in its own directory 
I want to change the URLs for the spec sections on the website from
<version>/<section>.html to <section>/<version>.html, to better reflect how we
do the versioning.

This puts each bit of spec in its own directory, updates the index to point to
the right place, and fixes continuserv to deal with directories as well as
files.

This will probably require fixes to the speculator too, but I'll have to come
back to that.
 2016-05-05 18:26:17 +01:00
Richard van der Hoff 351bbee016 Remove changelog from index.rst 
... since it's explicitly unversioned.
 2016-05-05 15:23:21 +01:00
Richard van der Hoff 7d20d2d903 Add old-version links to C-S API 2016-05-05 15:22:39 +01:00
Richard van der Hoff 5b010de2b3 Fix typo 2016-05-05 15:15:39 +01:00
Richard van der Hoff e68193d2e0 Attempt to clarify the spec versioning. Again. 2016-05-05 15:03:04 +01:00
Matthew Hodgson 17b8fccd4c rephrase intro 2016-05-05 14:00:53 +01:00
Jimmy Cuadra c44d61b3a9 Clarify which documents are generated from scripts. 2016-05-04 02:30:44 -07:00
Jimmy Cuadra 22b542e3f9 Fix grammar in spec index. 2016-05-04 02:27:29 -07:00
Jimmy Cuadra 5b18db9096 Make list of APIs on the index a table. 2016-05-04 01:42:01 -07:00
Jimmy Cuadra 4b27d6a7a4 Reorganize spec index. 2016-05-04 01:42:01 -07:00
Richard van der Hoff cd4e7306ca Merge pull request #305 from matrix-org/rav/show_own_leave_event 
Clarify `history_visibility` behaviour
 2016-04-08 11:47:17 +01:00
David Baker 71cb646541 Change id in the push gateway poke to be event_id and spec that it's the Matrix event ID of the message. Correct the spec for badge count pushes which omit fields previously described as mandatory. Add more detail about when to use event_id to suppress dupes. Also add the push gateway doc so it's actually included in the spec. 2016-04-06 18:28:21 +01:00
Richard van der Hoff b59d16c4d1 Clarify history_visibility behaviour 
Clear up some lies in the history_visibility section, and clarify behaviour for
`m.room.history_visibility` and the user's own `m.room.member` events.
 2016-04-06 17:55:01 +01:00
Daniel Wagner-Hall 313f09f5c0 Specify address validating and binding 2016-03-10 16:54:38 +00:00
Kegsay 506accee27 Merge pull request #288 from matrix-org/markjh/pushrule_stream 
Add a snippet of documentation for a m.push_rules event.
 2016-03-10 14:05:42 +00:00
Daniel Wagner-Hall fecff8afdc Specify association lookup 2016-03-10 13:59:34 +00:00
Daniel Wagner-Hall 30c9fee0b2 Specify ephemeral invitation signing 2016-03-10 13:57:45 +00:00
Daniel Wagner-Hall 097b69dc1e Loosely specify invitation storage 2016-03-09 17:27:44 +00:00
Daniel Wagner-Hall e0c55eeccf Add initial identity server spec 
More to come
 2016-03-09 15:49:23 +00:00
Daniel Wagner-Hall f4f186baee Add _cs suffix to client-server http APIs 
I'm about to add identity service APIs, so differentiating is good.
 2016-03-08 17:42:41 +00:00
Mark Haines c3c95d0c09 Fix grammar and add backticks for /sync 2016-03-08 10:17:27 +00:00
Mark Haines cc0dae3aeb Deduplicate a couple of places where "the" was written twice in a row 2016-03-07 11:31:49 +00:00
Mark Haines 5407cc8e05 Add a snippet of documentation for a m.push_rules event. 2016-03-04 14:41:30 +00:00
Erik Johnston 3d4d91a462 Reword to make sense 2016-03-01 16:15:59 +00:00
Erik Johnston 167a08a805 Allow idle timeout to be configurable 2016-03-01 16:13:41 +00:00
Erik Johnston bc68177471 Grammar 2016-03-01 16:07:25 +00:00
Erik Johnston f1a8306d08 Spec currently_active time and idle timeout behaviour 2016-02-23 11:25:47 +00:00
Richard van der Hoff 68a4306773 Split room previews into a separate module 
Guest access and room peeking are orthogonal
 2016-02-19 15:26:28 +00:00
Mark Haines 740f775932 Fix a couple of typos, remove .m.rule.member_event 2016-02-18 18:36:08 +00:00
Mark Haines 3db6980e0b Remove references to device specific push rules 
Since they weren't implemented on the servers and weren't
used by the clients.
 2016-02-18 16:05:47 +00:00
Mark Haines 5d85e3a505 Remove indents 2016-02-15 16:53:08 +00:00
Mark Haines afe7638e30 Add a new title level to appease gendoc 2016-02-15 16:50:15 +00:00
Mark Haines b16af5ef64 Fix JSON, add headers 2016-02-15 16:41:47 +00:00
Mark Haines 8a1a02a11b Update the predefined push rules in the spec 2016-02-15 16:28:43 +00:00
Matthew Hodgson 6925547875 remove the oversimplification that the WebRTC standard is based around two-oparty communication 2016-02-11 18:34:28 +00:00
Richard van der Hoff b2e0a855cc Add 'event' to event context API 
also link through to the event schemas
 2016-02-01 17:45:45 +00:00
Daniel Wagner-Hall 0da26cd7e1 Specify login behaviour for unknown 3pids 2016-01-29 16:49:54 +00:00
Mark Haines 245e8e8571 Add 3pid password login to the spec 2016-01-29 14:42:18 +00:00
Daniel Wagner-Hall 2e46b587b8 Require explicit un-banning 2016-01-15 14:08:40 +00:00
David Baker 169cc98101 M_INVALID_USERNAME to be consistent with the name of the parameter 2016-01-15 10:04:29 +00:00
David Baker 2301a792d7 Add an error code for invalid user names. 2016-01-14 17:19:04 +00:00
Daniel Wagner-Hall 9bc07ea093 Add ID to application services 2016-01-13 16:04:01 +00:00
Daniel Wagner-Hall 1e2b63763e /join and /room/:roomId/join aren't exact aliases 
Separate them, clarify their differences.

Also, fix some links which weren't being properly populated.
 2016-01-13 15:55:51 +00:00
Richard van der Hoff 91fa78eb53 Start development on next spec version 2016-01-11 15:52:08 +00:00
Richard van der Hoff cff1b4ae35 Merge pull request #251 from matrix-org/daniel/guestshiz 
Clarify guest /events and /sync
 2016-01-08 00:47:57 +00:00
Matthew Hodgson 411ab64712 fix misnamed key in example; thanks SkaveRat 2016-01-07 23:15:33 +00:00
Daniel Wagner-Hall 3edff684a1 Merge pull request #253 from matrix-org/daniel/guestupgrade 
Guests can upgrade to regular accounts
 2016-01-07 16:39:35 +00:00
Daniel Wagner-Hall f6b1b80678 Fix param name 2016-01-07 13:18:19 +00:00
Daniel Wagner-Hall 7d9547274c Clarify guest /events and /sync 2016-01-07 11:59:38 +00:00
Daniel Wagner-Hall 5e30d75ccb Add /_matrix/versions to spec 2016-01-06 17:43:20 +00:00
Daniel Wagner-Hall 713415015b Remove mention that /sync takes an inline filter 2016-01-06 15:51:07 +00:00
Daniel Wagner-Hall d3f05ae49a Guests can upgrade to regular accounts 2016-01-05 17:30:55 +00:00
Daniel Wagner-Hall ca67aa7b4f Tidy up guest access spec 
* Mention that /leave is allowed
* Mention that /sync is allowed
* Re-order such that the whole list of APIs fits on one screen
 2016-01-05 13:45:04 +00:00
Paul Evans c9ecfa7643 Merge pull request #242 from matrix-org/paul/federation 
Don't need to document /pdu/ any more
 2015-12-22 13:48:42 +00:00
Paul "LeoNerd" Evans 1f876778b5 Don't need to document /pdu/ any more 2015-12-21 16:50:56 +00:00
Paul Evans 0a2bdb1818 Merge pull request #240 from matrix-org/paul/federation 
Document the `/event` and `/backfill` S-S APIs
 2015-12-21 16:50:21 +00:00
Paul "LeoNerd" Evans 116253b2f5 Document the /event/:event_id/ federation endpoint 2015-12-17 20:45:57 +00:00
Richard van der Hoff e4dd346a81 Restore 'client behaviour' section 
Because it's the standard
 2015-12-17 14:07:35 +00:00
Richard van der Hoff b7c255a887 Tweaks/clarifications to search spec 
Fixes https://matrix.org/jira/browse/SPEC-305
 2015-12-17 13:40:22 +00:00
Daniel Wagner-Hall 34bab312d3 Merge pull request #231 from matrix-org/daniel/oldversions 
Add links to old releases
 2015-12-17 11:24:28 +01:00
Paul "LeoNerd" Evans b9bee6ee73 Initial hack at some federation /backfill documentation 2015-12-14 20:00:49 +00:00
Matthew Hodgson f8f76794a3 fix random whitespace bug 2015-12-14 08:40:41 +00:00
Daniel Wagner-Hall 678dbbe08a s/-/_/ 2015-12-09 17:17:45 +00:00
Daniel Wagner-Hall 7f87760655 Add links to old releases 2015-12-09 16:45:56 +00:00
Daniel Wagner-Hall 8d184570a8 Mention intro before specs 2015-12-09 16:40:47 +00:00
Daniel Wagner-Hall 997f3303f3 Revert "Add links to old releases" 
This reverts commit de12870791.
 2015-12-09 16:38:40 +00:00
Daniel Wagner-Hall de12870791 Add links to old releases 2015-12-09 16:32:36 +00:00
Daniel Wagner-Hall 53a21fc0b6 Note why we're not versioning index and intro 2015-12-09 16:29:11 +00:00
Daniel Wagner-Hall 8eb84612f2 Add index page 2015-12-09 16:17:58 +00:00
Daniel Wagner-Hall a484f04b33 Merge pull request #221 from matrix-org/daniel/pushaway 
Merge pull request #221 from matrix-org/daniel/pushaway
 2015-12-09 14:04:02 +00:00
Kegan Dougal bca3add9a7 Formatting 2015-12-08 16:38:48 +00:00
Kegan Dougal d01ff6b495 Add noddy push gateway placeholder 2015-12-08 16:37:51 +00:00
Daniel Wagner-Hall f22adad02e Merge pull request #225 from matrix-org/daniel/links 
Add link to speculator
 2015-12-08 16:19:17 +00:00
Erik Johnston c96848d1bc Merge pull request #169 from matrix-org/erikj/search_yet_agian 
Search: Document event context, groups and orders.
 2015-12-08 16:11:03 +00:00
Daniel Wagner-Hall 4be078440d Don't mention server-server stuff in client-server spec 2015-12-08 15:42:37 +00:00
Erik Johnston c4085b0475 Merge pull request #139 from matrix-org/erikj/event_context_api 
Add event context api swagger
 2015-12-08 15:24:57 +00:00
Daniel Wagner-Hall fd3dde5e88 Add link to speculator 2015-12-08 14:42:10 +00:00
Paul "LeoNerd" Evans e32070f189 Decide that joining HS is the one that specifies the join event ID 2015-12-08 14:04:40 +00:00
Daniel Wagner-Hall a2283f5499 Remove /notify from client-server API 2015-12-08 13:25:31 +00:00
Daniel Wagner-Hall 217e22fc30 Format changelog more nicely 2015-12-08 13:18:36 +00:00
Daniel Wagner-Hall 19dfafe376 Remove superfluous space 
This causes a <dt> to get rendered around the <tt>s which breaks some
formatting.
 2015-12-08 10:34:48 +00:00
Erik Johnston dd276d4c4d Add event context module 2015-12-07 16:56:03 +00:00
Erik Johnston 856dd9100e Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian 2015-12-07 16:28:14 +00:00
Erik Johnston 2aef684e7e Add list of required supported groupings 2015-12-07 16:02:22 +00:00
Erik Johnston c61ae86102 Specify behaviour if server does not support pagination 2015-12-07 16:00:15 +00:00
Richard van der Hoff 3939ccf20c Remove e2e drafts from master 
This is now being tracked in the main spec, on the drafts/e2e branch.
 2015-12-07 14:45:46 +00:00
Daniel Wagner-Hall 39f43abbb7 Add per-API changelogs 2015-12-07 14:24:10 +00:00
Daniel Wagner-Hall 705556634a Add filters 2015-12-04 19:46:45 +00:00
Daniel Wagner-Hall 72e12bc2f5 Merge pull request #205 from jimmycuadra/signing-details-typo 
Fix typo in signing details
 2015-12-04 11:17:49 +00:00
Jimmy Cuadra 444fc5dbcd Fix typo in signing details. 2015-12-04 03:15:23 -08:00
Daniel Wagner-Hall 873b0dcecf Replace version numbers with release numbers 2015-12-04 11:09:35 +00:00
Daniel Wagner-Hall 63ca91f353 Move event signing to server-server spec 
It's *definitely* not a client concern.

It isn't really in the right place at the moment, but s-s is very much a
work in progress whereas c-s is nearly stable.
 2015-12-04 10:55:18 +00:00
Daniel Wagner-Hall f308b7543c Specify /admin/whois/{userId} 2015-12-03 16:26:45 +00:00
Daniel Wagner-Hall 19ce17cfed Merge pull request #200 from matrix-org/daniel/redact 
Merge pull request #200 from matrix-org/daniel/redact
 2015-12-03 15:57:52 +00:00
Daniel Wagner-Hall 4baba85fe5 Draftify e2e in anticipation of a spec release 2015-12-03 11:52:11 +00:00
Daniel Wagner-Hall 2f3a00fe34 Consistently spell homeserver as homeserver 2015-12-02 19:23:33 +00:00
Daniel Wagner-Hall e072d215cf Specify redaction 2015-12-02 15:27:25 +00:00
Matthew Hodgson b946d39886 typo 2015-12-02 01:25:07 +00:00
Daniel Wagner-Hall c05da871ca Merge pull request #194 from matrix-org/daniel/clarify 
Merge pull request # 194 from matrix-org/daniel/clarify
 2015-12-01 18:46:39 +00:00
Daniel Wagner-Hall aa4ed10821 Unify v1 and v2 event schemas 2015-12-01 17:23:58 +00:00
Daniel Wagner-Hall 97fd1fdd62 Embed client and server release numbers 
Note that this also removes the changelog - I'm going to re-add the
changelog differently soon.
 2015-12-01 17:08:02 +00:00
Daniel Wagner-Hall f6229f649a Remove confusing wording 2015-12-01 16:58:40 +00:00
Daniel Wagner-Hall fd88be1830 Merge pull request #189 from matrix-org/daniel/sections 
Merge pull request # 189 from matrix-org/daniel/sections
 2015-12-01 16:43:17 +00:00
Erik Johnston 23b2497743 Expand on where pagination tokens can be returned 2015-12-01 15:31:35 +00:00
Erik Johnston 46fd0b252c Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian 2015-12-01 15:06:13 +00:00
Daniel Wagner-Hall c6e0322a9e Swaggerify /account 2015-12-01 13:53:03 +00:00
Daniel Wagner-Hall c9c433bc15 Make section depths consistent 2015-11-30 14:31:24 +00:00
Daniel Wagner-Hall 6c66bfc755 Flatten out v1 and v2_alpha directories 
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
 2015-11-30 11:22:57 +00:00
Daniel Wagner-Hall b479b54cd8 Add tables of contents to individual specs 2015-11-27 18:52:58 +00:00
Daniel Wagner-Hall e401d3e262 Merge pull request #184 from matrix-org/daniel/splitspec 
Split spec into page-per-section
 2015-11-27 16:46:06 +00:00
Daniel Wagner-Hall e171acf01f Split spec into page-per-section 2015-11-27 16:45:47 +00:00
Daniel Wagner-Hall bc514dc9c4 Merge pull request #178 from matrix-org/daniel/directory 
Fix and include /directory api docs
 2015-11-27 16:21:15 +00:00
Daniel Wagner-Hall 7f2813354d Swaggerify /ban 2015-11-27 15:42:21 +00:00
Mark Haines a20a49abf6 Merge pull request #168 from matrix-org/markjh/client_config 
Add API for setting client config
 2015-11-27 15:32:21 +00:00
Mark Haines c5f457cee9 Merge pull request #132 from matrix-org/markjh/room_tags 
Document a v2 api for setting tags on rooms
 2015-11-27 15:31:54 +00:00
Richard van der Hoff d9130f0e13 Merge pull request #24 from matrix-org/markjh/end_to_end_encryption 
Basic specification for key distribution for end-to-end cryptography.
 2015-11-27 14:32:26 +00:00
Daniel Wagner-Hall ad4d8ae7a6 Move client-server intro to client-server section 2015-11-27 13:50:24 +00:00
Richard van der Hoff 0b1ba70a32 fix rst markup 
`` > `
 2015-11-27 13:33:58 +00:00
Richard van der Hoff 2dbb8ba56c Fix title levels 
make the title decoration consistent with the rest of the spec
 2015-11-27 12:53:03 +00:00
Richard van der Hoff 51ca25a472 Merge branch 'master' into markjh/end_to_end_encryption 2015-11-27 11:49:11 +00:00
Richard van der Hoff 5f4458b2ff Merge branch 'master' into markjh/end_to_end_encryption 2015-11-27 11:45:49 +00:00
Richard van der Hoff 8d41536757 Address kegan's comments 
Minor fixes to the e2e spec as raiseds by kegan
 2015-11-27 11:37:24 +00:00
Daniel Wagner-Hall 5e30b5b8d7 Remove POST version of /send 
PUT should always be used.
 2015-11-26 16:46:29 +00:00
Daniel Wagner-Hall c25a806cef Fix and include /directory api docs 2015-11-26 15:03:39 +00:00
Mark Haines e76068a2a6 Merge branch 'markjh/room_tags' into markjh/client_config 2015-11-20 18:40:56 +00:00
Mark Haines 5bae15d47b Merge branch 'master' into markjh/room_tags 
Conflicts:
	api/client-server/v2_alpha/sync.yaml
 2015-11-20 18:39:15 +00:00
Richard van der Hoff d8dd380dfa Merge pull request #164 from matrix-org/rav/SPEC-254 
Fix /sync documentation, post SPEC-254
 2015-11-20 15:17:55 +00:00
Mark Haines 032ee75537 Update specification wording to match s/config/account_data/ 2015-11-19 10:42:22 +00:00
Mark Haines 05c0092664 s/config/account_data/ 2015-11-19 10:38:22 +00:00
Paul Evans e95a1616af Merge pull request #143 from matrix-org/paul/federation-room-join 
Document the federation remote join handshake
 2015-11-18 19:21:04 +00:00
Mark Haines 40f7eab73f s/private_user_data/account_data/ 2015-11-18 15:44:18 +00:00
Mark Haines 24c4b8b095 Merge branch 'markjh/room_tags' into markjh/client_config 
Conflicts:
	api/client-server/v1/rooms.yaml
	api/client-server/v1/sync.yaml
	api/client-server/v2_alpha/sync.yaml
	specification/targets.yaml
 2015-11-18 15:30:16 +00:00
Mark Haines fcbb985073 s/private_user_data/account_data/ 2015-11-18 15:27:26 +00:00
Richard van der Hoff 6653362f31 Unflatten 'unsigned' 
It turns out that flattening 'unsigned' comes with too many downsides. Let's
stick with the status quo.
 2015-11-18 15:15:21 +00:00
Daniel Wagner-Hall 8201eaa042 Swaggerify /rooms/:room_id/leave 2015-11-17 15:31:10 +00:00
Erik Johnston 373c6c8270 Add ordering, pagination and grouping comments 2015-11-17 11:56:05 +00:00
Mark Haines c77b22778f Add some documentation on names of tags 2015-11-16 17:48:41 +00:00
Mark Haines 25769493b1 Fix template 2015-11-16 17:14:41 +00:00
Mark Haines e7fbe6f13b Limit the size of a tag 2015-11-16 17:13:02 +00:00
Mark Haines 48f35e15cb describe how to order rooms that don't have an order in their tags 2015-11-16 17:08:59 +00:00
Mark Haines 299af673da Specify how ordering of tags is supposed to work 2015-11-16 17:04:19 +00:00
Richard van der Hoff 7ff593b3de Merge branch 'rav/SPEC-254' into rav/flatten_sync 
Conflicts:
	specification/events.rst
 2015-11-16 16:56:39 +00:00
Mark Haines 3b390bff3c Merge branch 'master' into markjh/room_tags 
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
 2015-11-16 16:56:35 +00:00
Richard van der Hoff 0db055b4ea Fix another reference to 'txn_id' 2015-11-16 16:54:57 +00:00
Mark Haines 8f5783615c Merge branch 'master' into markjh/client_config 
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
 2015-11-16 16:51:45 +00:00
Paul "LeoNerd" Evans 233e8486bc Wording fix - objects contain keys, not list elements directly 2015-11-16 16:50:58 +00:00
Mark Haines c3769ef75c Add a module for client config to the specification 2015-11-16 16:49:32 +00:00
Paul "LeoNerd" Evans 6cbfba7011 'auth_events' is a List, not a String 2015-11-16 16:33:26 +00:00
Paul "LeoNerd" Evans 122c082fcf Comment about origin servers of invites having subsequently left the room 2015-11-16 16:29:43 +00:00
Paul "LeoNerd" Evans 923f05e554 More consistency around 'resident homeserver' 2015-11-16 15:34:11 +00:00
Paul "LeoNerd" Evans 36af793f05 s/full object/full event/ 2015-11-16 15:30:22 +00:00
Richard van der Hoff 29bd4d45ee Flatten the response to /sync 
Now that we don't expect there to be duplication betwen the 'timeline' and
'state' results, there's no point in having the state map. (That does mean the
events themselves need event_id fields though).

Also:

- move the contents of the 'unsigned' dictionary into the events themselves
- replace the state list with two layers of dictionary keyed on type and
  state_key
- rename the children of the 'rooms' dict from "joined/invited/archived" to
  "join/invite/leave" to match the membership states
 2015-11-16 00:00:48 +00:00
Richard van der Hoff 57995a815a Fix a number of untruths in the documentation about /sync. 
Attempts to make the /sync documentation better represent fact as it currently
stands - in particular document the structure of the returned events.
 2015-11-15 23:47:35 +00:00
Paul "LeoNerd" Evans 988d773476 /make_join protoevent no longer needs the pointless 'prev_state' key (SYN-517) 2015-11-13 17:49:22 +00:00
Paul "LeoNerd" Evans 885dd1e86c Explain the 'prev_events' join protoevent key 2015-11-13 16:39:31 +00:00
Paul "LeoNerd" Evans db5a90edcd Avoid using the words 'current state' when talking about the result of the /make_join request 2015-11-13 16:36:26 +00:00
Paul "LeoNerd" Evans aac45295ee Remark that the directory server step could be skipped in an invite case 2015-11-13 16:34:22 +00:00
Paul "LeoNerd" Evans d7c69fae43 Fix typo 'process' 2015-11-13 16:33:34 +00:00
Daniel Wagner-Hall ea364a108b Merge pull request #161 from matrix-org/daniel/guestdisplaynames 
Merge pull request #161 from matrix-org/daniel/guestdisplaynames

Guests are allowed to set displaynames
 2015-11-12 13:23:49 +00:00
Daniel Wagner-Hall 29d9c8eec6 Guests are allowed to set displaynames 2015-11-12 12:05:02 +00:00
Daniel Wagner-Hall 061105c9dc Guest users are allowed room initialSync 2015-11-11 17:18:58 +00:00
Daniel Wagner-Hall d7357ef9b7 Specify /publicRooms 2015-11-11 11:39:40 +00:00
Daniel Wagner-Hall 24c2036a35 3pid invites: remove mentions of display_name 2015-11-09 17:30:18 +00:00
Daniel Wagner-Hall e72151f2c3 Specify guest room access 
This was reviewed as PR #150 and merged from daniel/anonymousaccess
 2015-11-06 18:15:21 +00:00
Daniel Wagner-Hall 161441fa3a Update 3pid spec based on new implementation 2015-11-05 18:11:20 +00:00
Richard van der Hoff 8cba11b1cd Add some links to spec bugs for display names 
Just added a couple of TODO comments to useful jira bugs
 2015-11-05 11:06:31 +00:00
Richard van der Hoff 2fd5fc39a0 Add spec for calculating display names for rooms and users 
Merged from https://github.com/matrix-org/matrix-doc/pull/145
 2015-11-05 10:55:11 +00:00
Mark Haines 3953006792 Fix spelling 2015-11-03 15:54:33 +00:00
Paul "LeoNerd" Evans f6c55979e0 Remove TODO comment about SYN-490 as it's unlikely to matter for v1; we'll fix it in v2 2015-11-02 15:17:18 +00:00
Paul "LeoNerd" Evans 40fa339cf7 Draw a pretty (well at least I think it's pretty) ASCII diagram of the remote join handshake 2015-11-02 15:00:18 +00:00
Mark Haines 149890227a Fix wording 2015-11-02 13:35:11 +00:00
Mark Haines 52f55e0542 Allow room tags to have asssociated content, and return that content in the m.tag events 2015-11-02 13:31:25 +00:00
Mark Haines f557e69860 Note that m.tag events can appear in v1 initialSync and /events as well as v2 sync. Only add the room_id for v1 /events since it is redundant in v1 /initialSync 2015-11-02 10:13:47 +00:00
Mark Haines d297d83151 Mention that sender is renamed to user_id in v1 2015-10-29 18:45:53 +00:00
Mark Haines d067e50af5 Document the differences in event formatting between the v1 and v2 client APIs 2015-10-29 18:38:33 +00:00
Paul "LeoNerd" Evans 5b6f858802 Some initial notes by way of the remote join handshake; with several TODOs and unanswered questions 2015-10-28 20:28:49 +00:00
Paul "LeoNerd" Evans 745e607577 Use 'room' or 'room ID' instead of 'context' when describing federation protocol 2015-10-28 14:49:50 +00:00
Mark Haines 65066a76b3 Add the m.tags event to a `private_user_data key rather than including it under the ephemeral` key 2015-10-26 18:30:04 +00:00
Mark Haines 9b0d20315a Add the tags module to the specification targets 2015-10-26 16:22:04 +00:00
Mark Haines 12e33a3b09 Document a v2 api for setting tags on rooms 2015-10-26 16:14:24 +00:00
Richard van der Hoff 13eddd456f Proposal for adding full_state param to v2 sync 2015-10-26 15:52:45 +00:00
Erik Johnston 696f75d80b Rename section 2015-10-26 14:14:13 +00:00
Erik Johnston e2376e9a43 Merge branch 'erikj/login_fallback_v1' of github.com:matrix-org/matrix-doc 2015-10-26 14:11:21 +00:00
Erik Johnston 3cf431cac1 Add link 2015-10-26 14:10:02 +00:00
Kegsay a22f1cd230 Merge pull request #119 from matrix-org/paul/test-vectors 
Capture cryptographic test vectors for JSON or event signing from source
 2015-10-26 14:02:42 +00:00
Erik Johnston 9a5bd6d21f Use static 2015-10-26 13:56:07 +00:00
Erik Johnston 98dbf4d60b Better flow 2015-10-26 13:46:41 +00:00
Erik Johnston 0529b4a9a2 Reword 2015-10-26 13:45:36 +00:00
Erik Johnston 88c459d549 Add back in login v1 fallback API 2015-10-26 13:40:24 +00:00
Daniel Wagner-Hall 7c250f91ff Merge pull request #127 from matrix-org/daniel/exposedrooms 
Allow history to be noted as world-readable
 2015-10-26 10:30:32 +00:00
Kegsay 4823a133cd Merge pull request #124 from matrix-org/clarify_scale_crop 
Clarify 'scale' & 'crop' resize methods
 2015-10-26 09:57:32 +00:00
Richard van der Hoff f47a49de43 Merge pull request #126 from matrix-org/rav/send_events_api 
Add the room send and state APIs to the spec
 2015-10-23 17:05:30 +01:00
Richard van der Hoff 1945697456 Further tweaks to the room send and state APIs 
- fix confusion re empty/absent state_keys
- move 'types of room events' section earlier in the 'Events' section
- remove some redundant anchors
 2015-10-23 16:58:55 +01:00
Mark Haines 1d7cb6937f Merge pull request #123 from matrix-org/markjh/list_formatting 
Fix list formatting
 2015-10-23 16:53:29 +01:00
Richard van der Hoff 28ab643a4e Remove duplicated registration/login APIs 
Currently the spec duplicates all of the account-management APIs. There's still
work to be done here, but the complete duplication is confusing.
 2015-10-23 15:56:48 +01:00
Daniel Wagner-Hall 67880686d5 Allow history to be noted as world-readable 
SPEC-237
 2015-10-23 14:02:53 +01:00
Richard van der Hoff 587a8ba7ce Merge branch 'master' into rav/send_events_api 2015-10-23 13:48:58 +01:00
Richard van der Hoff d18d406c41 Add the room send and state APIs to the spec 2015-10-23 13:08:42 +01:00
David Baker 01064369a4 Add some clarification on the difference between 'scale' and 'crop' resize methods 2015-10-23 11:57:15 +01:00
Mark Haines e3e8026025 Fix list formatting so that we aren't including everything in blockquotes 2015-10-23 10:51:31 +01:00
Erik Johnston f0c74a9c83 Merge pull request #96 from matrix-org/erikj/search_actual 
Add search API
 2015-10-23 10:19:36 +01:00
Erik Johnston 4a558ad63b Typo 2015-10-23 10:19:25 +01:00
Kegan Dougal f95d19cecd Merge branch 'master' into appservice-swagger 
Conflicts:
	specification/application_service_api.rst
 2015-10-21 09:55:53 +01:00
Daniel Wagner-Hall 74d42f0142 Allow rejecting invitations 2015-10-20 11:08:22 +01:00
Paul "LeoNerd" Evans e38e4788f2 Spell 'cryptographic' correctly 2015-10-19 18:29:37 +01:00
Paul "LeoNerd" Evans 228acc59aa Capture cryptographic test vectors for JSON or event signing from source code 2015-10-19 18:26:52 +01:00
Paul Evans 84a8663019 Merge pull request #115 from matrix-org/paul/event-redaction 
Initial attempt at describing the event redaction algorithm
 2015-10-19 17:44:22 +01:00
Paul "LeoNerd" Evans 9252b3e1a2 Fix typo s/he/the/ 2015-10-19 17:44:09 +01:00
Paul "LeoNerd" Evans bfa9937bdc Minor wording updates 2015-10-19 17:28:31 +01:00
Daniel Wagner-Hall a9a9067d7e Merge pull request #114 from matrix-org/daniel/3pidtosigned 
Update 3pid invite section to reflect signed property
 2015-10-19 15:52:50 +01:00
Erik Johnston 1d01f69c3c Merge remote-tracking branch 'origin/master' into erikj/search_actual 2015-10-19 13:46:58 +01:00
Erik Johnston 111ca99519 Clarify that this doesn't include events that occurred after you left the room. 2015-10-19 13:46:30 +01:00
Kegsay 6546068c63 Merge pull request #101 from matrix-org/spec-182-asapi-user-creation 
SPEC-182: Make it clearer how ASes are supposed to create users
 2015-10-19 13:39:50 +01:00
Kegan Dougal f3088a0674 Merge branch 'master' into spec-182-asapi-user-creation 2015-10-19 13:39:21 +01:00
Kegan Dougal 26f27d95fb Merge branch 'master' into registration-swagger 
Conflicts:
	specification/client_server_api.rst
 2015-10-19 13:34:41 +01:00
Kegan Dougal ae90d15b3c Add m.room.avatar 2015-10-19 10:46:07 +01:00
Daniel Wagner-Hall c70067dd1e Simplify language 2015-10-19 10:44:26 +01:00
Daniel Wagner-Hall 22fdb8f911 Merge branch 'master' into daniel/as 2015-10-19 10:37:12 +01:00
Paul "LeoNerd" Evans 29720cd152 Initial attempt at describing the event redaction algorithm 2015-10-16 19:00:36 +01:00
Daniel Wagner-Hall 6161a920b6 Update 3pid invite section to reflect signed property 2015-10-16 18:29:20 +01:00
Kegan Dougal 62d53b4f33 Review comments round III 2015-10-16 15:58:11 +01:00
Kegan Dougal 85a6a5a530 Merge branch 'master' into proofing 2015-10-16 15:23:07 +01:00
Kegan Dougal 4bb042daeb Review comments round II 2015-10-16 15:22:50 +01:00
Kegan Dougal e0fe3c42c8 Review comments 2015-10-16 14:19:00 +01:00
Kegan Dougal 6770d6b2d6 Review comments 2015-10-16 14:05:18 +01:00
Daniel Wagner-Hall 20b11281ea Remove lies about OAuth which doesn't exist 2015-10-16 13:11:10 +01:00
Erik Johnston eb59b8e9d1 Mention count 2015-10-16 10:16:40 +01:00
Erik Johnston a6cb2e4339 Mention rank 2015-10-15 16:40:21 +01:00
Kegan Dougal eca98af896 Swaggerify /register endpoint 
Need to move registration/login/auth sections around once #94 lands.
 2015-10-15 16:38:12 +01:00
Erik Johnston 24e36adbe3 Mention e2e encryption 2015-10-15 16:09:11 +01:00
Erik Johnston 770cfbc5de Be explicit about the events the search is performed over 2015-10-15 16:08:24 +01:00
Erik Johnston 906c59385f s/had/has/ 2015-10-15 15:49:58 +01:00
Kegan Dougal 55cc5c5bb5 Swaggerify application services 2015-10-15 14:53:03 +01:00
Kegan Dougal 3d087df538 Kill number prefixes for good 2015-10-15 13:40:05 +01:00
Kegan Dougal 6b72ddfb8c Spelling and typos 2015-10-15 13:36:43 +01:00
Kegan Dougal 08ccacae17 Merge branch 'master' into proofing 
Conflicts:
	specification/0-intro.rst
 2015-10-15 13:26:37 +01:00
Erik Johnston c47a94658a Mention supported keys 2015-10-15 11:12:00 +01:00
Kegsay 3146b52f83 Merge pull request #102 from matrix-org/spec-207-asapi-unique-tokens 
SPEC-207: Add a warning about needing AS tokens to be unique and why
 2015-10-15 11:08:50 +01:00
Kegsay 604e268add Merge pull request #105 from matrix-org/spec-177-events-max-len 
Add in size limits as per SPEC-222
 2015-10-15 11:08:28 +01:00
Kegan Dougal 5de63b4f45 Merge branch 'master' into proofing 
Conflicts:
	specification/0-intro.rst
 2015-10-15 11:06:30 +01:00
Erik Johnston af347baa68 Better phrasing 2015-10-15 11:06:15 +01:00
Erik Johnston 96a4996c76 Mention search categories 2015-10-15 11:02:37 +01:00
Kegsay 3a2c8cd4b3 Merge pull request #91 from matrix-org/module-history-vis 
History visibility module
 2015-10-15 11:02:24 +01:00
Kegan Dougal 5aad67f74d Review comments round III 2015-10-15 11:01:11 +01:00
Kegsay c5dc383668 Merge pull request #85 from matrix-org/module-im 
Instant messaging module
 2015-10-15 10:59:41 +01:00
Kegan Dougal 507cb29e39 Review comments round deux 2015-10-15 10:37:15 +01:00
Kegan Dougal f51ee70633 Review comments round 2 2015-10-15 10:19:51 +01:00
Kegan Dougal c82c07ddd2 Review comments 2015-10-15 09:58:39 +01:00
Kegan Dougal c4d1b56843 Add a comment about enforcement. 2015-10-15 09:57:21 +01:00
Kegsay 1229ad24dd Merge pull request #103 from matrix-org/spec-165-mxc-security 
SPEC-165: Outline directory traversal attacks on MXC URIs
 2015-10-14 17:48:59 +01:00
Kegsay bc0ab32cfd Merge pull request #99 from matrix-org/spec-144-https-examples 
SPEC-144 : Use https examples not http
 2015-10-14 17:46:29 +01:00
Kegan Dougal e6eb19c461 Review comments 2015-10-14 17:34:25 +01:00
Erik Johnston 728b5a7951 Add very short summary 2015-10-14 17:20:00 +01:00
Erik Johnston 007bb1a69a Add extra new line 2015-10-14 16:26:14 +01:00
Erik Johnston 5e48b0b79a Add search to targets 2015-10-14 16:21:12 +01:00
Erik Johnston 38fcc563da Spell out full title 2015-10-14 16:20:08 +01:00
Erik Johnston 0efa3fd981 Add module 2015-10-14 16:17:04 +01:00
Kegan Dougal 6a0595bc46 Add in size limits as per SPEC-222 2015-10-14 16:15:55 +01:00
Erik Johnston d8bc0c9315 Add search module 2015-10-14 16:13:43 +01:00
Kegan Dougal f0d8052951 SPEC-205: Warn about password strengths in m.login.password section 2015-10-14 15:42:44 +01:00
Kegan Dougal 44b19a8b0e SPEC-165: Outline directory traversal attacks on MXC URIs 2015-10-14 15:27:56 +01:00
Kegan Dougal 45b1d08c7e SPEC-207: Add a warning about needing AS tokens to be unique and why 2015-10-14 15:16:12 +01:00
Kegan Dougal cd34d4e19b SPEC-182: Make it clearer how ASes are supposed to create users by linkifying the right text. 2015-10-14 15:12:15 +01:00
Kegan Dougal 3608f3a282 SPEC-144 : Use https examples not http. 2015-10-14 14:44:09 +01:00
Kegan Dougal 34bd8edec5 Move related auth sections together 2015-10-14 13:26:58 +01:00
Kegan Dougal 6f6861a11d Swaggerify the createRoom API 2015-10-14 13:17:51 +01:00
Kegan Dougal 07d7a3fa3a Shuffle pagination section around 2015-10-14 11:03:53 +01:00
Kegan Dougal 7bdb71b1c9 Tweak the syncing section 
Bring together disparate sections to make it more cohesive.
 2015-10-14 10:25:39 +01:00
Kegan Dougal e716e81963 Add dir parameter to pagination. Remove path references 
This section needs a lot of work to not lie.
 2015-10-14 09:58:03 +01:00
Kegan Dougal e561a663d3 Tweaks to intro, start using swagger APIs in the CS API section. 2015-10-13 16:53:27 +01:00
Kegan Dougal 4170dbd5cf Review comments 2015-10-13 11:29:54 +01:00
Kegan Dougal 173d00cea0 Review comments 2015-10-13 11:08:19 +01:00
Daniel Wagner-Hall 2502ca7ac6 Merge branch 'master' into daniel/threepidinvites-2 
Conflicts:
	specification/targets.yaml
 2015-10-12 18:11:01 +01:00
Daniel Wagner-Hall 4a1fb74897 Review comments 2015-10-12 18:08:51 +01:00
Kegan Dougal 8f5c796884 Linkify 'pushers' 2015-10-12 17:50:46 +01:00
Kegan Dougal e378de8379 Shuffle history visibility module to be in the module format 2015-10-09 11:04:11 +01:00
Kegan Dougal f2a6950cc3 Minor tweaks; allow objects without props/parents if a title is set 
This allows us to do things like {Tweaks} where Tweaks is defined somewhere
else.
 2015-10-08 16:21:26 +01:00
Daniel Wagner-Hall dc3c02aff5 Review comments 2015-10-08 10:08:38 -05:00
Daniel Wagner-Hall 21a40b317d Merge branch 'master' into daniel/threepidinvites-2 2015-10-08 09:41:17 -05:00
Kegan Dougal 9c95ee5c1f Modify wording and formatting 2015-10-08 15:36:03 +01:00
Kegan Dougal 31ae4b3859 Swaggerify push notification API 
Edit units.py to support nested JSON request keys
 2015-10-08 13:08:21 +01:00
Kegan Dougal a9618a981b Swaggerify the /enabled endpoint 2015-10-08 11:16:42 +01:00
Kegan Dougal 56ce432399 Get profile tag keys displaying correctly. 2015-10-08 10:14:05 +01:00
Kegan Dougal db25276856 Start adding in push definitions 
This is going to be painful to represent due to how the push API allows
mixed types (strings or objects) and mixed top-level keys ("content" rule kind
allowing "pattern" as a top-level key). We may wish to re-visit the design
of this API for v2.
 2015-10-07 17:44:05 +01:00
Kegan Dougal c5edc60c4c Add push YAML for pushers endpoint. 
Also display "required" text on required JSON body request params. Also
increase the size of the request param column to support longer param names
present in the pushers API.
 2015-10-07 16:01:36 +01:00
Kegan Dougal d3ed517ebf Finish laying out rough sections 2015-10-07 14:14:15 +01:00
Kegan Dougal a7400508c6 Define module titles from the template 2015-10-07 14:07:36 +01:00
Kegan Dougal 319ba8f404 Combine push files into one 
We can fork it out again if it makes sense, but certainly 2/3 of the files
were very small and it just adds more complexity when refactoring.
 2015-10-07 14:00:16 +01:00
Kegan Dougal 91ca36509b Flesh out IM module 2015-10-07 11:51:49 +01:00
Kegan Dougal 656bee78c4 Merge branch 'master' into module-im 2015-10-07 10:46:39 +01:00
Matthew Hodgson 7ae2573113 fix barefaced lie regarding the passivity of ASes 2015-10-06 14:13:40 -05:00
Matthew Hodgson 39faccb00d CS API is not just v1 surely 2015-10-06 09:38:46 -05:00
Kegan Dougal 8e5c832ff9 Flesh out more of the IM module 2015-10-05 13:45:23 +01:00
Kegan Dougal 47cf958b54 Merge branch 'master' into module-im 2015-10-05 10:16:44 +01:00
Erik Johnston 3b4c3522e6 Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/disable_federation 2015-10-05 09:17:28 +01:00
Kegsay 8c092e3d11 Merge pull request #74 from matrix-org/module-presence 
Presence module
 2015-10-02 16:24:53 +01:00
Kegan Dougal 417c5b53c4 Remove duplicate sentences from merge conflicts 2015-10-02 16:24:33 +01:00
Daniel Wagner-Hall b29fdebec2 Give example of verification dance 2015-10-02 09:14:31 -05:00
Kegan Dougal 458383585f Stub sections 2015-10-02 15:03:55 +01:00
Kegsay ead79614ff Merge pull request #78 from matrix-org/module-typing2 
Typing module
 2015-10-02 14:36:30 +01:00
Daniel Wagner-Hall 9d8dc7971d Review comments 2015-10-02 08:33:12 -05:00
Kegsay 68df99409a Merge pull request #83 from matrix-org/module-content-repo 
Content Repo Module
 2015-10-02 11:27:41 +01:00
Erik Johnston ccdd376f30 Merge pull request #63 from matrix-org/erikj/room_create_preset 
Update the room creation API spec to include new keys: 'preset' and 'initial_state'
 2015-10-02 11:13:06 +01:00
Kegan Dougal 09ac367847 Merge branch 'master' into module-content-repo 
Conflicts:
	templating/matrix_templates/units.py
 2015-10-02 10:46:46 +01:00
Kegan Dougal 4dabcd112e Remove redundant info now we have the http api template. Minor tweaks to display of schema with no names but a type 2015-10-02 10:44:50 +01:00
Erik Johnston 912a8ca760 Be more explicit about keys that are clobbered 2015-10-02 10:30:45 +01:00
Erik Johnston dbc72c43ac s/private_chat_shared_power/trusted_private_chat/ 2015-10-02 10:28:29 +01:00
Daniel Wagner-Hall af7d2ca9fc Update 3pid invite spec 
This takes into account:
 1) That finding the existing servers of a room is hard
 2) Federation
 2015-10-01 22:19:11 -05:00
Kegan Dougal 87b6dd845e Flesh out content repo; modify templating to support headers 
Edit content-repo.yaml to include examples and headers.
Restructure content module to conform to the module template.
Adjust the HTTP API template to give 1 more char to the response
param to fit "Content-Disposition" correctly.
Edit the templating system to support displaying enums for
swagger APIs (before it was just JSON schema). Also add support
for introspecting headers from swagger. Finally, replace - with
_ when forming the {{ template_var }} else things whine.
 2015-10-01 17:55:16 +01:00
Kegsay 8aad238cda Merge pull request #80 from matrix-org/module-receipts 
Receipts module
 2015-10-01 17:33:38 +01:00
Kegan Dougal da2be7eae4 Merge branch 'master' into module-voip 
Conflicts:
	specification/modules/voip_events.rst
 2015-10-01 15:48:42 +01:00
Kegan Dougal 1520f3647f Merge branch 'master' into module-typing2 
Conflicts:
	specification/modules/typing_notifications.rst
 2015-10-01 15:47:46 +01:00
Kegan Dougal cc6f256b24 Merge branch 'master' into module-presence 
Conflicts:
	specification/modules/presence.rst
 2015-10-01 15:46:52 +01:00
Kegan Dougal 6000887201 Merge branch 'master' into module-receipts 
Conflicts:
	specification/modules/receipts.rst
 2015-10-01 15:44:53 +01:00
Kegan Dougal c972dad8b3 Flesh out receipts module. Add receipts swagger 
Add templating support for v2 apis.
 2015-10-01 15:41:54 +01:00
Kegsay 4a7a682c0f Merge pull request #65 from matrix-org/spec-feature-profiles 
Spec feature profiles
 2015-10-01 12:16:30 +01:00
Kegan Dougal 365a9076b9 Add nested dict template support; Add x-pattern 
For cases where event schema specify `patternProperties` it would be nice
to give that pattern a "human-readable" form rather than a raw regex. This
is now supported by specifying `x-pattern` in the value part of the specified
pattern e.g. `patternProperties:{ "^.*":{ x-pattern: "$THING", ... } }`

Templating had limited record type descriptions limited to value primitives
e.g. `{string: integer}`. It now supports inspecting the values recursively
if the value is `object`.

Updated `m.receipt` to take both these points into account to make it read
better. Tweak receipt module text.
 2015-10-01 12:11:26 +01:00
Kegan Dougal 3b73b07bab Clarifications that room invites are m.call.invites not actual invites 2015-10-01 11:11:08 +01:00
Kegan Dougal e82661413e Add /turnServer endpoint 2015-10-01 11:04:42 +01:00
Kegan Dougal d092b22848 Rename to 'Managing history visibility' 2015-10-01 09:23:08 +01:00
Kegan Dougal 6c3e70d272 Start fleshing out voip module 2015-09-30 17:32:44 +01:00
Kegan Dougal 91b6347f74 Explain what 'embedded' clients are 2015-09-30 16:48:47 +01:00
Kegan Dougal be9402b66f Move feature profiles section to modules as a sub-section 2015-09-30 16:43:09 +01:00
Kegan Dougal 0320e8cef3 Table tweaks from PR 2015-09-30 16:41:47 +01:00
Kegan Dougal 097dc50180 Minor tweaks 2015-09-30 15:51:20 +01:00
Kegan Dougal a82f2ad4ac Flesh out typing module 2015-09-30 15:51:12 +01:00
Kegan Dougal 2b7e02c080 Add sections for typing. Add swagger, JSON schema and example m.typing event 2015-09-30 15:51:04 +01:00
Kegan Dougal 52f6496cf0 Merge branch 'master' into module-presence 2015-09-30 10:56:17 +01:00
Kegan Dougal 4e1e82f995 Fix paragraph CSS and adjust where paragraphs are in the RST 
The CSS for `nature.css` was such that it was preventing `p` tags from
having sufficient vertical whitespace. This meant that you couldn't insert
any kind of spacing between lengthy sections (they just appeared as new lines).

This PR fixes this so you can actually have some whitespace between paragraphs.
As a result of this change, some parts of the spec appeared to have too much
whitespace. These were often sections which shouldn't have begun a new
paragraph anyway (e.g. a single sentence being an entire paragraph, `TODO`
blocks resulting in new paragraphs). This PR fixes the most offending areas
where we shouldn't have been inserting new paragraphs.
 2015-09-30 10:43:02 +01:00
Kegan Dougal 069e4e39f4 Move presence specific sections from intro to presence module 2015-09-30 10:22:51 +01:00
Erik Johnston 73b4090f52 Add private_chat_shared_power 2015-09-30 10:22:12 +01:00
Kegan Dougal 0a04672d76 Start converting the presence module. Add Rationale admonition. 2015-09-29 17:57:44 +01:00
Kegan Dougal cdf9f011e9 Add room history visibility as a module. 2015-09-29 16:33:34 +01:00
Kegan Dougal 82c27884ba Make E2E optional 2015-09-29 16:29:16 +01:00
Erik Johnston 83b9497664 Add context and example 2015-09-29 16:21:10 +01:00
Kegsay c96f02c2b0 Merge pull request #69 from matrix-org/erikj/login_token 
m.login.token
 2015-09-29 13:26:29 +01:00
Erik Johnston 6e6bc8a5a9 Mandate macaroon 2015-09-28 14:51:44 +01:00
Erik Johnston ce53a17180 Add txn_id rationale 2015-09-28 14:51:10 +01:00
Erik Johnston 4776e0c04c Add creation_content key 2015-09-28 14:49:55 +01:00
Kegan Dougal 5abea1f2bc Minor tweaks 2015-09-28 14:07:34 +01:00
Kegan Dougal 70518ae655 Clarify template suffixes 2015-09-28 14:03:54 +01:00
Kegan Dougal 643468e914 Mention swagger. Clarify how event type template vars are formed. 2015-09-28 14:01:54 +01:00
Kegan Dougal c2fc1a2fb1 Add basic module template. 
This has the core sections for events/server/client/security.
 2015-09-28 13:41:31 +01:00
Kegan Dougal db8f3c0d59 Desktop clients should have a GUI 2015-09-28 13:11:34 +01:00
Erik Johnston 97154cc6b2 s/nonce/txn_id/ 2015-09-28 13:09:54 +01:00
Erik Johnston 4c9f524cab Neaten things up 2015-09-28 09:32:03 +01:00
Erik Johnston 317c2f20d3 Draft login token spec 2015-09-28 09:29:35 +01:00
Kegan Dougal 510553ee00 Remove smurf suffixes. Add anchor for feature profiles. 2015-09-25 15:29:33 +01:00
Kegan Dougal 9fac152d32 Explain what the clients are and the column reference 2015-09-25 15:26:58 +01:00
Kegan Dougal c6375ed3d1 Flesh out feature profiles section 
Add table detailing the profiles. Add anchors to link through to each module
following a well-defined format (rather than the name of the module section).
Allow UTF-8 in the spec.
 2015-09-25 15:09:15 +01:00
Erik Johnston 18dc7784df Mention precedence 2015-09-25 14:34:06 +01:00
Erik Johnston 078dd0165f Update the room creation API spec to include new keys: 'preset' and 'initial_state' 2015-09-25 11:58:47 +01:00
Kegan Dougal 1da64db302 Use relative depths for groups instead of absolute ones 
This means the group can be agnostic to how deeply nested it is,
improving reusability of groups.
 2015-09-23 14:29:37 +01:00
Kegan Dougal 29bae15790 Fix typo 2015-09-23 11:30:07 +01:00
Kegan Dougal 5115346297 Add instant_messaging module; modify batesian section rules 
Previously, all `m.room.*` events were wodged into `{{room_events}}` which
isn't great when you want to pull specific ones out. Batesian had a 1:1
mapping of `render_foo()` to a section `{{foo}}`, and having to constantly
add functions for new types is a PITA. Batesian now supports returning a
`dict` instead of a section `string` where the keys are the `{{foo}}` and
the value is what will be inserted. Also add conflicting section key checks
to avoid multiple definitions of the same `{{foo}}`. Define dicts for
event schemata and swagger HTTP APIs.

Using this new feature, split out the instant messaging stuff from the events
section, and replace `{{room_events}}` with a list of specific events e.g.
`{{m_room_member_event}}`.
 2015-09-23 10:48:49 +01:00
Kegan Dougal 5b134119bd Add presence module; fix relative title bug 
If a relative title appeared after an HTTP API table, it
would insert the wrong level because it thought that part
of the table was a title.
 2015-09-23 09:59:54 +01:00
Kegan Dougal b49cb57fe5 Move events sections to CS API 2015-09-22 17:32:31 +01:00
Kegan Dougal 16693a644a Various review fixes 2015-09-22 16:59:49 +01:00
Kegan Dougal b0eb985523 Merge branch 'master' into spec-restructure-modules 2015-09-22 16:04:41 +01:00
Kegan Dougal 0c0ac3e814 Fix common event fields template to use subtitle char 2015-09-22 14:07:23 +01:00
Kegan Dougal e8cdfcbba2 Rename spec files to not have numbers everywhere; update targets.yaml 2015-09-22 14:01:55 +01:00
Kegan Dougal f71763b0d3 Implement relative title styles 
Templates don't know at what level they will be inserted. Previously, we
hard-coded the title style which is not compatible with the build target
system. Define a set of styles which will be replaced by the gendoc script
when it encounters them:
 '<' : Make this title a sub-heading
 '/' : Make this title a heading at the same level
 '>' : Make this title a super-heading

The build target system is now basically complete and functioning.
 2015-09-22 13:08:15 +01:00
Kegan Dougal 067363c629 Get the desired title levels right; print out the actual level used to stdout 2015-09-21 17:21:08 +01:00
Kegan Dougal 8590cc84b5 Process and extract targets in gendoc.py 2015-09-21 15:33:28 +01:00
Kegan Dougal 568982ee2e Represent nested deps in targets.yaml along with title styles 
This will allow us to programatically position .rst snippets *anywhere*
which will for once and for all remove the horrid title level mismatch bugs.

We require this in order to allow people to re-shuffle the spec without
having to adjust the spec itself (e.g. 2 targets with different levels of
nesting).
 2015-09-21 14:49:54 +01:00
Kegan Dougal 703f913a47 Add a 'targets.yaml' files in /specification 
We're well beyond the point now where a simple `cat` of .rst files to "build"
the spec is practical. We may want to slice and dice the spec in different
ways to address various cross-cutting concerns. To this end, there is now a
'targets' file which contains the "build targets" for the spec, which contains
the sorting order for the .rst files. For now, we just have a single
target: 'main'.
 2015-09-21 14:31:57 +01:00
Kegan Dougal f520ac9d82 Create a modules folder to group together similar parts of the spec 2015-09-21 14:25:52 +01:00
Kegan Dougal c77ef1a2cc Add stub files feature_profiles and modules 2015-09-21 14:17:31 +01:00
Kegan Dougal f2c952ec58 Reshuffle spec into sections roughly right as per PR #52 2015-09-21 14:13:18 +01:00
Mark Haines f33c0846c3 Merge remote-tracking branch 'origin/master' into markjh/document_v1_rooms_api 2015-09-18 17:38:03 +01:00
Kegan Dougal 1f6b12b3e8 Modify and enforce the file format/structure used 
Convert the file format to be of the form ##_##_something.rst where the
first ## is the top-level section number and the second ## is the
second-level section number, e.g. 07_01_push_cs_api.rst means
Section 7.1 - This is now enforced in gendoc.py along with the title line
style that should be used (= for top-level, - for 2nd level) which will
give helpful suggestions if you trip up. This feels much more intuitive
now looking in /specification
 2015-09-18 11:43:53 +01:00
Kegan Dougal 9ed39665c8 PR feedback 2015-09-18 11:09:04 +01:00
Kegan Dougal 8e7b33ac99 Fix more typos/spelling errors 2015-09-18 09:40:53 +01:00
Kegan Dougal 3f9d183c2a More typo/layout fixes 
Split out identity servers to a separate file
 2015-09-18 09:25:40 +01:00
Kegan Dougal 620d3dcb26 Test commit 2015-09-17 17:51:44 +01:00
Kegan Dougal faa95e172f More formatting fixes; typos; etc 2015-09-17 17:49:57 +01:00
Kegan Dougal af32ec194a Move VoIP events to 22_voip_events 
20_events is a huge as it is, this makes it easier to find what section
you actually want when editing.
 2015-09-17 16:38:58 +01:00
Kegan Dougal 5b59c67510 Minor formatting fixes. Fix state event templating. 2015-09-17 16:34:20 +01:00
Mark Haines 7eb8b4fde2 Add new-style docs for the APIs for getting events for a room 2015-09-15 15:52:36 +01:00
Daniel Wagner-Hall 59a4e84361 s/registration/login/ 2015-09-14 17:10:46 +01:00
Daniel Wagner-Hall b8e2ac5c1b Swaggerify /login 2015-09-14 13:49:27 +01:00
Kegsay e788f565f8 Merge pull request #36 from matrix-org/daniel/threepidinvites 
Swagger /room/{roomId}/invite
 2015-09-11 11:59:21 +01:00
Kegsay 3011823c51 Merge pull request #27 from matrix-org/receipts 
Document receipts
 2015-09-10 16:18:19 +01:00
Daniel Wagner-Hall 2797fac3aa Swagger /room/{roomId}/invite 
This is a transcription of the current spec, with nothing new or
controversial in it.
 2015-09-09 17:55:40 +01:00
Daniel Wagner-Hall 04b2b2588f Fix up formatting and typos 2015-09-09 13:18:23 +01:00
Daniel Wagner-Hall d53943c8c2 Spec /room/{roomId}/join 
This is just replacing the existing spec with a swagger version.

Subsequent pull requests will add 3pid join to this, as well as specing
the invite, leave, ban, and kick endpoints.
 2015-09-08 16:35:08 +01:00
Erik Johnston 80bb51d9bb Make it clearer 2015-09-04 11:21:14 +01:00
Erik Johnston 4b24b887c7 Document m.room.history_visibility 2015-09-01 11:53:30 +01:00
Erik Johnston 83dfc2bf61 Fix some mistakes/typos 2015-08-28 15:01:02 +01:00
Erik Johnston 0dc22e7217 Document receipts 2015-08-28 14:50:31 +01:00
Paul "LeoNerd" Evans 49c52a96a7 Rename 'perspective server' to 'notary server' as that's what the Perspectives Project calls them too 2015-08-05 11:35:48 +01:00
Kegsay 880bf20403 Merge pull request #21 from matrix-org/paul/fixes 
Three small fixes
 2015-08-05 11:29:46 +01:00
Mark Haines 7d805f105e Mention that Olm uses AES in CBC mode 2015-08-04 15:08:52 +01:00
Mark Haines 88176ef148 Add notes on algorithm naming. Fix some typos 2015-08-04 15:05:51 +01:00
Paul "LeoNerd" Evans c6f2f711de Mention AAAA as well as A records; remark on default port 8448 for no-SRV fallback 2015-07-31 18:05:33 +01:00
Mark Haines d06580a481 Spelling 2015-07-24 16:09:14 +01:00
Mark Haines e1f201f9e6 Add description of the olm type and body JSON keys 2015-07-24 16:07:03 +01:00
Mark Haines c83e8480e8 Fix JSON syntax 2015-07-24 15:55:21 +01:00
Mark Haines 6597aaa448 Start describing the plaintext payload format for encrypted messages, add the exact URLs used for key queries from clients and for key queries for federation 2015-07-24 11:21:14 +01:00
Mark Haines 41d204e72c Name the key 'ciphertext' rather than 'ciphertexts' 2015-07-24 09:43:46 +01:00
Mark Haines 6f69707c71 Update e2e spec: Group ciphertext by device key rather than device id, add return to docs for /keys/upload, Use "m.room.encrypted" for now, rather than trying to add an encrypted content to arbitrary event types 2015-07-17 19:30:36 +01:00
Mark Haines 42ad1f8612 Add a link to signing JSON section of the spec. Fixup the markup a bit 2015-07-14 09:38:08 +01:00
Mark Haines 01927cee9b Rename "take" to "claim". Hyphenate "one-time". 2015-07-14 09:21:25 +01:00
Mark Haines 36e035c79e Add some specification for end-to-end 2015-07-13 19:31:11 +01:00
Matthew Hodgson f08588bf7e typo 2015-07-09 23:17:38 +01:00
Paul "LeoNerd" Evans 5f391b5617 Also document the directory server federation API 2015-07-09 20:28:48 +01:00
Paul "LeoNerd" Evans fc1e01f373 Add a small note about the meaning of the 'target' field 2015-07-09 19:52:34 +01:00
Paul "LeoNerd" Evans af1616ba9a Merge branch 'master' into paul/fixes 2015-07-09 19:52:03 +01:00
Paul "LeoNerd" Evans 28894ac1b7 Bugfix to embedded sign_json() python code 2015-07-03 20:11:27 +01:00
Paul "LeoNerd" Evans 9b046cbc04 Tiny fix to embedded YAML fragment 2015-06-08 18:21:11 +01:00
Kegan Dougal e572cc662a Restructure the first few sections. 
Remove unecessary sections; put presnece/profile sections on the right level.
Move Living Standard warning to the top of the Introduction section.
 2015-06-02 16:27:52 +01:00
Kegan Dougal 71e200a063 Remove version section. 2015-06-02 16:12:23 +01:00
Kegan Dougal e10859a887 Replace presence API with new template. 2015-06-02 16:01:26 +01:00
Kegan Dougal ec631c60d4 Add link to github commit for the spec as per request. 2015-06-02 13:48:52 +01:00
Kegan Dougal bb9537b824 Add a CHANGELOG. Modify table CSS. 
Hook up templating system to read the CHANGELOG for version and changelog info.
Modified nature.css to make it clearer on table headings/sub-headings. Use the
full _matrix/client path on title links to make it clear it is for v1.
 2015-06-01 17:48:16 +01:00
Kegan Dougal f134728268 Link to msgtypes from the description of m.room.message. 2015-05-28 11:57:44 +01:00
Kegan Dougal 51df65bb49 Remove old power level references. Link to m.room.power_levels. 2015-05-28 11:30:48 +01:00
Kegan Dougal ac7ccfa622 Add {{presence_events}}. Factor out common code in MatrixSections. 2015-05-28 10:45:00 +01:00
Kegan Dougal 6f330bd879 Gut the old msgtypes section and replace with {{msgtype_events}} 2015-05-27 16:42:01 +01:00
Kegan Dougal f5059057b3 Update AS API docs (wording/layout tweaks, rationale). 2015-05-27 11:42:51 +01:00
Kegan Dougal 9d532f30e8 Add {{voip_events}}. Add more info on sections when asked via build.py -s 2015-05-26 17:32:51 +01:00
Kegan Dougal 89083b3a86 Add {{spec_version}}. Update build.py module docs. 2015-05-26 17:09:30 +01:00
Kegan Dougal 96671ce833 Use the templating system to set {{git_version}}. Restructure sections code. 
Restructured the sections code to be slightly more encapsulated than before.
This will be expanded to more clearly separate the templating system from
the specific implementation of the spec templates.
 2015-05-26 14:33:32 +01:00
Kegan Dougal ed4ce6950c Template up common event fields from the 'core' json schema file. 2015-05-21 15:51:23 +01:00
Kegan Dougal 02c44a889e Remove stuff from 20_events.rst and replace with {{room_events}}. Update gendoc to call build.py for template vars. 2015-05-20 15:40:06 +01:00
Matthew Hodgson e729a9e425 Merge pull request #16 from matrix-org/key_v2_fixes 
Add minimum_valid_until_ts to key/v2 API
 2015-05-20 12:55:02 +01:00
Matthew Hodgson fa1ec93c78 typo 2015-05-09 14:53:48 +01:00
Matthew Hodgson 39b3de1df3 remove AS register/unregister APIs from the spec for now, but keep the useful info intact 2015-05-09 14:49:16 +01:00
Erik Johnston 580b4a1787 Merge pull request #15 from matrix-org/csauth 
Document CS API V2 auth changes and new APIs.
 2015-05-07 17:55:51 +01:00
Mark Haines 9752dc399e Update 30_server_server_api.rst 
Missing '$'
 2015-04-28 17:49:33 +01:00
Mark Haines 9bfbbce0f4 Update 30_server_server_api.rst 
Use a query parameter for minimum_valid_until_ts for the GET version of the query api.
 2015-04-28 17:47:16 +01:00
Mark Haines cdcaf69fb5 Update 30_server_server_api.rst 2015-04-28 17:39:03 +01:00
David Baker deb17914ca Link syntax 2015-04-27 13:21:22 +01:00
David Baker 199bb87ffa Add link to v1 docs. 2015-04-27 13:19:47 +01:00
David Baker 3343b7f84d Clarify n-factor auth and add the diagram back in as an example 2015-04-24 13:42:02 +01:00
David Baker e7d334c5cd Kill all camels 2015-04-24 13:32:36 +01:00
David Baker 233522b612 Fix typo 2015-04-24 11:01:40 +01:00
David Baker a52819ba69 Clarify dummy auth 2015-04-24 10:20:57 +01:00
David Baker fa8d8a9f95 Remove spurious array in error example 2015-04-24 09:57:16 +01:00
David Baker cfbc58c4fb Forgot bind_email param on register. 2015-04-23 22:44:39 +01:00
Matthew Hodgson 52692931d7 fix typos 2015-04-23 22:42:10 +01:00
David Baker e52146e47f V2PREFIX 2015-04-23 22:34:33 +01:00
David Baker dd12d901af Oops: missed recaptcha. Also make list in the same order as the details. 2015-04-23 22:31:54 +01:00
David Baker b71aaddad0 Try & fix RST errors 2015-04-23 18:39:38 +01:00
David Baker c583bf9570 wrong title level 2015-04-23 18:33:24 +01:00