Commit Graph

442 Commits (52f5e73a3941a74850921243d7283ab5d60436c8)

Author SHA1 Message Date
Kitsune Ral 989d7ff192 Remove extended text about life without transaction IDs
Signed-off-by: Kitsune Ral <Kitsune-Ral@users.sf.net>
5 years ago
Anatoly Sablin 2de7ef9a3d #1865 Add the m.push_rules schema. 5 years ago
Travis Ralston 22188ebfeb Further clarify why membership events are not to be transferred 5 years ago
Travis Ralston f058a0f40a also power levels 5 years ago
Travis Ralston ef13aef8c3 Clarify the recommendations for "transferable state"
Fixes https://github.com/matrix-org/matrix-doc/issues/1843
5 years ago
Aaron Raimist fe7f582233
Fix several spelling mistakes
Signed-off-by: Aaron Raimist <aaron@raim.ist>
6 years ago
Neil Johnson c09fa6845e
Update presence.rst 6 years ago
Neil Johnson bf2b6e6daa remove references to presence lists 6 years ago
Travis Ralston 052d68d83d
Merge pull request #1791 from matrix-org/travis/spec/rver-upgrades
Add room version upgrades
6 years ago
Travis Ralston 0dfc64a9f4 Improve wording 6 years ago
Travis Ralston 2457438f1e Encourage servers to transfer whatever they can while being open-ended 6 years ago
Travis Ralston 4e0533a5f3 Soften UX requirements 6 years ago
Travis Ralston 82ee3a6035 Adjust wording for SSO introduction 6 years ago
Travis Ralston aeb524ef89 Remove CAS login and reference it against r0.4.0
The SSO module should cover what CAS provides, and r0.4.0 is good as a reference for how CAS could be implemented without us repeating it here.
6 years ago
Travis Ralston b85f7bb248 Add room version upgrades
Implements https://github.com/matrix-org/matrix-doc/issues/1501
6 years ago
Travis Ralston d6c33ea0a5 Make CAS a subset of SSO 6 years ago
Travis Ralston 3e7a5f5ea4 Initial draft for SSO support 6 years ago
Travis Ralston 35de43de61
Merge pull request #1743 from matrix-org/dbkr/add_sandbox_to_csp
Add 'sandbox' to recommended CSP header
6 years ago
J. Ryan Stinnett d197a5761f Clarify encrypted push rules
Fix `.m.rule.encrypted_room_one_to_one` by moving a condition to the right block
of the rule.

Fix `.m.rule.encrypted` to state that it applies to group rooms.

Signed-off-by: J. Ryan Stinnett <jryans@gmail.com>
6 years ago
David Baker e318286404 Add 'sandbox' to recommended CSP header 6 years ago
Hubert Chathi 189725659a clarifications and formatting fixes 6 years ago
Hubert Chathi 46fde9723c document megolm session export format 6 years ago
Konstantinos Sideris 192a6c2ab9 Use example.org on examples instead of domain.com which is a real domain
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
6 years ago
Travis Ralston 218b86d6e8 Hopefully the last one 6 years ago
Travis Ralston 7d34995ece It's actually an "identity server implementing the Identity Service API"
Also add a note about appservices being special.
6 years ago
Travis Ralston 7ac76fa27c Actually we're going with "identity server" afterall 6 years ago
Travis Ralston ec248b436f Identity Service is lowercase 6 years ago
Travis Ralston cc0badaaa1 Fix all naming cases of "identity service"
Fixes https://github.com/matrix-org/matrix-doc/issues/1396

