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

802 commits

Author SHA1 Message Date
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