ad64af3f01
Clarify how reference hashes are done
6 years ago
01556e5b17
Clarifications and bug fixes in how v3 rooms work
6 years ago
3c17a0e53b
Mention caching
6 years ago
b971bcee7d
Accurately represent the 3 proposals and provide more detail
6 years ago
48e4d6e412
Document domain reuse concerns
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1783
6 years ago
d2f012f4ea
Incorporate MSC1831
...
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1831
Implementation proof: pending
6 years ago
0347e873ef
Specify .well-known s2s discovery and X.509 validation
...
Original proposals:
* https://github.com/matrix-org/matrix-doc/pull/1708 (note: the JSON requirements were softened by https://github.com/matrix-org/matrix-doc/pull/1824 )
* https://github.com/matrix-org/matrix-doc/pull/1711
Implementation proofs:
* https://github.com/matrix-org/synapse/pull/4489
* No explicit PRs for MSC1711 could be found, however Synapse is known to implement it.
There are no intentional changes which differ from the proposals in this commit, however the author has relied upon various historical conversations outside of the proposals to gain the required context. Inaccuracies introduced by the author are purely accidental.
6 years ago
ccce6c196d
Specify how capabilities work in the c2s API
...
Original proposals:
* https://github.com/matrix-org/matrix-doc/pull/1753
* https://github.com/matrix-org/matrix-doc/pull/1804
Implementation proof:
* https://github.com/matrix-org/synapse/pull/4472
* https://github.com/matrix-org/matrix-js-sdk/pull/830
There is one change to MSC1753 which is included in this commit. MSC1804 remains unchanged. In the original proposal, the change password capability being present was an indication that password changes were possible. It was found that this doesn't really communicate the state very well to clients in that lack of a capability (or a 404, etc) would mean that users would erroneously not be able to change their passwords. A simple boolean flag was added to assist clients in detecting this capability.
6 years ago
ff75996524
Add specification for room version 3: Event IDs as hashes
...
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1659
Implementation proofs (some traversing of the PR tree may be required to get all of them):
* https://github.com/matrix-org/synapse/pull/4483
* https://github.com/matrix-org/synapse/pull/4499
This doesn't intentionally change anything from the proposal.
**Implementation details**:
The simple part of this is the introduction of a rooms/v3.html document. The somewhat unclear part is the stuff done to the s2s definitions. This pulls `unsigned_pdu` out to `unsigned_pdu_base` (all fields except `event_id`) where it can be reused in `pdu` and `pdu_v3` (for rooms v3). These definitions are further moved into the room version specifications where they can highlight the exact schemas in detail.
Version 1 has been updated to include the pre-existing event format, however the core principles of the room have not been changed. The same applies to room version 2. Room versions have immutable core principles once in the spec, otherwise these format changes would land in a pre-existing version.
The client-server API event formats will need updating, however that is being punted to a different commit to try and keep these changes reviewable.
6 years ago
c09fa6845e
Update presence.rst
6 years ago
00adfdbf4a
Merge pull request #1820 from matrix-org/travis/spec/fed-v2-invite
...
Specification for v2 s2s invite API
6 years ago
0712fd36a2
75% majority now required for FCP
6 years ago
aca9437bf3
Specification for v2 s2s invite API
...
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1794
Implementation proofs:
* https://github.com/matrix-org/synapse/pull/4402
* https://github.com/matrix-org/synapse/pull/4496
There are no changes from the original proposal.
6 years ago
bf2b6e6daa
remove references to presence lists
6 years ago
9f443225ac
fix incorrect spelling of homeserver
6 years ago
6c7eea555a
Merge pull request #1773 from matrix-org/travis/spec/rooms
...
Add a room version specification
6 years ago
052d68d83d
Merge pull request #1791 from matrix-org/travis/spec/rver-upgrades
...
Add room version upgrades
6 years ago
061f59547a
Minor wording changes
6 years ago
5cafcd103f
Fix copyright
...
> Since this is a copy-and-paste of old text, I think the copyright year should match when the original text was written, which according to git was 2017.
Co-Authored-By: turt2live <travpc@gmail.com>
6 years ago
0dfc64a9f4
Improve wording
6 years ago
bd5e760a0d
Simplify the description for room versions
...
Instead of trying to describe maturity, stability, and recommendedness in one list we should describe what is "safe" and "unsafe" to use. The default version is just something that servers should use, and is normally going to be stable.
6 years ago
ebe887d931
Grammar
...
Co-Authored-By: turt2live <travpc@gmail.com>
6 years ago
ba37f2d311
prompt->advertise
6 years ago
19e94815f9
Try and improve the understanding of room versions
6 years ago
0dde2489b6
Clarify what a Mandatory room version is
6 years ago
96d754f429
promote -> prompt
6 years ago
a6f5d01586
Clarify that servers don't have to implement development/beta versions
6 years ago
2457438f1e
Encourage servers to transfer whatever they can while being open-ended
6 years ago
4e0533a5f3
Soften UX requirements
6 years ago
fcc26d247e
Merge pull request #1789 from matrix-org/travis/spec/sso-login
...
Add a generic SSO login API
6 years ago
82ee3a6035
Adjust wording for SSO introduction
6 years ago
166d4ada86
Fix room versions reference in appendices & s2s spec
6 years ago
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.
6 years ago
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
b85f7bb248
Add room version upgrades
...
Implements https://github.com/matrix-org/matrix-doc/issues/1501
6 years ago
d6c33ea0a5
Make CAS a subset of SSO
6 years ago
3e7a5f5ea4
Initial draft for SSO support
6 years ago
bc1303a1a0
Add a bit of rationale for WIP tags
6 years ago
671527360c
Recommend some kind of WIP tag for MSCs
6 years ago
258aba5fed
Incorporate MSC1693
...
This is largely blatant copy/paste from the MSC with some formatting done to tidy it up a bit.
6 years ago
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.
6 years ago
958b956776
Merge pull request #1755 from matrix-org/erikj/event_checks
...
Document the checks made for incoming PDUs
6 years ago
35de43de61
Merge pull request #1743 from matrix-org/dbkr/add_sandbox_to_csp
...
Add 'sandbox' to recommended CSP header
6 years ago
39df8291e9
Add TODO
6 years ago
be625254b1
Fix up wording about auth rules to not lie
6 years ago
c93bdcc59c
Fix up headings
6 years ago
cac150d567
Fix up wording
...
Co-Authored-By: erikjohnston <erikj@jki.re>
6 years ago
ee9c010c37
Document the checks made for incoming PDUs
6 years ago
fa0b4f9e13
Make the proposal labels match what happens in practice
6 years ago
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
e318286404
Add 'sandbox' to recommended CSP header
6 years ago
16f17855c9
link to CS API Swagger Viewer
6 years ago
43109a717f
placeholder for proposals CSS
6 years ago
767af87744
Merge pull request #1701 from uhoreg/e2e_export
...
document megolm session export format
6 years ago
189725659a
clarifications and formatting fixes
6 years ago
179162379e
spell out that shepherd cannot be author
6 years ago
4271391214
Initial stab at documenting soft fail ( #1641 )
6 years ago
f288facec8
Merge pull request #1697 from matrix-org/anoa/msc_update
...
The new and improved MSC process
6 years ago
f8ffa79b56
Update and clarify proposal labels
6 years ago
2b259c6a7b
Remove etiquette page from targets
6 years ago
4b858a7993
DCO required for proposal and spec PR
6 years ago
0afb122760
Clarification on FCPs
6 years ago
f00be6b0d8
Etiquette -> guiding principles
6 years ago
46fde9723c
document megolm session export format
6 years ago
c6e0a88b09
fix irc bridge example properly
6 years ago
7a86bc4a66
fix missing escapes on AS regexp
6 years ago
ea21e31a0c
Merge branch 'anoa/msc_update' of github.com:matrix-org/matrix-doc into anoa/msc_update
6 years ago
7bff4d288c
be begin -> begin
6 years ago
5a2d28e7fd
Reduce more abbreviations!
6 years ago
9625f11fd4
reduce abbreviations
6 years ago
d487c0974f
Clarify how to get a shepherd (just ask)
6 years ago
45c935d8d3
Clarify that MSCs aren't just issues anymore.
6 years ago
1e939c50f5
Gather feedback
6 years ago
148f7d7b33
Minor proposal updates are allowed
6 years ago
5a1e735921
Fix sign off bullet
6 years ago
aeea060bb8
Specify where to find the MSC ID
6 years ago
7753957d04
remove ambiguity
6 years ago
2f0025c7a7
Fix up wording in proposal etiquette
6 years ago
35c924308c
core team -> Core Team
6 years ago
8121bef771
Introduce the spec core team
6 years ago
c1ecb9e324
Fix up table with title and add corresponding GitHub labels
6 years ago
889b46898c
Move proposal etiquette to a separate document.
6 years ago
49d017bdd5
your proposal -> the proposal
6 years ago
fb4c50ec8a
No need to redefine MSC
6 years ago
604091380f
Attempt to fix contributing link
6 years ago
b3f90f5825
proposal passed = spec pr missing
6 years ago
873641e4bc
Proposal Created and In Review is a single phase
6 years ago
11dbd5b56a
Proposal WIP -> drafting/feedback gathering
6 years ago
5ae3b50c6b
Require link to implementation
6 years ago
f1d71bd6c4
Less complicated wording
6 years ago
0e9ad9e95d
Fix wording, fix earlier capatilization
6 years ago
f769084570
Put it in the proposals dir!
6 years ago
67146e4bec
MSC ALL the changes
6 years ago
9432ed76d7
first-draft -> first draft
6 years ago
80d1d4af9c
Fix capatilization
6 years ago
d2e827e0c6
Note about earlier MSC process
6 years ago
764c63f3e8
Add proposal template
6 years ago
a3144e6959
Move to the new and improved MSC process
6 years ago
6dab4b28f8
Merge pull request #1648 from matrix-org/matthew/device_list_update
...
document device list synchronisation over federation.
6 years ago
334c69bcda
wording fix
6 years ago
ccbc88ee5d
reword to spell out to when device list updates should be sent
6 years ago
bcd48ebbec
Merge pull request #1610 from uhoreg/reloaded
...
document new state resolution algorithm
6 years ago
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
e9e3afbd34
clarify who servers should send m.device_list_update EDUs to
6 years ago
928fc5cbe5
incorporate review
6 years ago
42b11e096f
Review
6 years ago
d25f4412d4
improve wording
6 years ago
db302b66ca
revert example which was corect first time; fix rst
6 years ago
0f9a23c471
swaggerify to-device
6 years ago
0afdcc59ea
spell out stream_id and fix todo
6 years ago
30d56691b1
document device list synchronisation over federation.
...
untested
closes MSC1212
6 years ago
735de03e07
Add r0 version links
...
These were missed in the release process.
6 years ago
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
6 years ago
00578547c0
Merge pull request #1644 from matrix-org/rav/is_token_grammar
...
Spec grammars for IS things
6 years ago
f3825c5827
A couple more stragglers
6 years ago
218b86d6e8
Hopefully the last one
6 years ago
79974b152c
s/identity service/identity server
6 years ago
a544b68298
Merge branch 'master' into rav/is_token_grammar
6 years ago
7d34995ece
It's actually an "identity server implementing the Identity Service API"
...
Also add a note about appservices being special.
6 years ago
7ac76fa27c
Actually we're going with "identity server" afterall
6 years ago
ec248b436f
Identity Service is lowercase
6 years ago
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
108c623557
Merge pull request #1635 from turt2live/travis/c2s/read-markers
...
Add read markers
6 years ago
835f5de387
Generalize the token name even more
6 years ago
dced3d5707
Notes on the format of IS session IDs and tokens
6 years ago
f299fe023a
English
6 years ago
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
c0dd7e0025
Merge pull request #1420 from Zil0/encrypted_attach
...
Document encrypted attachments
6 years ago
4b9fb99644
Take out unhelpful example
6 years ago
3146fc339a
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/clarify-errors
6 years ago
f6d9e53f5c
Clarify that homeserver must reject clients from setting m.fully_read
6 years ago
2e8151999e
Clarify that read markers are fully read markers
6 years ago
f1f32d3a15
add more clarifications
6 years ago
679ddabb53
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/read-markers
6 years ago
567843e043
Add additional clarity to how rich replies are structured and used
6 years ago
e3daf10bb9
refactor encrypted file schema as "Extension to m.message"
6 years ago
9004be7bda
Merge remote matrix-org/master
6 years ago
f013b7ef03
Merge pull request #1631 from turt2live/travis/general/unstable-warning
...
Render a warning if the spec is unstable
6 years ago
ab00630ebc
Don't include a second unstable warning in the s2s spec for now
6 years ago
f72c821be4
Merge pull request #1619 from turt2live/travis/c2s/local-echo
...
Reference that transaction IDs may be used to echo
6 years ago
136ba15eb2
Merge pull request #1605 from turt2live/travis/c2s/clarify-html-again
...
Mention that clients should not be producing invalid HTML
6 years ago
38ae166e9d
Merge pull request #1505 from turt2live/travis/general/3pid_invite
...
Clarify how third party invites work
6 years ago
afa16f1e4e
Merge pull request #1606 from turt2live/travis/c2s/room-tags
...
Update the room tagging documentation
6 years ago
c127eed7e7
Merge pull request #1600 from turt2live/travis/c2s/media-csp
...
Specify the minimum CSP for media
6 years ago
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
080845ac1c
Add link to previous section
6 years ago
bbca5ce43a
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/limit_auth_events
6 years ago
b6ed25e4b4
Fix incorrect indent
6 years ago
f3a13eed76
Merge pull request #1593 from matrix-org/erikj/auth_events
...
Update rules on which events to add to `auth_events`
6 years ago
86891ca7e4
Merge pull request #1625 from matrix-org/erikj/auth_rejections
...
Explain how to handle rejected events
6 years ago
Travis Ralston