Commit graph

978 commits

Author SHA1 Message Date
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.
2018-08-30 15:05:50 -06:00
Travis Ralston
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
Travis Ralston
32cde24bcf Fix server-server link in IS spec 2018-08-30 12:26:24 -06:00
Travis Ralston
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
Travis Ralston
2753d24302 Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep 2018-08-30 12:17:09 -06:00
Travis Ralston
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
Travis Ralston
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
Travis Ralston
326ff6b1a1
Merge branch 'master' into travis/as/external_url 2018-08-30 11:09:15 -06:00
Travis Ralston
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
Travis Ralston
1a3f112337 Clarify that the external_url is unsafe 2018-08-30 11:07:09 -06:00
Travis Ralston
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
Travis Ralston
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
Travis Ralston
05b017276c Don't accidentally limit application services to one homeserver 2018-08-30 10:23:12 -06:00
Travis Ralston
ab14f33060 Add link to the client-server ACLs module 2018-08-30 10:11:37 -06:00
Travis Ralston
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
Richard van der Hoff
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
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
2018-08-29 23:11:00 -06:00
Travis Ralston
a5c3924492 Merge remote matrix-org/master 2018-08-29 21:28:24 -06:00
Hubert Chathi
4230e375fa
Merge pull request #1465 from Zil0/key_sharing
Document key sharing events
2018-08-29 23:05:17 -04:00
Travis Ralston
dc602b74d2 Reference the server-server specification for /onbind 2018-08-29 21:02:35 -06:00
Travis Ralston
0387da51e2 Clarify how sessions work when establishing associations 2018-08-29 21:02:28 -06:00
Travis Ralston
039cefdbea Say that identity services should be nice to web browsers (CORS/OPTIONS) 2018-08-29 21:02:24 -06:00
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)
2018-08-29 21:02:19 -06:00
Hubert Chathi
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
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.
2018-08-29 19:32:52 -06:00
Travis Ralston
e7a69a6a6d Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep 2018-08-29 19:29:42 -06:00
Travis Ralston
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
Travis Ralston
2a20c11467 Take out the reference to the current version from the changelog 2018-08-29 17:54:48 -06:00
Travis Ralston
2ab2f91088 Merge remote-tracking branch 'matrix-org/master' into travis/releases/push-gateway/r0.1.0 2018-08-29 17:54:34 -06:00
Richard van der Hoff
196159be91 We should include the Host header if the port was explicit. 2018-08-29 22:18:14 +01:00
Travis Ralston
abb91508be
Merge pull request #1556 from turt2live/travis/is/cleanup
Identity Service API cleanup
2018-08-29 15:16:53 -06:00
Matthew Hodgson
8e88d82a4b fix typo in anchor. fixes #1603 2018-08-29 19:15:05 +01:00
Travis Ralston
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
Travis Ralston
25b34e1d7b Mention that ts massaging was in a draft, but not in the release 2018-08-29 09:55:43 -06:00
Travis Ralston
39ef845a53
Merge pull request #1547 from turt2live/travis/c2s/pills
Document how mentions (pills) work
2018-08-29 09:13:02 -06:00
Hubert Chathi
5019fb7c49
Merge pull request #1359 from uhoreg/well-known
.well-known discovery
2018-08-29 10:40:54 -04:00
Hubert Chathi
688c8ebcd3 specify how to handle multiple olm sessions with the same device 2018-08-29 10:17:20 -04:00
Richard van der Hoff
d493c82e82 even more clarification 2018-08-29 10:04:02 +01:00
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
2018-08-29 09:48:57 +01:00
Richard van der Hoff
78d8118846 Further server_name clarification 2018-08-29 09:36:50 +01:00
Richard van der Hoff
f15eafae7f Remove trailing spaces 2018-08-29 09:26:31 +01:00
Richard van der Hoff
08fba5de51 Link to grammar rather than duplicating. 2018-08-29 09:25:38 +01:00
Richard van der Hoff
120bb8dc8e s/host/hostname/ 2018-08-29 09:24:24 +01:00
Richard van der Hoff
8679a642b4 clarity 2018-08-29 00:19:05 +01:00
Richard van der Hoff
7f9524f801 s/--/—/ 2018-08-29 00:07:36 +01:00
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.
2018-08-28 23:56:20 +01:00
Travis Ralston
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
Erik Johnston
fc1fdc95af Specify a limit on the number of EDUs and PDUs a transaction can contain 2018-08-28 17:29:58 +01:00
Travis Ralston
72c6fa2aaf More versioned links 2018-08-27 19:33:03 -06:00
Travis Ralston
cff5b8b205 More versioned links 2018-08-27 19:30:46 -06:00