Commit Graph

883 Commits (5f06694b6f3dc727ec7942f8e9eae67664984606)

Author SHA1 Message Date
Ben Parsons ffb8037af2 update MSC list 6 years ago
Ben Parsons ee98082a60 update MSC1270 6 years ago
Travis Ralston 8610effad7
Merge branch 'master' into travis/reporting 6 years ago
Ben Parsons 7a44351a34 update following rvdh spec blitz 6 years ago
Ben Parsons 34090b24c4 prepare proposals.py for CI 6 years ago
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>
6 years ago
Ben Parsons c3062b7db6 Include Proposals Page Title, update MSC1256 6 years ago
Ben Parsons 434e2949f9 include #1256 6 years ago
Ben Parsons 8d550d2166 force re-render 6 years ago
Ben Parsons 0b776b0e9c link to proposals page from index 6 years ago
Jason Volk 2a6895e759 Fix typo. 6 years ago
Ben Parsons 663e1a5ebe Update some text 6 years ago
Ben Parsons 9873a2a0ac link from the spec intro page 6 years ago
Ben Parsons 38adc7df06 latest generated proposals 6 years ago
Matthew Hodgson 8440179ecf clarify shepherds and clarify 'greater benefit'
as per https://github.com/matrix-org/matrix-doc/pull/1240#discussion_r188459957
6 years ago
Ben Parsons 4d3c4225b2 include proposal template link 6 years ago
Matthew Hodgson 84524df783 spell out requirements for doc editing 6 years ago
Ben Parsons 73b28612ec updates from feedback on pull 6 years ago
Matthew Hodgson 4c0743ef65 fix wording 6 years ago
Matthew Hodgson 10a8cb3f67 put handwavey timings on state transitions 6 years ago
Matthew Hodgson 4cdb4f105c clarify architecture 6 years ago
Matthew Hodgson 8096bf0039 perms and apostrophes 6 years ago
Matthew Hodgson 3e10a5a24a enter #matrix-spec:matrix.org 6 years ago
Matthew Hodgson 42fd3f34e4 shift stuff from contributing.rst to the new proposals page 6 years ago
Matthew Hodgson 3b736388ce clarify governance 6 years ago
Ben Parsons 3cef79f31d sublist formatting 6 years ago
Matthew Hodgson e27f674fb9 incept dates 6 years ago
Matthew Hodgson 29348c6190 improve wording 6 years ago
Matthew Hodgson 714767c95a explain proposal neutrality 6 years ago
Matthew Hodgson 755c9473fb more tweaks 6 years ago
Matthew Hodgson 07bf61b33b more tweaks 6 years ago
Matthew Hodgson 93681458d6 more tweaks 6 years ago
Matthew Hodgson cb882ba12d more tweaks 6 years ago
Matthew Hodgson 8c469e51cb lots of tweaks to the MSC verbiage 6 years ago
Ben Parsons b8f38b21a7 update introductory text 6 years ago
Ben Parsons 120fa92078 update intro 6 years ago
Ben Parsons 867307af8b new flow 6 years ago
Ben Parsons 866b0b6348 I mostly play with ascii art 6 years ago
Ben Parsons 9e37d15c8f little ascii diagram of process 6 years ago
Ben Parsons e18aa30fd2 start generating new proposals page 6 years ago
Jason Volk 2802fdea7e Fix typo. 6 years ago
Richard Lewis 8d05f80cec Sticker messages (m.sticker) (#1158) 6 years ago
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>
6 years ago
Vyom Sharma 4f5ad35865 fixed minor typo 6 years ago
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>
6 years ago
Travis Ralston d37ed0876f
Merge branch 'master' into travis/m.ignored_user_list 6 years ago
Richard van der Hoff a0dda3cae2
Merge branch 'master' into travis/m.tag 6 years ago
Travis Ralston e862ef60ae Spec ignoring users
Adds https://github.com/matrix-org/matrix-doc/issues/528

Signed-off-by: Travis Ralston <travpc@gmail.com>
6 years ago
Travis Ralston a3f006353c Tag ordering is defined as a number between 0 and 1, not strings
Signed-off-by: Travis Ralston <travpc@gmail.com>
6 years ago
Maxime Dor c8393306d1 Add IS ping endpoint 6 years ago
Richard van der Hoff 3dfa643b8b Fix membership state names
It's called 'join', not 'joined'.
6 years ago
Michael Telatynski 4d90d2b495
fix depr link 6 years ago
Nathan Musoke 7e94cd5a0b
Typo in client-server spec: ether -> either 7 years ago
Richard van der Hoff 73118b6b29
Merge pull request #1096 from t3chguy/user_directory
add user_directory
7 years ago
Michael Telatynski 784adade9b
changes based on Pull Request feedback 7 years ago
Richard van der Hoff 15ca952cc3 remove spurious word 7 years ago
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).
7 years ago
Michael Telatynski 3d8fe6e090
merge profiles with user directory into user data, also fix typo 7 years ago
Michael Telatynski 605510e965
Merge branch 'master' into user_directory 7 years ago
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
7 years ago
Michael Telatynski 97445195f6
add user_directory 7 years ago
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.
7 years ago
Richard van der Hoff 56f878842c Add a warning that state resolution has problems 7 years ago
Richard van der Hoff 5ab9ee6b88 Link to auth rules 7 years ago
Richard van der Hoff 0960229a80 Document the state resolution algorithm
or at least, my understanding of it.
7 years ago
Maxime Dor e8af5622a7 Use proper room event type for redaction 7 years ago
Richard van der Hoff ec1a12d21b
Merge pull request #1080 from maxidor/max/ss/auth_rules
Fix auth rules to allow first PL event
7 years ago
Richard van der Hoff 96d93e11d7
Tweak wording of auth rules slightly 7 years ago
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>
7 years ago
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>
7 years ago
Maxime Dor c4f53f58d7 Fix auth rules to allow first PL event 7 years ago
Richard van der Hoff 52dba5d89a
Merge pull request #1076 from florianjacob/fix-cas-url
Correct CAS spec link
7 years ago
Richard van der Hoff 58a3fa3d60
Merge pull request #1075 from matrix-org/rav/pdu_fields
Improve documentation of Transactions and PDUs
7 years ago
Florian Jacob ac861d9b97 Correct CAS spec link
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
7 years ago
Richard van der Hoff 6a653b742c Document auth_events 7 years ago
Richard van der Hoff 632ba032af Improve Transaction and PDU documentation
Fix a bunch of lies about the fields in these structures.
7 years ago
Marcus Medom Ryding 8a446fa6df Modify event auth rules not to rely on depth
Signed-off-by: Marcus Medom Ryding <mrok4a@gmail.com>
7 years ago
Richard van der Hoff f88185ed89
Merge pull request #1073 from maxidor/max/ss/directory
Document directory query endpoint
7 years ago
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`
7 years ago
Richard van der Hoff 0ce58fdb28 Prepare for next spec dev cycle 7 years ago
Maxime Dor bb50ec2e88 Document directory query endpoint 7 years ago
Richard van der Hoff 9b0bdb799e
Merge pull request #1054 from vberger/patch-2
Specify namespaces for tags
7 years ago
Maxime Dor 1045bc721d Document federation version endpoint 7 years ago
David Baker 14df31458b Attempt to clarify example a little 7 years ago
David Baker 9c5972ffe3 More formatting / grammar 7 years ago
David Baker e12c0b54ff Formatting & grammar 7 years ago
David Baker 4526ff2ea6 Double backticks in rst :/ 7 years ago
David Baker 1e4cba6b55 Don't linkify email addresses in examples 7 years ago
David Baker 3487f5d75a Spell out what we mean by a 3pid
(and consequently rejig all the fixed-width formatting)
7 years ago
David Baker ff85ec055e Move 3pid types down 7 years ago
David Baker 8d557ec9dc Actually this isn't necessary in this section 7 years ago
David Baker e80675c9e9 Link in markdown, not swagger 7 years ago
David Baker b789f61522 Make link more specific 7 years ago
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.
7 years ago
Travis Ralston b1801ea6db Spec /account/whoami
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
Maxime Dor 68e12feec7 Add explicit examples for JSON encoding 7 years ago
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.
7 years ago
Michael Telatynski c2b1b7a10e
mention that we can send tokens via headers 7 years ago
Richard van der Hoff 6b23b7fc0b Merge branch 'client_server/r0.2.0_updates' 7 years ago
Richard van der Hoff b94c4a9f36 Sneaky update to 0.2.0 spec to link unstable
This doesn't count as a spec release, right??
7 years ago
Richard van der Hoff 6282a53ca9 Merge pull request #1032 from matrix-org/rav/mxid_grammar
Indentifier grammar updates
7 years ago
Richard van der Hoff 44fc033624 Fix broken links in the intro 7 years ago
Richard van der Hoff c08e6616c7 Try to make the intro link more obvious
Fixes https://github.com/matrix-org/matrix-doc/issues/1031.
7 years ago
Richard van der Hoff 628e723483 Move the MXID spec to the appendices
Also link to them from the /register API doc.
7 years ago
Richard van der Hoff 0a85fbb4f5 Allow slashes in MXIDs
Because apparently we like slashes now.
7 years ago
Richard van der Hoff 5fee8e54eb Document the event auth rules (#1027)
These are a necessary precursor to state resolution.
7 years ago
Richard van der Hoff c4bcd0a713 Merge pull request #1007 from turt2live/travis/m.room.pinned_events
Add spec for m.room.pinned_events
7 years ago
Travis Ralston 5e7df0e87c Update instant_messaging.rst
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
Richard van der Hoff f1139b5b13 fix inter-spec link 7 years ago
Richard van der Hoff 5d473ced58 Merge pull request #1023 from matrix-org/rav/event_size
Specify max event size more precisely
7 years ago
Richard van der Hoff a8afbfd27d Avoid external link in search swagger 7 years ago
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.
7 years ago
Michael Telatynski bf3b49f13c document joined_members and joined_rooms endpoints (#999) 7 years ago
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.
7 years ago
Brendan Abolivier 6b6a941e36
Phrasing 7 years ago
Brendan Abolivier 8de93147b1
Typo 7 years ago
Brendan Abolivier c71575c94d
Remove useless blank line 7 years ago
Brendan Abolivier 4a99691108
Move link to the bottom of the file 7 years ago
Brendan Abolivier 9d90fa2cae
Specify third-party invites 7 years ago
Brendan Abolivier af961321e9
Specify remote invite 7 years ago
Brendan Abolivier 997e76fcf7
Update JSON body for 3PID onbind requests 7 years ago
David Baker 883767a905 Merge pull request #984 from matrix-org/rav/sync_timeout
Make clear that the /sync timeout is zero by default
7 years ago
Richard van der Hoff 1e3f5683c8 Make clear that the /sync timeout is zero by default 7 years ago
14mRh4X0r 6570a5c6a3 Update link to WHATWG's Living Standard FAQ entry 7 years ago
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
7 years ago
Richard van der Hoff da6938b818 Key management APIs (#894)
Spec the e2e key-management APIs.
7 years ago
Richard van der Hoff 0a6886e73c Fix broken link in spec 7 years ago
David Baker 6296d676c8 Remove unused ID server file 7 years ago
Richard van der Hoff da686ba4eb Specification of unpadded Base64 7 years ago
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
8 years ago
Robert Swain db26877eee server-server api: Fix swapped pdu state update field descriptions
Signed-off-by: Robert Swain <robert.swain@gmail.com>
8 years ago
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>
8 years ago
Richard van der Hoff 5537f7a832 Allow guest access to E2E endpoints 8 years ago
Richard van der Hoff 8a9629167a httpsify the speculator link 8 years ago
Richard van der Hoff 4abdcc6f05 Merge pull request #402 from matrix-org/rav/device_management
Device management API
8 years ago
Richard van der Hoff 461bfdb0d8 Merge branch 'master' into rav/device_management 8 years ago
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
8 years ago
Mark Haines 7025793ca8 Say that thumbnails should be 'mxc://' 8 years ago
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.
8 years ago
Richard van der Hoff a5e12814ef Split appendices up
Split appendices into multiple files
8 years ago
Richard van der Hoff e8915215a2 Merge pull request #405 from matrix-org/dbkr/push_examples_api_path
Fix API path in pushrules examples
8 years ago
Richard van der Hoff 22777970da Fix speculator link
the link to the 'latest version' was broken
8 years ago
David Baker 41f4661d1b Fix API path in pushrules examples 8 years ago
Richard van der Hoff af515012ea Device management API 8 years ago
Richard van der Hoff 9265b03008 Client device doc
Document client devices, and the mods to the login and register apis to support
them.
8 years ago
Richard van der Hoff cbc5774ade JSON key names also use underscores. 8 years ago
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.
8 years ago
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
8 years ago
David Baker 49ee00c361 Use the right path for the identity API 8 years ago
Richard van der Hoff 6c88d698ae uia fallback example: check event origin 8 years ago
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.
8 years ago
Richard van der Hoff 42616f839c Merge pull request #396 from matrix-org/dbkr/notifs_api
Spec notifs API
8 years ago
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
8 years ago
Richard van der Hoff 83b89aa1ce dm: clarify client behaviour 8 years ago
David Baker ed2d364440 consistency 8 years ago
David Baker 96b6fb0129 'In the m.room.member' event 8 years ago
David Baker 301595c071 Linkify account_data API
Also change other links because it turns out the .. isn't part
of the syntax
8 years ago
David Baker 2a987c3369 Linkify endpoints properly 8 years ago
David Baker 2259a00ba2 links 8 years ago
David Baker 3f66ba713c Reference m.room.member section 8 years ago
David Baker e2024e5829 Add note on how to use the account data event 8 years ago
David Baker d791f35007 Remove unnecessary paragraph 8 years ago
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.
8 years ago
Richard van der Hoff a8d35b2409 UI Auth: servers should 401 when a request fails
(ref https://matrix.org/jira/browse/SYN-744)
8 years ago
David Baker c16ba9488f Spec notifs API 8 years ago
Richard van der Hoff 37fb1ceb65 Merge pull request #395 from matrix-org/rav/kill_refresh_tokens
Remove references to refresh tokens and tokenrefresh
8 years ago
David Baker 8e096bdc48 Link to createRoom, not initialsync 8 years ago
David Baker 85bc989c02 pr feedback 8 years ago
David Baker 976d41351e spelling 8 years ago
David Baker d39f662df5 PR feedback 8 years ago
David Baker 203ea99328 Spec m.direct 8 years ago
Richard van der Hoff f4c7fdfd03 Remove references to refresh tokens and tokenrefresh
refresh tokens are dead.
8 years ago
Richard van der Hoff ebaaa7e3b3 Review feedback
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
8 years ago
Richard van der Hoff ccd7bb32d5 Specification for direct-to-device messages 8 years ago
David Baker 9a1db01d92 Clarify `highlight` and `sound` tweaks. 8 years ago
Benjamin Saunders cade909e25 Fix inconsistencies regarding redacted_because
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
Benjamin Saunders 77b668a5dc Fix some obsolete uses of user_id key in events
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
Richard van der Hoff 2fa7aac3be Merge pull request #377 from Ralith/typos
Fix typo
8 years ago
Benjamin Saunders 80bfbbdd33 Fix typo
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
David Baker fd888fcbda Merge pull request #373 from matrix-org/dbkr/contains_display_name_override
Make the display name rule an override rule
8 years ago
David Baker b65b0d049e Make the display name rule an override rule 8 years ago
David Baker 6592646ee9 Add dot prefix to .rule.master
It's a default rule, so it needs a dot
8 years ago
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.
8 years ago
Matthew Hodgson 9cb626982a s/user/username/ typo 8 years ago
Richard van der Hoff 0248afe6ac login with invalid token gives a 403 8 years ago
Richard van der Hoff 1f1dfdd91c More clarifications 8 years ago
Richard van der Hoff ec81b4c9fe More PR feedback
Add a couple of TODO sections
8 years ago
Richard van der Hoff 4b0e546eeb PR feedback
Fix some typos, and clarify several aspects of server behaviour.
8 years ago
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.
8 years ago
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.
8 years ago
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.
8 years ago
Matthew Hodgson c0490f2db2 cosmetics 8 years ago
Richard van der Hoff a64f9bbb63 C-S spec: Fix 'unstable' in link to /context API 8 years ago
Richard van der Hoff b5f9e896ba C-S spec: Fix 'unstable' in link to /context API 8 years ago
Richard van der Hoff a2ab6854ff CS spec: Add r0.2.0 to historical version list 8 years ago
Richard van der Hoff ae489260a1 Merge pull request #359 from matrix-org/rav/mxid_grammar
Define MXID grammar
8 years ago
Richard van der Hoff 72449294bc Moar TODO 8 years ago
Richard van der Hoff a2f1c6a7a6 Add a TODO about defining non-latin login creds 8 years ago
Richard van der Hoff cdd19dca7f fix typos 8 years ago
Richard van der Hoff f942b6e5c1 remove some redundant words 8 years ago