Includes some "homeserver" fixes too. This commit does not include historical documentation or notes.
6 years ago
Travis Ralston 108c623557
Merge pull request #1635 from turt2live/travis/c2s/read-markers
Add read markers
6 years ago
Hubert Chathi c0dd7e0025
Merge pull request #1420 from Zil0/encrypted_attach
Document encrypted attachments
6 years ago
Travis Ralston 4b9fb99644 Take out unhelpful example 6 years ago
Travis Ralston f6d9e53f5c Clarify that homeserver must reject clients from setting m.fully_read 6 years ago
Travis Ralston 2e8151999e Clarify that read markers are fully read markers 6 years ago
Hubert Chathi f1f32d3a15 add more clarifications 6 years ago
Travis Ralston 679ddabb53 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/read-markers 6 years ago
Travis Ralston 567843e043 Add additional clarity to how rich replies are structured and used 6 years ago
Hubert Chathi e3daf10bb9 refactor encrypted file schema as "Extension to m.message" 6 years ago
Travis Ralston 9004be7bda Merge remote matrix-org/master 6 years ago
Travis Ralston f72c821be4
Merge pull request #1619 from turt2live/travis/c2s/local-echo
Reference that transaction IDs may be used to echo
6 years ago
Travis Ralston 136ba15eb2
Merge pull request #1605 from turt2live/travis/c2s/clarify-html-again
Mention that clients should not be producing invalid HTML
6 years ago
Travis Ralston 38ae166e9d
Merge pull request #1505 from turt2live/travis/general/3pid_invite
Clarify how third party invites work
6 years ago
Travis Ralston afa16f1e4e
Merge pull request #1606 from turt2live/travis/c2s/room-tags
Update the room tagging documentation
6 years ago
Travis Ralston c127eed7e7
Merge pull request #1600 from turt2live/travis/c2s/media-csp
Specify the minimum CSP for media
6 years ago
Travis Ralston f923d08078 Add read markers
This is the spec for https://github.com/matrix-org/matrix-doc/issues/910

Fixes https://github.com/matrix-org/matrix-doc/issues/910

Some reverse engineering was required to work out the complete details as to how this works. In particular, the 405 for setting account data and the behaviour of m.read.

References:
* 405 for account data: d69decd5c7/synapse/rest/client/v2_alpha/account_data.py (L85-L90)
* m.read behaviour: d69decd5c7/synapse/rest/client/v2_alpha/read_marker.py (L45-L52)
6 years ago
Travis Ralston d57b977a55 Merge branch 'm-master' into travis/general/3pid_invite 6 years ago
Travis Ralston 1f6499d563 Fix typo 6 years ago
Travis Ralston 356626845c Remove unhelpful arrow from the 3rd party invite sequence dance
This doesn't add anything in terms of clarity.
6 years ago
Travis Ralston b8f2c721dc Clarify which attributes should be valid 6 years ago
Travis Ralston 2d18b0d2d8 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/clarify-html-again 6 years ago
Travis Ralston 440841d1ff Recommend a CSP rather than require it. 6 years ago
Travis Ralston bd93481013 Reference that transaction IDs may be used to echo
Fixes https://github.com/matrix-org/matrix-doc/issues/1462
6 years ago
Travis Ralston 78487a01ec Remove references to initialSync from account data and receipts module
Fixes https://github.com/matrix-org/matrix-doc/issues/695

Note: This commit leaves the /join endpoints alone because they say "and /sync" rather than just initialSync
6 years ago
Travis Ralston e227095fb4 Add rich replies
Fixes https://github.com/matrix-org/matrix-doc/issues/1234

The notable parts of this are:
* The titles go to insane levels. Rich replies are fairly complex and need some splitting apart to be understandable.
* The allowed HTML tags now have an exception for `<mx-reply>`

