Commit graph

681 commits

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