wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
3763 commits 4 branches 0 tags 17 MiB
Commit graph

3763 commits

This branch
This branch
All branches
Author SHA1 Message Date
Travis Ralston
375104127c Fix spec release process to match new changelog stuff 
Also while we're here, make it accurate. 

Fixes https://github.com/matrix-org/matrix-doc/issues/1858
 2019-02-06 22:03:16 -07:00
Travis Ralston
76946a8a7c Simplify changelog generation 
We don'e need `{{server_server_changelog_r0.1.0}}` (for example), so don't go through the hassle of generating it. Instead, we'll generate the changelog for the requested versions of each API and put that in place. In the future, we may wish to consider bringing back more complicated variables when/if we start generating released versions of the spec on the fly rather than manually.
 2019-02-06 22:02:21 -07:00
Travis Ralston
54ee861b5f Fix changelog generation for non-default versions 
Currently if you generate a changelog for r0.1.1 of an API, you'd get "No significant changes" which is wrong. You should get a real changelog for the version.

This is now handled by generating a "preferred" changelog which acts as the default for version variables in the RST. Using a specific version's changelog is still supported for the rare cases where that is desired.
 2019-02-04 14:47:20 -07:00
Travis Ralston
baf00ba6d1
Merge pull request #1839 from matrix-org/travis/improved-intro 
Add a bit of text to ensure that the intro page isn't missed
 2019-02-01 18:09:15 -07:00
Travis Ralston
1f5783b329 fix links and wording 2019-02-01 18:07:55 -07:00
Travis Ralston
9631e4bcb1 Add a bit of text to ensure that the intro page isn't missed 2019-02-01 18:01:01 -07:00
Travis Ralston
7181be1148
Merge pull request #1836 from matrix-org/server_server/release-r0.1.0 
Release r0.1.0 of the server-server specification
 2019-02-01 17:45:39 -07:00
Travis Ralston
8ace64bab7 r0.1.0 of the s2s specification 2019-02-01 16:10:22 -07:00
Travis Ralston
9364787b9c Remove stability warning 2019-02-01 16:09:48 -07:00
Matthew Hodgson
b27bf59ae8
Merge pull request #1838 from aaronraimist/spell-check 
Fix several spelling mistakes
 2019-02-01 23:48:24 +01:00
Aaron Raimist
fe7f582233
Fix several spelling mistakes 
Signed-off-by: Aaron Raimist <aaron@raim.ist>
 2019-02-01 16:43:46 -06:00
Travis Ralston
9923584c24
Merge pull request #1834 from matrix-org/travis/misc/event-formats 
Represent event format changes more clearly in the spec
 2019-02-01 13:57:25 -07:00
Travis Ralston
222957157f Add missing required flags 2019-02-01 13:56:30 -07:00
Travis Ralston
1d0156ad78 Fix more titles 2019-02-01 13:37:19 -07:00
Travis Ralston
985d02d95e Fix titles in schemas 2019-02-01 13:35:38 -07:00
Travis Ralston
82bed06d3f The event *format* changes, not the version 2019-02-01 13:19:24 -07:00
Travis Ralston
f5134b2d8b
Merge pull request #1819 from matrix-org/neilj/msc-remove-presence-lists 
MSC:1819 Remove Presence Lists
 2019-02-01 12:00:42 -07:00
Travis Ralston
1cf9086c26
Merge pull request #1831 from matrix-org/travis/msc/wk-before-srv 
MSC1831: Change the order of .well-known and SRV discovery techniques
 2019-02-01 11:52:59 -07:00
Travis Ralston
890fb1a019 Fix examples for new schema 
Fix missed example in make_join

Fix state array in response of send_join

Try removing examples from send_join?

Try printing more information about the error

Copy/paste known working examples

Try schema definitions in the response?
 2019-02-01 11:14:42 -07:00
Travis Ralston
5d8fa65e6e De-duplicate state keys 2019-02-01 10:11:39 -07:00
Travis Ralston
33406e4662 Apply event format warnings to the remainder of the s2s spec 2019-02-01 10:08:30 -07:00
Travis Ralston
d94a70f49d Warn clients about changes in event format 2019-02-01 08:40:18 -07:00
Travis Ralston
9b214ec16d Make the backfill response aware of event format changes 2019-02-01 08:40:18 -07:00
Travis Ralston
e27c83d9f8
Merge pull request #1817 from matrix-org/neilj/remove_presence_lists 
remove references to presence lists
 2019-02-01 08:37:08 -07:00