Please note that the event example is intended to be fixed by a PR that fixes all event examples.
6 years ago
Hubert Chathi 4230e375fa
Merge pull request #1465 from Zil0/key_sharing
Document key sharing events
6 years ago
Hubert Chathi 0130620cc1
Merge pull request #1596 from uhoreg/e2e_sessions
specify how to handle multiple olm sessions with the same device
6 years ago
Travis Ralston 2ab2f91088 Merge remote-tracking branch 'matrix-org/master' into travis/releases/push-gateway/r0.1.0 6 years ago
Travis Ralston c03f2f8d79 Minor touchups to the room tagging API
Fixes some of https://github.com/matrix-org/matrix-doc/issues/1565
6 years ago
Travis Ralston 2234e0b097 Mention that clients should not be producing invalid HTML
Fixes https://github.com/matrix-org/matrix-doc/issues/1595
6 years ago
Matthew Hodgson 8e88d82a4b fix typo in anchor. fixes #1603 6 years ago
Travis Ralston ec20c43220 Specify the minimum CSP for media
Fixes https://github.com/matrix-org/matrix-doc/issues/1066
6 years ago
Travis Ralston 39ef845a53
Merge pull request #1547 from turt2live/travis/c2s/pills
Document how mentions (pills) work
6 years ago
Hubert Chathi 688c8ebcd3 specify how to handle multiple olm sessions with the same device 6 years ago
Valentin Deniaud 28ced3b0a4 fixup! document encrypted attachments 6 years ago
Travis Ralston 72c6fa2aaf More versioned links 6 years ago
Travis Ralston e4f8c23972
Merge pull request #1562 from turt2live/travis/c2s/html-formatting
Define the supported HTML subset for message events
6 years ago
Travis Ralston fa3e9a7609 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/pills 6 years ago
Travis Ralston 4e885c3f77
Merge pull request #1550 from turt2live/travis/general/acls
Server ACLs
6 years ago
Travis Ralston bac0392a2d General clarity for push rule defaults and where to get information
Include moving a roaming condition that was under the wrong rule.
6 years ago
Travis Ralston d7397ccd56 Provide additional rationale for kicking users when they are ACLd 6 years ago
Travis Ralston 76afef79f8 Clarify the rationale and motive for blanket IP banning and port exclusion 6 years ago
Travis Ralston 89daa3c5ce Clarify that clients aren't required to render all the tags
This commit also includes minor clarifications to surrounding text.
6 years ago
Travis Ralston 5bf99aeb34 Add a note that formatted_body is not forever 6 years ago
Travis Ralston c7822cc9a8 Link to the content repo when referencing MXC URIs in images 6 years ago
Travis Ralston d7d28f7e5b Remove nl as a supported HTML tag 6 years ago
Travis Ralston aa294fac06 Define the supported HTML subset for message events
Also clarify that `m.notice` messages can support HTML.

Fixes https://github.com/matrix-org/matrix-doc/issues/1559
Fixes https://github.com/matrix-org/matrix-doc/issues/1560
6 years ago
Travis Ralston 312799ae78 General clarification for mention and how matrix.to URIs are meant to work 6 years ago
Valentin Deniaud b7577ea237 document encrypted attachments
Fix #461.
6 years ago
Valentin Deniaud f6b5aee3e2 explain how to use key sharing events 6 years ago
Travis Ralston ab0be04571 Fix titles 6 years ago
Travis Ralston 7ec3cc4343 General improvements to the push rules module
This commit does a few things:
* Add 3 undocumented push rules to the spec for encrypted events and at-room notifications.
* Require unrecognized conditions to not match, ensuring that future conditions do not cause clients to accidentally notify users.
* Clarify that push rules should be enabled when created.
* Document a new condition required for at-room notifications.

Fixes https://github.com/matrix-org/matrix-doc/issues/1163
Fixes https://github.com/matrix-org/matrix-doc/issues/1034
Fixes https://github.com/matrix-org/matrix-doc/issues/676
Fixes https://github.com/matrix-org/matrix-doc/issues/1033
Relates to https://github.com/matrix-org/matrix-doc/issues/1101
6 years ago
Travis Ralston ef41b5c2bf Server ACLs
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1383
6 years ago
Travis Ralston 9835c98544 Document how mentions (pills) work
Implements the proposal over at https://github.com/matrix-org/matrix-doc/issues/1067

