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

3244 commits

This branch
This branch
All branches
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
951b442956
Merge pull request #1558 from turt2live/travis/c2s/fix-events 
Fix client-server event schemas: move `age`, dedupe fields
 2018-08-30 13:36:02 -06:00
Travis Ralston
429f302744 Add an age to the invite room state example 2018-08-30 13:32:53 -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
464f4f5f21 Correctly check for the 'core' folder 2018-08-30 12:05:56 -06:00
Travis Ralston
c8a8f13623 Don't check the underlying definitions 
Otherwise the script will try to find a schema for our templates, which don't exist.
 2018-08-30 11:57:01 -06:00
Travis Ralston
31ea4279d1 Resolve references in the check_examples script 2018-08-30 11:53:39 -06:00
Travis Ralston
6aacec3178 Fix power level JSON example 2018-08-30 11:40:08 -06:00
Travis Ralston
f04afaa9b9
Merge pull request #780 from mujx/missing-enum-fields 
Add missing enum fields for the set_presence parameter
 2018-08-30 11:37:34 -06:00
Travis Ralston
827033c128 Merge remote matrix-org/master 2018-08-30 11:29:47 -06:00
Travis Ralston
138419cdd4
fix indentation on release process doc 2018-08-30 11:19:55 -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
Richard van der Hoff
f649d04ae1
Merge pull request #1626 from matrix-org/rav/encoding 
Set the encoding to UTF-8 on all file I/O
 2018-08-30 18:11:38 +01: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
Richard van der Hoff
20c9829f56
Merge pull request #1627 from matrix-org/travis/general/dont-build-proposals 
Don't generate proposals.rst in Circle CI
 2018-08-30 18:10:48 +01: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
ecd3ce39e5 Don't generate proposals.rst in Circle CI 2018-08-30 10:38:23 -06:00
Travis Ralston
05b017276c Don't accidentally limit application services to one homeserver 2018-08-30 10:23:12 -06:00
Richard van der Hoff
4e90b32348 Set the encoding to UTF-8 on all file I/O 
Hopefully this will resolve issues with building the spec on systems where the
default encoding is somthing other than UTF-8.
 2018-08-30 17:18:07 +01:00
Travis Ralston
ab14f33060 Add link to the client-server ACLs module 2018-08-30 10:11:37 -06:00
Travis Ralston
6b52e1df77
Merge pull request #1587 from turt2live/travis/s2s/clarify-state-ids-inclusion 
Clarify that the requested event is excluded from /state and /state_ids
 2018-08-30 07:44:27 -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
Travis Ralston
7ecf2406eb
Merge pull request #1590 from turt2live/travis/c2s/403-put-state 
Document 403 error for sending state events
 2018-08-30 06:50:48 -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
b2092922e8 Don't define a variable for the appservice major version 2018-08-29 21:51:26 -06:00
Travis Ralston
a5c3924492 Merge remote matrix-org/master 2018-08-29 21:28:24 -06:00
Travis Ralston
fd7cb22a28 Fix event type example of m.forwarded_room_key 2018-08-29 21:22:47 -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
Travis Ralston
f030d19f3c Clean up identity service swagger 
* Add `consumes` (swagger)
* Remove `http` as a supported scheme (the spec specifically says clients MUST use https)
* Clarify various descriptions
  * Full stops
  * Additional wording
  * s/older versions/previous drafts - we haven't had a release yet
* Indentation on examples
 2018-08-29 21:02:13 -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
4c9d672e1f
Merge pull request #1521 from matrix-org/push_gateway/r0.1.0_updates 
r0.1.0 release of the Push Gateway specification
 2018-08-29 18:02:41 -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
Travis Ralston
684d80c422 Revert changes to 3pid lookup types in the IS spec 
The validator doesn't know what a "3PID Medium" is, for example, so it throws exceptions. This does reduce clarity in the spec though.
 2018-08-29 17:52:02 -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