Travis Ralston
41e50d553e
Merge pull request #1830 from matrix-org/travis/spec/x509-wk 
Specify .well-known s2s discovery and X.509 validation
 2019-02-01 08:36:55 -07:00
Travis Ralston
6421582bf2 Clarifications and alter the error handling of .well-known 
Note that MSC1831 changes the order, so the changes to MSC1708 might not make sense when combining all the proposals together. However, independently the change should make sense.
 2019-02-01 08:18:12 -07:00
Richard van der Hoff
39b71413be
Update specification/server_server_api.rst 
Co-Authored-By: turt2live <travpc@gmail.com>
 2019-02-01 07:40:39 -07:00
Travis Ralston
1c30f5eba9 Clarify certificate usage and ports 2019-01-31 21:15:47 -07:00
Travis Ralston
df01acc6e2
Merge pull request #1828 from matrix-org/travis/spec/rooms-v3 
Add specification for room version 3: Event IDs as hashes
 2019-01-31 17:59:31 -07:00
Travis Ralston
a6243da03f Wording changes and links 2019-01-31 17:58:42 -07:00
Travis Ralston
48912a7320 Fix auth rules of redactions in v3 2019-01-31 17:35:25 -07:00
Travis Ralston
ad64af3f01 Clarify how reference hashes are done 2019-01-31 17:22:55 -07:00
Travis Ralston
01556e5b17 Clarifications and bug fixes in how v3 rooms work 2019-01-31 16:44:37 -07:00
Travis Ralston
3c17a0e53b Mention caching 2019-01-31 16:29:07 -07:00
Travis Ralston
b971bcee7d Accurately represent the 3 proposals and provide more detail 2019-01-31 16:24:07 -07:00
Travis Ralston
fb36757869
Merge pull request #1833 from matrix-org/travis/misc/domain-security 
Document domain reuse concerns
 2019-01-31 16:07:21 -07:00
Travis Ralston
48e4d6e412 Document domain reuse concerns 
Fixes https://github.com/matrix-org/matrix-doc/issues/1783
 2019-01-31 12:27:09 -07:00
Travis Ralston
0f3aa3fa8a
Merge pull request #1829 from matrix-org/travis/spec/c2s-caps 
Specify how capabilities work in the c2s API
 2019-01-31 12:03:41 -07:00
Travis Ralston
d2f012f4ea Incorporate MSC1831 
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1831

Implementation proof: pending
 2019-01-31 11:17:56 -07:00
Travis Ralston
00de03bddb Merge remote-tracking branch 'origin/travis/msc/wk-before-srv' into travis/msc/wk-before-srv 2019-01-31 10:53:22 -07:00
Travis Ralston
2fe6b2cb5c Plagiarize from richvdh for a better explanation 2019-01-31 10:53:06 -07:00
Travis Ralston
ab7876cbef
Update 1831-srv-after-wellknown.md 2019-01-31 09:55:58 -07:00
Travis Ralston
0e90cf6a0c Proposal to change the order of .well-known and SRV discovery techniques 2019-01-31 09:38:58 -07:00
Travis Ralston
c888f3f080 Make example strings more legible 2019-01-31 00:09:30 -07:00
Travis Ralston
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.
 2019-01-30 22:11:31 -07:00
Travis Ralston
9193d57dfd full stop 2019-01-30 19:47:16 -07:00
Travis Ralston
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.
 2019-01-30 19:43:55 -07:00
Travis Ralston
72a2871021
Merge pull request #1804 from matrix-org/travis/msc/room-version-client-advertising 
MSC1804: Advertising capable room versions to clients
 2019-01-30 17:06:24 -07:00
Travis Ralston
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.
 2019-01-30 17:03:03 -07:00
Travis Ralston
4437c383bb
Merge pull request #1790 from matrix-org/travis/spec/login-redirect 
Add a mechanism for redirecting clients after login
 2019-01-30 13:33:03 -07:00