Travis Ralston
f4c5c209f3
Generalize language for pagination
...
Previously the section was very strict in what pagination was, however this isn't the reality for the matrix specification. Several endpoints have their own pagination naming conventions and do not follow those mandated by this section.
This commit generalizes the language to cover those endpoints while also describing how pagination works. In particular, it describes the rough API shape to expect and how to deal with the responses.
This commit also removes the `M_BAD_PAGINATION` error as it is not used in the real world. Homeservers are instead encouraged to use the standard `M_INVALID_PARAM` or similar error code.
Fixes https://github.com/matrix-org/matrix-doc/issues/610
Fixes https://github.com/matrix-org/matrix-doc/issues/1523
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
Hubert Chathi
f1f32d3a15
add more clarifications
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
f013b7ef03
Merge pull request #1631 from turt2live/travis/general/unstable-warning
...
Render a warning if the spec is unstable
6 years ago
Travis Ralston
ab00630ebc
Don't include a second unstable warning in the s2s spec for now
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
9646d99c9e
Merge pull request #1602 from turt2live/travis/general/redactions
...
Add the other fields the server is expected to keep on events
6 years ago
Erik Johnston
080845ac1c
Add link to previous section
6 years ago
Erik Johnston
bbca5ce43a
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/limit_auth_events
6 years ago
Erik Johnston
b6ed25e4b4
Fix incorrect indent
6 years ago
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
caaa688e37
Fix links to client-server spec
6 years ago
Travis Ralston
219b27b182
Merge remote matrix-org/master
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