Erik Johnston
f3a13eed76
Merge pull request #1593 from matrix-org/erikj/auth_events
...
Update rules on which events to add to `auth_events`
6 years ago
Erik Johnston
86891ca7e4
Merge pull request #1625 from matrix-org/erikj/auth_rejections
...
Explain how to handle rejected events
6 years ago
Erik Johnston
d91dc6fbf6
Fixup
6 years ago
Erik Johnston
4d653748d6
Add note back in
6 years ago
Erik Johnston
8e6c8ba59e
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/spec_3pid_ruls
6 years ago
Erik Johnston
a1aedb386a
Actually use proper sentences like a proper adult
6 years ago
Erik Johnston
0adfd1ebb0
Merge pull request #1591 from matrix-org/erikj/fixup_auth_rules
...
Fix up auth rules
6 years ago
Erik Johnston
d63184ebac
Fixup
6 years ago
Erik Johnston
3c53e1910d
Fixup
6 years ago
Erik Johnston
1a45bc4a85
Reword
6 years ago
Erik Johnston
59f86ec8f2
Reindent as RST requires sublists to be three spaces
6 years ago
Erik Johnston
f4706c8889
Require creator field
6 years ago
Erik Johnston
f3aea32a24
Be consistent with 'If..., reject'
6 years ago
Erik Johnston
6c8a45c165
Full stops
6 years ago
Erik Johnston
ebb044674f
Remove duplicated explanation about event rejection
6 years ago
Travis Ralston
d57b40d0cc
Clarify how the client should treat errors
...
This is based on observation and rough interpretation and may need additional review from people.
Fixes https://github.com/matrix-org/matrix-doc/issues/1188
6 years ago
Travis Ralston
e6adf9f6b9
Document known client-server error codes
...
Covers part of https://github.com/matrix-org/matrix-doc/issues/603 (updating all the endpoints is being done as a separate PR/commit).
Reference: 74854a9719/synapse/api/errors.py (L30-L61)
6 years ago
Travis Ralston
caaa688e37
Fix links to client-server spec
6 years ago
Travis Ralston
219b27b182
Merge remote matrix-org/master
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
Richard van der Hoff
0f84c69805
Merge branch 'master' into rav/clarify_event_signing
6 years ago
Travis Ralston
98a445890c
Render a warning if the spec is unstable
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1499
This is done by using magic variables in the RST. The magic variables are generated based on the substitutions available, making them available for use at build-time.
Magic variables were chosen because it allows people to continue working on the spec and release process without having to worry about removing a chunk of text from the top of the file. Originally, this was attempted by using jinja2 if-statements, however the substitutions are replaced *after* the template is executed, so the condition would never match.
The format of the variable is to make the templating happy. Using colons or percent signs results in the templator thinking something else is going on, and then complaining about format.
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
5e6a2c30a2
Comment out the part where identity services can revoke their keys
...
They can't because otherwise 3rd party invites can be rejected by homeservers, as per https://github.com/matrix-org/matrix-doc/issues/1633
6 years ago
Travis Ralston
cee0a5ac7b
Merge pull request #1557 from turt2live/travis/general/r0-prep
...
Prepare the identity service and server-server APIs for r0
6 years ago
Travis Ralston
32cde24bcf
Fix server-server link in IS spec
6 years ago
Travis Ralston
e82c22b060
Merge pull request #1615 from turt2live/travis/is/touchups
...
Touch up more of the identity service specification
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
f09db16027
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/key-mgmt
6 years ago
Travis Ralston
2753d24302
Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep
6 years ago
Travis Ralston
440841d1ff
Recommend a CSP rather than require it.
6 years ago
Travis Ralston
70f72b5b3b
Merge pull request #1628 from turt2live/travis/as/external_url
...
Clarify how external_url is supposed to work
6 years ago
Travis Ralston
cc1e496287
Merge pull request #1629 from turt2live/travis/as/route-versions
...
Version all appservice endpoints and provide a fallback
6 years ago
Travis Ralston
326ff6b1a1
Merge branch 'master' into travis/as/external_url
6 years ago
Travis Ralston
0f2e01f5b5
Merge pull request #1555 from turt2live/travis/as/cleanup
...
Application service spec cleanup; Security definitions; r0 prep
6 years ago
Travis Ralston
1a3f112337
Clarify that the external_url is unsafe
6 years ago
Travis Ralston
be5c566028
Version all appservice endpoints and provide a fallback
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1616
6 years ago
Travis Ralston
a48f7b9278
Clarify how external_url is supposed to work
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1624
6 years ago
Travis Ralston
05b017276c
Don't accidentally limit application services to one homeserver
6 years ago
Travis Ralston
ab14f33060
Add link to the client-server ACLs module
6 years ago
Erik Johnston
5c2b8e3569
Explain how to handle rejeceted events
6 years ago
Hubert Chathi
db644ca522
add some clarifications
6 years ago
Travis Ralston
56f6640c07
Merge pull request #1618 from turt2live/travis/c2s/initalsync
...
Remove references to initialSync from account data and receipts module
6 years ago
Richard van der Hoff
55c4307f12
Rewrite the section on signing events
...
... for clarity and de-duplication. And to say a bit about validating the
signatures.
6 years ago
Richard van der Hoff
6ba50fe2f6
Merge pull request #1588 from matrix-org/rav/fix_server_name
...
Specify that server names cannot be %-encoded
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
Travis Ralston
a5c3924492
Merge remote matrix-org/master
6 years ago
Hubert Chathi
4230e375fa
Merge pull request #1465 from Zil0/key_sharing
...
Document key sharing events
6 years ago
Travis Ralston
dc602b74d2
Reference the server-server specification for /onbind
6 years ago
Travis Ralston
0387da51e2
Clarify how sessions work when establishing associations
6 years ago
Travis Ralston
039cefdbea
Say that identity services should be nice to web browsers (CORS/OPTIONS)
6 years ago
Travis Ralston
bbba7dedd6
Clean up identity service RST
...
* Title casing
* s/identity server/identity service
* Rough column limit enforcement
* Add some links (used by future commits)
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
Hubert Chathi
9b94e588e6
document new state resolution algorithm
6 years ago
Travis Ralston
c7a228bf7b
Don't make the major version a variable
...
We are likely to want to maintain v1 when we release a v2, so we'll avoid a variable for now.
6 years ago
Travis Ralston
e7a69a6a6d
Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep
6 years ago
Travis Ralston
a46783eb24
Revert "Take out the reference to the current version from the changelog"
...
This reverts commit 2a20c11467
.
6 years ago
Travis Ralston
2a20c11467
Take out the reference to the current version from the changelog
6 years ago
Travis Ralston
2ab2f91088
Merge remote-tracking branch 'matrix-org/master' into travis/releases/push-gateway/r0.1.0
6 years ago
Richard van der Hoff
196159be91
We should include the Host header if the port was explicit.
6 years ago
Travis Ralston
abb91508be
Merge pull request #1556 from turt2live/travis/is/cleanup
...
Identity Service API cleanup
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
f2d02c9559
Take out device management section for now
...
This will be handled by the implementation of https://github.com/matrix-org/matrix-doc/issues/1212
6 years ago
Travis Ralston
8950f0b2cc
Spelling
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
348b549f9f
Add the other fields the server is expected to keep on events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/839
Reference: d69decd5c7/synapse/events/utils.py (L44-L91)
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
73feee5d73
Merge pull request #1586 from turt2live/travis/as/comment-ts-section
...
Comment out the timestamp massaging section for now
6 years ago
Travis Ralston
25b34e1d7b
Mention that ts massaging was in a draft, but not in the release
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
5019fb7c49
Merge pull request #1359 from uhoreg/well-known
...
.well-known discovery
6 years ago
Hubert Chathi
688c8ebcd3
specify how to handle multiple olm sessions with the same device
6 years ago
Erik Johnston
d921b81c70
Reject events with superfluous auth_events entries
6 years ago
Erik Johnston
073ebb051b
Spec third party invites in auth rules
6 years ago
Erik Johnston
5d40af7ecf
Update rules on which events to add to `auth_events`
6 years ago
Erik Johnston
86b5486445
Add missing clauses to and fix authorization rules
...
They are still missing third party invites.
6 years ago
Erik Johnston
0b7b3bfcb0
Reindent auth rules section
...
RST expects sub lists to be indented by three or more spaces. By doing
so we can then rely on `#.` for automatic numbering.
6 years ago
Richard van der Hoff
d493c82e82
even more clarification
6 years ago
Erik Johnston
7327656965
Merge pull request #1581 from matrix-org/erikj/limit_txn_size
...
Specify a limit on the number of EDUs and PDUs a transaction can contain
6 years ago
Richard van der Hoff
78d8118846
Further server_name clarification
6 years ago
Richard van der Hoff
f15eafae7f
Remove trailing spaces
6 years ago
Richard van der Hoff
08fba5de51
Link to grammar rather than duplicating.
6 years ago
Richard van der Hoff
120bb8dc8e
s/host/hostname/
6 years ago
Richard van der Hoff
8679a642b4
clarity
6 years ago
Richard van der Hoff
7f9524f801
s/--/—/
6 years ago
Richard van der Hoff
6f3b42a457
Server names cannot be %-encoded
...
They aren't URLs; it was a thinko to refer to the URL spec for this.
6 years ago
Travis Ralston
85b9769cd9
Comment out the timestamp massaging section for now
...
Pending discussion on https://github.com/matrix-org/matrix-doc/issues/1585
6 years ago
Erik Johnston
fc1fdc95af
Specify a limit on the number of EDUs and PDUs a transaction can contain
6 years ago
Valentin Deniaud
28ced3b0a4
fixup! document encrypted attachments
6 years ago
Travis Ralston
72c6fa2aaf
More versioned links
6 years ago
Travis Ralston
cff5b8b205
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
39e674ccb3
Clarify what matrix.to is and mention that room IDs are not routable
...
Also actually render the warning saying that this scheme is temporary.
6 years ago
Travis Ralston
fa3e9a7609
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/pills
6 years ago