Includes some specification for how matrix.to is structured, and how it is intended to be replaced.
6 years ago
Valentin Deniaud 2d8a321b46 document key sharing and m.room_key_request 6 years ago
Will Hunt fca1c0b7f8
Guests should support /context and /event 6 years ago
Valentin Deniaud 9430f2c7f9 room ID is included in Megolm plaintext, not Olm 6 years ago
Valentin Deniaud 8ba19b51ab complete Olm documentation 6 years ago
Valentin Deniaud b2316ba782 enforce unique namespacing in new algorithms experiments 6 years ago
Valentin Deniaud eb8ea0e85a remove warning pointing at outdated doc 6 years ago
Valentin Deniaud 4e0f107ef7 document changed field behavior in e2e sync extension 6 years ago
Valentin Deniaud 248786681e fix typo 6 years ago
Valentin Deniaud e5005b2d0f document E2E events
This was written by Richard van der Hoff.
6 years ago
Valentin Deniaud 68b78dc5d8 complete Megolm documentation 6 years ago
Valentin Deniaud 669605b24a add Olm missing properties 6 years ago
Valentin Deniaud 76071bae98 explain how to verify sender_key ownership 6 years ago
Valentin Deniaud 8274f91b0b document device verification
This was written by Richard van der Hoff.
6 years ago
Valentin Deniaud a28f243ed7 document left parameter of device_lists in sync response
fix #1171
6 years ago
Valentin Deniaud 10c3307427 document device_one_time_keys_count in /sync/ response
fix #1157
6 years ago
Valentin Deniaud 2686b99080 fix json indent 6 years ago
Valentin Deniaud 07e3de3c61 add megolm messaging algorithm subsection
This was written by Richard van der Hoff.
6 years ago
Valentin Deniaud 33802dbbaf add olm messaging algorithm subsection
This was written by Richard van der Hoff.
6 years ago
Valentin Deniaud e210f8b050 add e2e messaging algorithms section intro
This was written by Richard van der Hoff.
6 years ago
Travis Ralston 4b9922b641
Merge pull request #1494 from turt2live/travis/general/openid
Document OpenID in the client-server and server-server APIs
6 years ago
Travis Ralston de961fb7d6 Improve wording on push gateways 6 years ago
Travis Ralston 6ad71f785e Improve documentation for pushers and push gateways
This fixes a number of formatting issues alongside a few documentation problems:
* The push gateway can actually expect less parameters than previously advertised. This is for user privacy.
* Introduction of the `m.email` pusher for email-capable homeservers.
* Fields not being flagged as required on some endpoints.
* Document the `event_id_only` format

Note: this does not attempt to document push rules, just pushers.

Fixes https://github.com/matrix-org/matrix-doc/issues/1374
Fixes https://github.com/matrix-org/matrix-doc/issues/1087
6 years ago
Travis Ralston 88b35d1be5 Clarify how third party invites work
This adds several diagrams to the Client-Server API about how invites
are handled, including what the server is expected to do. This helps
implementors know what they are supposed to do in the common cases,
and infer where needed to get the more complex cases correct.

Although lacking in some areas, this is how third party invites work
today.

A link to the now-improved client-server documentation for third party
invites has been added to the server-server specification. The existing
server-server specification needed no further changes on the subject.

Fixes https://github.com/matrix-org/matrix-doc/issues/1366
6 years ago
Travis Ralston 8ffac01efe Document OpenID in the client-server API
Part of https://github.com/matrix-org/matrix-doc/issues/857

Reference: d69decd5c7/synapse/rest/client/v2_alpha/openid.py (L31-L58)
6 years ago
David Baker 803ef536ba Fix grammar in room tag spec
Have removed the second clause about how the client interprets them:
I was trying to think how to rephrase it but I think in reality it's
probably just redundant.
6 years ago
David Baker 2dc51d416d Ignore stuff in `m.` you don't understand 6 years ago
David Baker f90ed4b77d Make non-namespaced tags verboten 6 years ago
David Baker e4fd088fcc Fix room tags spec 6 years ago
Ben Parsons 07aeaadef9 update links which used to point to docs/spec/intro 6 years ago
Andrew Morgan 291a4dfc76 Third party lookup module. Fix wording 6 years ago
Andrew Morgan 114bcf1a2e Use $ref, clean up, fix errors, AS is now a C-S module. 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
Jason Volk 2a6895e759 Fix typo. 6 years ago
Jason Volk 2802fdea7e Fix typo. 6 years ago
Richard Lewis 8d05f80cec Sticker messages (m.sticker) (#1158) 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
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
Florian Jacob ac861d9b97 Correct CAS spec link
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
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
Travis Ralston 5e7df0e87c Update instant_messaging.rst
Signed-off-by: Travis Ralston <travpc@gmail.com>
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 5537f7a832 Allow guest access to E2E endpoints 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
Mark Haines 7025793ca8 Say that thumbnails should be 'mxc://' 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 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
David Baker c16ba9488f Spec notifs API 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 ebaaa7e3b3 Review feedback
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
8 years ago