71e6321f4d
Rework how room versions are represented
...
Versions are actually on a scale of recommendations, and are expected to be created as needed. The scale presented here (develop/beta/default/recommended/mandatory) is a more wordy version of what was previously discussed/intended for room versions - the labels aren't final and may be changed.
2019-01-16 16:57:45 -07:00
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.
2019-01-16 16:13:53 -07:00
811e65a4d1
kitsune review on when to add things to the spec
2019-01-14 13:14:43 +00:00
70be8393a3
clarify the technical note and guiding principles
2019-01-14 13:02:01 +00:00
f3085812e9
more examples; remove widget MSC ref
2019-01-12 23:51:49 +00:00
156488384c
add more examples for spec inclusion; add interoperability as a core value
2019-01-12 23:49:27 +00:00
c053996a77
add new technical guidelines to proposals.rst
...
this was originally a todo for MSC1779, but belongs better in proposals.rst
2019-01-12 23:13:40 +00:00
b85f7bb248
Add room version upgrades
...
Implements https://github.com/matrix-org/matrix-doc/issues/1501
2019-01-09 17:02:09 -07:00
d6c33ea0a5
Make CAS a subset of SSO
2019-01-09 14:41:46 -07:00
3e7a5f5ea4
Initial draft for SSO support
2019-01-09 00:09:38 -07:00
bc1303a1a0
Add a bit of rationale for WIP tags
2019-01-07 13:39:50 -07:00
671527360c
Recommend some kind of WIP tag for MSCs
2019-01-07 13:16:45 -07:00
258aba5fed
Incorporate MSC1693
...
This is largely blatant copy/paste from the MSC with some formatting done to tidy it up a bit.
2019-01-07 13:09:21 -07:00
ffe577371d
Add a room version specification
...
The "Room Specification" (or "Room Version Specification") is the specification that defines which room versions do what and are intended to be documents which speak the truth about how rooms operate under the hood.
The approach taken here is a bit different than other specifications. For starters, the specification is versioned in this project instead of relying on the matrix.org repository to track compiled HTML. This is done for a couple reasons, the first being we're still developing the v1 specification while concurrently making a v2 spec and the second being trying to reduce the reliance on matrix.org's repository for specifications.
Because the room spec is built into versions, some changes needed to be made. The `targets.yaml` now has a special syntax for indicating what version something is at, and the changelog generator can handle rendering different versions of the same changelog (as parsed from the RST). Some additional work has been put in to the changelog parsing to allow us to reference the v1 room spec as "v1" without having to sacrifice clarity in the changelog headings.
Finally, this moves the state resolution algorithms into the versioned
spec as a result of MSC1759 (https://github.com/matrix-org/matrix-doc/pull/1759 ).
Note: this does not introduce the concept of versioned schemas (tabs) that I was previously working with. There's currently no use for them, so they are shelved elsewhere.
2019-01-04 15:49:24 -07:00
958b956776
Merge pull request #1755 from matrix-org/erikj/event_checks
...
Document the checks made for incoming PDUs
2018-12-18 15:08:58 +01:00
35de43de61
Merge pull request #1743 from matrix-org/dbkr/add_sandbox_to_csp
...
Add 'sandbox' to recommended CSP header
2018-12-17 10:28:06 -07:00
39df8291e9
Add TODO
2018-12-14 13:23:18 +00:00
be625254b1
Fix up wording about auth rules to not lie
2018-12-14 13:23:18 +00:00
c93bdcc59c
Fix up headings
2018-12-14 13:23:18 +00:00
cac150d567
Fix up wording
...
Co-Authored-By: erikjohnston <erikj@jki.re>
2018-12-14 13:13:06 +00:00
ee9c010c37
Document the checks made for incoming PDUs
2018-12-13 14:15:25 +00:00
fa0b4f9e13
Make the proposal labels match what happens in practice
2018-12-13 11:14:21 +00:00
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>
2018-12-11 16:07:01 +00:00
e318286404
Add 'sandbox' to recommended CSP header
2018-12-10 17:33:04 +00:00
16f17855c9
link to CS API Swagger Viewer
2018-12-05 15:47:55 +00:00
43109a717f
placeholder for proposals CSS
2018-12-03 12:27:58 +00:00
767af87744
Merge pull request #1701 from uhoreg/e2e_export
...
document megolm session export format
2018-11-06 11:58:00 +00:00
189725659a
clarifications and formatting fixes
2018-11-05 15:43:18 -05:00
179162379e
spell out that shepherd cannot be author
2018-10-27 19:34:52 +01:00
4271391214
Initial stab at documenting soft fail ( #1641 )
2018-10-26 15:18:04 +01:00
f288facec8
Merge pull request #1697 from matrix-org/anoa/msc_update
...
The new and improved MSC process
2018-10-23 20:02:36 +02:00
f8ffa79b56
Update and clarify proposal labels
2018-10-23 19:37:51 +02:00
2b259c6a7b
Remove etiquette page from targets
2018-10-21 00:54:04 +02:00
4b858a7993
DCO required for proposal and spec PR
2018-10-21 00:52:39 +02:00
0afb122760
Clarification on FCPs
2018-10-20 23:50:26 +02:00
f00be6b0d8
Etiquette -> guiding principles
2018-10-20 23:35:33 +02:00
46fde9723c
document megolm session export format
2018-10-19 10:55:14 -04:00
c6e0a88b09
fix irc bridge example properly
2018-10-18 21:50:39 +01:00
7a86bc4a66
fix missing escapes on AS regexp
2018-10-18 21:48:14 +01:00
ea21e31a0c
Merge branch 'anoa/msc_update' of github.com:matrix-org/matrix-doc into anoa/msc_update
2018-10-18 16:03:14 +02:00
7bff4d288c
be begin -> begin
2018-10-18 15:52:28 +02:00
5a2d28e7fd
Reduce more abbreviations!
2018-10-17 18:21:16 +02:00
9625f11fd4
reduce abbreviations
2018-10-17 18:20:42 +02:00
d487c0974f
Clarify how to get a shepherd (just ask)
2018-10-17 17:17:07 +02:00
45c935d8d3
Clarify that MSCs aren't just issues anymore.
2018-10-17 15:35:15 +02:00
1e939c50f5
Gather feedback
2018-10-17 14:49:01 +02:00
148f7d7b33
Minor proposal updates are allowed
2018-10-17 14:34:57 +02:00
5a1e735921
Fix sign off bullet
2018-10-16 01:21:14 +02:00
aeea060bb8
Specify where to find the MSC ID
2018-10-16 01:06:44 +02:00
7753957d04
remove ambiguity
2018-10-16 01:04:54 +02:00
2f0025c7a7
Fix up wording in proposal etiquette
2018-10-16 00:57:11 +02:00
35c924308c
core team -> Core Team
2018-10-16 00:57:08 +02:00
8121bef771
Introduce the spec core team
2018-10-16 00:44:05 +02:00
c1ecb9e324
Fix up table with title and add corresponding GitHub labels
2018-10-16 00:17:08 +02:00
889b46898c
Move proposal etiquette to a separate document.
2018-10-16 00:07:16 +02:00
49d017bdd5
your proposal -> the proposal
2018-10-15 23:51:28 +02:00
fb4c50ec8a
No need to redefine MSC
2018-10-15 23:37:41 +02:00
604091380f
Attempt to fix contributing link
2018-10-15 16:41:44 +02:00
b3f90f5825
proposal passed = spec pr missing
2018-10-15 16:38:48 +02:00
873641e4bc
Proposal Created and In Review is a single phase
2018-10-15 16:34:41 +02:00
11dbd5b56a
Proposal WIP -> drafting/feedback gathering
2018-10-15 16:30:33 +02:00
5ae3b50c6b
Require link to implementation
2018-10-15 16:18:20 +02:00
f1d71bd6c4
Less complicated wording
2018-10-15 16:09:04 +02:00
0e9ad9e95d
Fix wording, fix earlier capatilization
2018-10-15 16:05:09 +02:00
f769084570
Put it in the proposals dir!
2018-10-15 15:54:28 +02:00
67146e4bec
MSC ALL the changes
2018-10-15 15:52:33 +02:00
9432ed76d7
first-draft -> first draft
2018-10-15 15:51:54 +02:00
80d1d4af9c
Fix capatilization
2018-10-15 15:48:55 +02:00
d2e827e0c6
Note about earlier MSC process
2018-10-15 15:46:26 +02:00
764c63f3e8
Add proposal template
2018-10-15 15:29:40 +02:00
a3144e6959
Move to the new and improved MSC process
2018-10-15 02:33:15 +02:00
6dab4b28f8
Merge pull request #1648 from matrix-org/matthew/device_list_update
...
document device list synchronisation over federation.
2018-09-03 16:54:36 +01:00
334c69bcda
wording fix
2018-09-03 16:53:39 +01:00
ccbc88ee5d
reword to spell out to when device list updates should be sent
2018-09-03 16:49:36 +01:00
bcd48ebbec
Merge pull request #1610 from uhoreg/reloaded
...
document new state resolution algorithm
2018-09-02 23:53:08 +01:00
192a6c2ab9
Use example.org on examples instead of domain.com which is a real domain
...
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
2018-09-02 17:58:21 +03:00
e9e3afbd34
clarify who servers should send m.device_list_update EDUs to
2018-09-02 13:00:29 +01:00
928fc5cbe5
incorporate review
2018-09-01 03:08:53 +01:00
42b11e096f
Review
2018-09-01 02:48:37 +01:00
d25f4412d4
improve wording
2018-09-01 02:46:05 +01:00
db302b66ca
revert example which was corect first time; fix rst
2018-09-01 02:44:53 +01:00
0f9a23c471
swaggerify to-device
2018-09-01 02:37:31 +01:00
0afdcc59ea
spell out stream_id and fix todo
2018-09-01 02:10:45 +01:00
30d56691b1
document device list synchronisation over federation.
...
untested
closes MSC1212
2018-09-01 01:48:02 +01:00
735de03e07
Add r0 version links
...
These were missed in the release process.
2018-08-31 17:40:32 -06:00
bb2835651f
Merge pull request #1637 from turt2live/travis/c2s/clarify-errors
...
List known client-server error codes; Clarify priority of error codes vs http status code
2018-08-31 16:42:43 -06:00
00578547c0
Merge pull request #1644 from matrix-org/rav/is_token_grammar
...
Spec grammars for IS things
2018-08-31 16:05:23 -06:00
f3825c5827
A couple more stragglers
2018-08-31 15:55:07 -06:00
218b86d6e8
Hopefully the last one
2018-08-31 15:48:41 -06:00
79974b152c
s/identity service/identity server
2018-08-31 22:44:36 +01:00
a544b68298
Merge branch 'master' into rav/is_token_grammar
2018-08-31 22:37:04 +01:00
7d34995ece
It's actually an "identity server implementing the Identity Service API"
...
Also add a note about appservices being special.
2018-08-31 15:35:32 -06:00
7ac76fa27c
Actually we're going with "identity server" afterall
2018-08-31 15:04:00 -06:00
ec248b436f
Identity Service is lowercase
2018-08-31 15:04:00 -06:00
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.
2018-08-31 15:04:00 -06:00
108c623557
Merge pull request #1635 from turt2live/travis/c2s/read-markers
...
Add read markers
2018-08-31 14:47:39 -06:00
835f5de387
Generalize the token name even more
2018-08-31 14:22:07 -06:00
dced3d5707
Notes on the format of IS session IDs and tokens
2018-08-31 21:06:51 +01:00
f299fe023a
English
2018-08-31 12:51:31 -06:00
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
2018-08-31 12:36:08 -06:00
c0dd7e0025
Merge pull request #1420 from Zil0/encrypted_attach
...
Document encrypted attachments
2018-08-31 13:33:05 -04:00
4b9fb99644
Take out unhelpful example
2018-08-31 11:18:54 -06:00
3146fc339a
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/clarify-errors
2018-08-31 11:15:03 -06:00
f6d9e53f5c
Clarify that homeserver must reject clients from setting m.fully_read
2018-08-31 11:13:32 -06:00
2e8151999e
Clarify that read markers are fully read markers
2018-08-31 11:13:19 -06:00
f1f32d3a15
add more clarifications
2018-08-31 12:59:57 -04:00
679ddabb53
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/read-markers
2018-08-31 10:34:19 -06:00
567843e043
Add additional clarity to how rich replies are structured and used
2018-08-31 10:20:26 -06:00
e3daf10bb9
refactor encrypted file schema as "Extension to m.message"
2018-08-31 12:11:27 -04:00
9004be7bda
Merge remote matrix-org/master
2018-08-31 10:08:05 -06:00
f013b7ef03
Merge pull request #1631 from turt2live/travis/general/unstable-warning
...
Render a warning if the spec is unstable
2018-08-31 09:50:37 -06:00
ab00630ebc
Don't include a second unstable warning in the s2s spec for now
2018-08-31 09:49:24 -06:00
f72c821be4
Merge pull request #1619 from turt2live/travis/c2s/local-echo
...
Reference that transaction IDs may be used to echo
2018-08-31 09:48:02 -06:00
136ba15eb2
Merge pull request #1605 from turt2live/travis/c2s/clarify-html-again
...
Mention that clients should not be producing invalid HTML
2018-08-31 08:41:29 -06:00
38ae166e9d
Merge pull request #1505 from turt2live/travis/general/3pid_invite
...
Clarify how third party invites work
2018-08-31 08:38:40 -06:00
afa16f1e4e
Merge pull request #1606 from turt2live/travis/c2s/room-tags
...
Update the room tagging documentation
2018-08-31 08:36:40 -06:00
c127eed7e7
Merge pull request #1600 from turt2live/travis/c2s/media-csp
...
Specify the minimum CSP for media
2018-08-31 08:32:33 -06:00
9646d99c9e
Merge pull request #1602 from turt2live/travis/general/redactions
...
Add the other fields the server is expected to keep on events
2018-08-31 08:31:50 -06:00
080845ac1c
Add link to previous section
2018-08-31 12:00:38 +01:00
bbca5ce43a
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/limit_auth_events
2018-08-31 11:52:36 +01:00
b6ed25e4b4
Fix incorrect indent
2018-08-31 11:32:29 +01:00
f3a13eed76
Merge pull request #1593 from matrix-org/erikj/auth_events
...
Update rules on which events to add to `auth_events`
2018-08-31 11:27:03 +01:00
86891ca7e4
Merge pull request #1625 from matrix-org/erikj/auth_rejections
...
Explain how to handle rejected events
2018-08-31 11:26:57 +01:00
d91dc6fbf6
Fixup
2018-08-31 11:20:26 +01:00
4d653748d6
Add note back in
2018-08-31 11:17:58 +01:00
8e6c8ba59e
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/spec_3pid_ruls
2018-08-31 11:13:13 +01:00
a1aedb386a
Actually use proper sentences like a proper adult
2018-08-31 11:04:49 +01:00
0adfd1ebb0
Merge pull request #1591 from matrix-org/erikj/fixup_auth_rules
...
Fix up auth rules
2018-08-31 11:01:12 +01:00
d63184ebac
Fixup
2018-08-31 10:59:42 +01:00
3c53e1910d
Fixup
2018-08-31 10:51:59 +01:00
1a45bc4a85
Reword
2018-08-31 10:24:51 +01:00
59f86ec8f2
Reindent as RST requires sublists to be three spaces
2018-08-31 10:07:59 +01:00
f4706c8889
Require creator field
2018-08-31 10:06:26 +01:00
f3aea32a24
Be consistent with 'If..., reject'
2018-08-31 09:59:45 +01:00
6c8a45c165
Full stops
2018-08-31 09:57:00 +01:00
ebb044674f
Remove duplicated explanation about event rejection
2018-08-31 09:51:17 +01:00
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
2018-08-30 23:06:32 -06:00
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)
2018-08-30 23:05:51 -06:00
caaa688e37
Fix links to client-server spec
2018-08-30 16:28:26 -06:00
219b27b182
Merge remote matrix-org/master
2018-08-30 16:27:20 -06:00
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)d69decd5c7/synapse/rest/client/v2_alpha/read_marker.py (L45-L52)
2018-08-30 16:21:31 -06:00
0f84c69805
Merge branch 'master' into rav/clarify_event_signing
2018-08-30 22:48:56 +01:00
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.
2018-08-30 15:05:50 -06:00
d57b977a55
Merge branch 'm-master' into travis/general/3pid_invite
2018-08-30 15:01:31 -06:00
1f6499d563
Fix typo
2018-08-30 15:01:20 -06:00
356626845c
Remove unhelpful arrow from the 3rd party invite sequence dance
...
This doesn't add anything in terms of clarity.
2018-08-30 15:00:52 -06:00
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
2018-08-30 15:00:14 -06:00
cee0a5ac7b
Merge pull request #1557 from turt2live/travis/general/r0-prep
...
Prepare the identity service and server-server APIs for r0
2018-08-30 14:46:35 -06:00
32cde24bcf
Fix server-server link in IS spec
2018-08-30 12:26:24 -06:00
e82c22b060
Merge pull request #1615 from turt2live/travis/is/touchups
...
Touch up more of the identity service specification
2018-08-30 12:23:25 -06:00
b8f2c721dc
Clarify which attributes should be valid
2018-08-30 12:22:50 -06:00
2d18b0d2d8
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/clarify-html-again
2018-08-30 12:21:38 -06:00
f09db16027
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/key-mgmt
2018-08-30 12:19:59 -06:00
2753d24302
Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep
2018-08-30 12:17:09 -06:00
440841d1ff
Recommend a CSP rather than require it.
2018-08-30 12:13:21 -06:00
70f72b5b3b
Merge pull request #1628 from turt2live/travis/as/external_url
...
Clarify how external_url is supposed to work
2018-08-30 11:12:39 -06:00
cc1e496287
Merge pull request #1629 from turt2live/travis/as/route-versions
...
Version all appservice endpoints and provide a fallback
2018-08-30 11:11:25 -06:00
326ff6b1a1
Merge branch 'master' into travis/as/external_url
2018-08-30 11:09:15 -06:00
0f2e01f5b5
Merge pull request #1555 from turt2live/travis/as/cleanup
...
Application service spec cleanup; Security definitions; r0 prep
2018-08-30 11:08:10 -06:00
1a3f112337
Clarify that the external_url is unsafe
2018-08-30 11:07:09 -06:00
be5c566028
Version all appservice endpoints and provide a fallback
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1616
2018-08-30 11:03:42 -06:00
a48f7b9278
Clarify how external_url is supposed to work
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1624
2018-08-30 10:49:40 -06:00
05b017276c
Don't accidentally limit application services to one homeserver
2018-08-30 10:23:12 -06:00
ab14f33060
Add link to the client-server ACLs module
2018-08-30 10:11:37 -06:00
5c2b8e3569
Explain how to handle rejeceted events
2018-08-30 17:03:16 +01:00
db644ca522
add some clarifications
2018-08-30 11:24:39 -04:00
56f6640c07
Merge pull request #1618 from turt2live/travis/c2s/initalsync
...
Remove references to initialSync from account data and receipts module
2018-08-30 07:44:08 -06:00
55c4307f12
Rewrite the section on signing events
...
... for clarity and de-duplication. And to say a bit about validating the
signatures.
2018-08-30 14:37:24 +01:00
6ba50fe2f6
Merge pull request #1588 from matrix-org/rav/fix_server_name
...
Specify that server names cannot be %-encoded
2018-08-30 10:48:06 +01:00
bd93481013
Reference that transaction IDs may be used to echo
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1462
2018-08-29 23:18:10 -06:00
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
2018-08-29 23:11:00 -06:00
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.
2018-08-29 22:58:11 -06:00
a5c3924492
Merge remote matrix-org/master
2018-08-29 21:28:24 -06:00
4230e375fa
Merge pull request #1465 from Zil0/key_sharing
...
Document key sharing events
2018-08-29 23:05:17 -04:00
dc602b74d2
Reference the server-server specification for /onbind
2018-08-29 21:02:35 -06:00
0387da51e2
Clarify how sessions work when establishing associations
2018-08-29 21:02:28 -06:00
039cefdbea
Say that identity services should be nice to web browsers (CORS/OPTIONS)
2018-08-29 21:02:24 -06:00
bbba7dedd6
Clean up identity service RST
...
* Title casing
* s/identity server/identity service
* Rough column limit enforcement
* Add some links (used by future commits)
2018-08-29 21:02:19 -06:00
0130620cc1
Merge pull request #1596 from uhoreg/e2e_sessions
...
specify how to handle multiple olm sessions with the same device
2018-08-29 22:45:38 -04:00
9b94e588e6
document new state resolution algorithm
2018-08-29 21:39:49 -04:00
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.
2018-08-29 19:32:52 -06:00
e7a69a6a6d
Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep
2018-08-29 19:29:42 -06:00
a46783eb24
Revert "Take out the reference to the current version from the changelog"
...
This reverts commit 2a20c11467
2018-08-29 18:10:03 -06:00
2a20c11467
Take out the reference to the current version from the changelog
2018-08-29 17:54:48 -06:00
2ab2f91088
Merge remote-tracking branch 'matrix-org/master' into travis/releases/push-gateway/r0.1.0
2018-08-29 17:54:34 -06:00
196159be91
We should include the Host header if the port was explicit.
2018-08-29 22:18:14 +01:00
abb91508be
Merge pull request #1556 from turt2live/travis/is/cleanup
...
Identity Service API cleanup
2018-08-29 15:16:53 -06:00
c03f2f8d79
Minor touchups to the room tagging API
...
Fixes some of https://github.com/matrix-org/matrix-doc/issues/1565
2018-08-29 14:53:55 -06:00
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
2018-08-29 14:37:30 -06:00
8950f0b2cc
Spelling
2018-08-29 14:36:43 -06:00
2234e0b097
Mention that clients should not be producing invalid HTML
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1595
2018-08-29 12:38:15 -06:00
8e88d82a4b
fix typo in anchor. fixes #1603
2018-08-29 19:15:05 +01:00
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)
2018-08-29 11:19:37 -06:00
ec20c43220
Specify the minimum CSP for media
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1066
2018-08-29 10:55:34 -06:00
73feee5d73
Merge pull request #1586 from turt2live/travis/as/comment-ts-section
...
Comment out the timestamp massaging section for now
2018-08-29 10:10:36 -06:00
25b34e1d7b
Mention that ts massaging was in a draft, but not in the release
2018-08-29 09:55:43 -06:00
39ef845a53
Merge pull request #1547 from turt2live/travis/c2s/pills
...
Document how mentions (pills) work
2018-08-29 09:13:02 -06:00
5019fb7c49
Merge pull request #1359 from uhoreg/well-known
...
.well-known discovery
2018-08-29 10:40:54 -04:00
688c8ebcd3
specify how to handle multiple olm sessions with the same device
2018-08-29 10:17:20 -04:00
d921b81c70
Reject events with superfluous auth_events entries
2018-08-29 14:17:52 +01:00
073ebb051b
Spec third party invites in auth rules
2018-08-29 14:01:07 +01:00
5d40af7ecf
Update rules on which events to add to `auth_events`
2018-08-29 13:24:02 +01:00
86b5486445
Add missing clauses to and fix authorization rules
...
They are still missing third party invites.
2018-08-29 11:32:14 +01:00
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.
2018-08-29 11:20:33 +01:00
d493c82e82
even more clarification
2018-08-29 10:04:02 +01:00
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
2018-08-29 09:48:57 +01:00
78d8118846
Further server_name clarification
2018-08-29 09:36:50 +01:00
f15eafae7f
Remove trailing spaces
2018-08-29 09:26:31 +01:00
08fba5de51
Link to grammar rather than duplicating.
2018-08-29 09:25:38 +01:00
120bb8dc8e
s/host/hostname/
2018-08-29 09:24:24 +01:00
8679a642b4
clarity
2018-08-29 00:19:05 +01:00
7f9524f801
s/--/—/
2018-08-29 00:07:36 +01:00
6f3b42a457
Server names cannot be %-encoded
...
They aren't URLs; it was a thinko to refer to the URL spec for this.
2018-08-28 23:56:20 +01:00
85b9769cd9
Comment out the timestamp massaging section for now
...
Pending discussion on https://github.com/matrix-org/matrix-doc/issues/1585
2018-08-28 14:06:55 -06:00
fc1fdc95af
Specify a limit on the number of EDUs and PDUs a transaction can contain
2018-08-28 17:29:58 +01:00
28ced3b0a4
fixup! document encrypted attachments
2018-08-28 15:04:40 +02:00
72c6fa2aaf
More versioned links
2018-08-27 19:33:03 -06:00
cff5b8b205
More versioned links
2018-08-27 19:30:46 -06:00
e4f8c23972
Merge pull request #1562 from turt2live/travis/c2s/html-formatting
...
Define the supported HTML subset for message events
2018-08-27 19:14:52 -06:00
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.
2018-08-27 18:27:48 -06:00
fa3e9a7609
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/pills
2018-08-27 18:09:19 -06:00
6f80db5ddf
Include the "other versions" section of the changelog
2018-08-27 18:04:35 -06:00
07153c22a9
Misc. cleanup of the appservice spec
2018-08-27 18:04:19 -06:00
fa96d8629b
Prepare the appservice spec for an r0 release
...
This puts the scaffolding in place for an r0 release to happen, such as the changelog and version variables.
2018-08-27 18:04:08 -06:00
17e0ef4b91
Remove empty file and now-empty section from the appservice spec
...
This commit has approval under https://github.com/matrix-org/matrix-doc/pull/1555 although is being included in this branch/PR so the build passes, permitting a merge.
2018-08-27 17:58:47 -06:00
51193cac39
Merge remote-tracking branch 'matrix-org/master' into travis/as/normal-events
2018-08-27 17:53:32 -06:00
4e885c3f77
Merge pull request #1550 from turt2live/travis/general/acls
...
Server ACLs
2018-08-27 17:48:43 -06:00
a0b17e6ed6
Merge pull request #1551 from turt2live/travis/c2s/push-rules
...
General improvements to the push rules module
2018-08-27 17:48:01 -06:00
090f852fdf
Merge pull request #1262 from matrix-org/anoa/document_as_options
...
Document new application service registration file options
2018-08-27 17:47:53 -06:00
54032964fc
Misc clarity for 3rd party appservice protocols/locations
2018-08-27 17:41:52 -06:00
bac0392a2d
General clarity for push rule defaults and where to get information
...
Include moving a roaming condition that was under the wrong rule.
2018-08-27 17:28:08 -06:00
d7397ccd56
Provide additional rationale for kicking users when they are ACLd
2018-08-27 16:21:10 -06:00
76afef79f8
Clarify the rationale and motive for blanket IP banning and port exclusion
2018-08-27 16:14:37 -06:00
be97e95dc1
Promote device management to be a dedicated section
2018-08-27 14:49:38 -06:00
8069981252
Add federation /user/* endpoints
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1438
2018-08-27 14:19:10 -06:00
89daa3c5ce
Clarify that clients aren't required to render all the tags
...
This commit also includes minor clarifications to surrounding text.
2018-08-27 09:17:40 -06:00
5bf99aeb34
Add a note that formatted_body is not forever
2018-08-27 09:17:08 -06:00
c7822cc9a8
Link to the content repo when referencing MXC URIs in images
2018-08-27 09:16:53 -06:00
d7d28f7e5b
Remove nl as a supported HTML tag
2018-08-27 09:16:30 -06:00
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
2018-08-25 22:57:52 -06:00
312799ae78
General clarification for mention and how matrix.to URIs are meant to work
2018-08-25 22:30:49 -06:00
b7577ea237
document encrypted attachments
...
Fix #461 .
2018-08-25 17:31:49 +02:00
f6b5aee3e2
explain how to use key sharing events
2018-08-25 17:27:18 +02:00
d370a2c6fd
Prepare the identity service and server-server APIs for r0
...
* Create the changelog scaffolding
* Set up the variables for versioning
2018-08-24 17:19:25 -06:00
dafea96621
Fix indentation and schema references in the identity service spec
2018-08-24 15:53:27 -06:00
811998735c
Define common error codes in the Identity Service API
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1407
2018-08-24 15:51:23 -06:00
017d6db737
Document third party network/protocol directories (for appservices)
...
Fixes https://github.com/matrix-org/matrix-doc/issues/869
2018-08-24 11:07:30 -06:00
9eda1a6971
Move the third party network API to it's own section
2018-08-24 10:22:19 -06:00
bbd33c1461
Move appservice transaction API to the right section
...
Part of https://github.com/matrix-org/matrix-doc/issues/1532
2018-08-23 13:29:04 -06:00
ab0be04571
Fix titles
2018-08-22 15:24:53 -06:00
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
2018-08-22 15:21:21 -06:00
ef41b5c2bf
Server ACLs
...
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1383
2018-08-22 12:48:37 -06:00
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.
2018-08-21 22:05:47 -06:00
2d8a321b46
document key sharing and m.room_key_request
2018-08-21 21:35:03 +02:00
3869f68a5c
Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions
2018-08-21 12:22:35 -06:00
6172d5986a
Merge pull request #1537 from turt2live/travis/as/user-alias-query
...
Clean up user and alias querying for application services
2018-08-21 12:14:07 -06:00
997562786b
Merge pull request #1534 from turt2live/travis/as/auth-impersonation
...
Encourage appservices to use the Authorization header
2018-08-21 12:13:35 -06:00
1102fc59b2
Spelling
2018-08-21 12:13:19 -06:00
389fa87e6e
English
2018-08-21 12:10:40 -06:00
1d7ea314d4
Merge pull request #1482 from turt2live/travis/s2s/presence
...
Document how presence EDUs work between servers
2018-08-21 11:26:32 -06:00
339a2748e8
Take out groups for now; Move namespace mention
...
Groups aren't landing in the spec yet, so we shouldn't include them yet.
2018-08-21 09:49:41 -06:00
24edec67c3
Merge remote-tracking branch 'matrix-org/master' into anoa/document_as_options
2018-08-21 09:44:04 -06:00
06157c6336
Merge branch 'master' into anoa/document_as_options
2018-08-21 09:42:44 -06:00
7e5160c7c2
Merge remote-tracking branch 'matrix-org/master' into travis/as/user-alias-query
2018-08-20 12:37:05 -06:00
13a1628f59
Improve wording about how masquerading works
2018-08-20 12:34:52 -06:00
7ad22b2454
Merge pull request #1533 from turt2live/travis/as/general
...
General/small improvements to the application service API specification
2018-08-20 12:28:38 -06:00
c8ba2e098c
Wording improvements for appservices
2018-08-20 12:09:17 -06:00
fca1c0b7f8
Guests should support /context and /event
2018-08-20 18:06:26 +01:00
9ec914956f
Merge pull request #1536 from turt2live/travis/as/user-namespace
...
Recommend that application services use an underscore for namespacing
2018-08-20 10:16:20 -06:00
d468ae0fa3
Merge pull request #1535 from turt2live/travis/as/no-sync
...
Add a note that application services cannot /sync normally
2018-08-20 10:13:11 -06:00
26746cf785
Merge pull request #1517 from turt2live/travis/c2s/auth-header
...
Dedicate a section on how to use access tokens
2018-08-20 10:08:18 -06:00
9430f2c7f9
room ID is included in Megolm plaintext, not Olm
2018-08-18 11:41:45 +02:00
8ba19b51ab
complete Olm documentation
2018-08-18 11:41:45 +02:00
b2316ba782
enforce unique namespacing in new algorithms experiments
2018-08-18 11:41:45 +02:00
eb8ea0e85a
remove warning pointing at outdated doc
2018-08-18 11:41:45 +02:00
4e0f107ef7
document changed field behavior in e2e sync extension
2018-08-18 11:41:45 +02:00
248786681e
fix typo
2018-08-18 11:41:45 +02:00
e5005b2d0f
document E2E events
...
This was written by Richard van der Hoff.
2018-08-18 11:41:45 +02:00
68b78dc5d8
complete Megolm documentation
2018-08-18 11:41:45 +02:00
669605b24a
add Olm missing properties
2018-08-18 11:41:45 +02:00
76071bae98
explain how to verify sender_key ownership
2018-08-18 11:41:45 +02:00
8274f91b0b
document device verification
...
This was written by Richard van der Hoff.
2018-08-18 11:41:45 +02:00
a28f243ed7
document left parameter of device_lists in sync response
...
fix #1171
2018-08-18 11:41:45 +02:00
10c3307427
document device_one_time_keys_count in /sync/ response
...
fix #1157
2018-08-18 11:41:45 +02:00
2686b99080
fix json indent
2018-08-18 11:41:45 +02:00
07e3de3c61
add megolm messaging algorithm subsection
...
This was written by Richard van der Hoff.
2018-08-18 11:41:45 +02:00
33802dbbaf
add olm messaging algorithm subsection
...
This was written by Richard van der Hoff.
2018-08-18 11:41:45 +02:00
e210f8b050
add e2e messaging algorithms section intro
...
This was written by Richard van der Hoff.
2018-08-18 11:41:45 +02:00
0863c5452e
Take out the false third party network endpoints
...
Fixes https://github.com/matrix-org/matrix-doc/issues/800
2018-08-17 15:31:21 -06:00
95b2b7c2bc
Move query APIs to the right heading
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1325
Addresses some of https://github.com/matrix-org/matrix-doc/issues/1532
2018-08-17 15:30:42 -06:00
069a2f7481
Split the query user and room APIs out to their own files
2018-08-17 15:22:06 -06:00
954498bf78
Recommend that application services use an underscore for namespacing
...
Fixes https://github.com/matrix-org/matrix-doc/issues/689
2018-08-17 15:13:56 -06:00
205b326e4a
Add a note that application services cannot /sync normally
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1144
2018-08-17 15:03:30 -06:00
857bcc0fe7
Encourage appservices to use the Authorization header
...
This also throws in a mention about how to handle a request with a lack of user_id.
The request samples now encourage the use of the header over the query string, and have had their sample values added for some readability.
Fixes https://github.com/matrix-org/matrix-doc/issues/1296
Fixes https://github.com/matrix-org/matrix-doc/issues/1424
2018-08-17 13:49:35 -06:00
7caad61b86
Clearly state how the users namespace relates to interest in events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1307
2018-08-17 13:40:05 -06:00
fd101b6ac9
Misc language changes
2018-08-17 13:39:17 -06:00
f5dc0eaed2
document msisdn-related endpoints in IS ( #1507 )
...
* add msisdn endpoints in Identity Server spec
* add in CS endpoints that use the IS msisdn endpoints
2018-08-17 12:00:13 -04:00
6612dbecf1
tweak wording for validation
2018-08-17 11:54:14 -04:00
ebca4c7d86
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/presence
2018-08-17 09:53:57 -06:00
21dc6f823a
Merge pull request #1484 from turt2live/travis/s2s/read-receipts
...
Document how read receipts work over federation
2018-08-17 09:50:40 -06:00
Travis Ralston