Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-25 02:18:38 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
3350 commits 30 branches 42 tags 32 MiB
Commit graph

137 commits

Author SHA1 Message Date
Travis Ralston 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
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 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
Hubert Chathi 5019fb7c49
Merge pull request #1359 from uhoreg/well-known 
.well-known discovery
 2018-08-29 10:40:54 -04:00
Travis Ralston 3869f68a5c Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions 2018-08-21 12:22:35 -06:00
Hubert Chathi 6612dbecf1 tweak wording for validation 2018-08-17 11:54:14 -04:00
Travis Ralston d6c54b0278 unaccessible isn't a word 2018-08-15 16:39:01 -06:00
Travis Ralston ca87876f1b Clarify that the Authorization header is preferred 2018-08-15 16:37:52 -06:00
Travis Ralston 25d01aa431 Dedicate a section on how to use access tokens 
Fixes https://github.com/matrix-org/matrix-doc/issues/1042.
 2018-08-15 16:33:09 -06:00
Travis Ralston fde48e7ee8 Specify how room versioning works 
This is the spec PR for https://github.com/matrix-org/matrix-doc/issues/1425

Room version upgrades are not part of MSC1425.

Documented aspects:
* room_version on the create event
* creating a room with a specific version (useful for testing)
* make_join behaviour
* error code documentation
* grammar of room versions

Based upon https://docs.google.com/document/d/1urKgReoHqxX8R_XtySB17dPi-DZcKhqTEL2_s895Wz0/edit
 2018-08-15 15:12:36 -06:00
Hubert Chathi a264120b38 put server discovery as its own section 2018-08-14 18:06:03 -04:00
Hubert Chathi fcca80dad8 various minor fixes 
- formatting fixes
- add examples to homeserver/identity server discovery schema
- replace DNS name with hostname
 2018-08-14 17:58:57 -04:00
Hubert Chathi 6a3cf10be9 Merge remote-tracking branch 'origin/master' into well-known 2018-08-14 17:00:56 -04:00
Hubert Chathi 292d334509
document new login identifier object (#1390) 2018-08-10 16:19:17 -04:00
Ben Parsons 07aeaadef9 update links which used to point to docs/spec/intro 2018-07-24 11:41:03 +01:00
Travis Ralston 423d5593f5 Generify how OPTIONS and CORS are handled 2018-07-09 15:40:03 -06:00
Hubert Chathi ce1e2c0904 incorporate feedback from reviewers 2018-07-04 17:58:37 -04:00
Travis Ralston 0779d81e52 Clarify which requests should have CORS headers 
Spoilers: all of them.
 2018-07-04 14:30:39 -06:00
Travis Ralston 4ca54404fa Document the CORS/preflight headers 
Fixes https://github.com/matrix-org/matrix-doc/issues/1006
 2018-07-03 16:15:55 -06:00
Hubert Chathi 0dd330962d initial draft of .well-known discovery 2018-07-03 14:14:26 -04:00
Andrew Morgan cd26c170de Specify token used in /login is not an Access Token (#1155) 
* Specify token used in /login is not an Access Token

While working through the implementation of /login in Dendrite, it was
confusing what the contents of the token attribute in the login request
body referred to. Initially, I thought it was an access token, which led
to further confusion. This commit explicitly states that the token is a
login token, which is separate from an access token, hopefully reducing
confusion for future readers.

Signed-off-by: Andrew Morgan (https://amorgan.xyz) <andrew@amorgan.xyz>
 2018-03-23 10:00:49 +00:00
Michael Telatynski 4d90d2b495
fix depr link 2018-02-07 08:26:27 +00:00
Nathan Musoke 7e94cd5a0b
Typo in client-server spec: ether -> either 2018-01-20 19:15:01 +13:00
Michael Telatynski 784adade9b
changes based on Pull Request feedback 2017-12-21 17:45:26 +00:00
Michael Telatynski 3d8fe6e090
merge profiles with user directory into user data, also fix typo 2017-12-18 17:01:52 +00:00
Michael Telatynski 97445195f6
add user_directory 2017-12-17 23:42:44 +00:00
Richard van der Hoff e9c1b87a1d Remove git log reference 
We keep the changelog up to date anyway, so there's not much point in trying to
get people to use `git log`
 2017-11-15 16:34:18 +00:00
Richard van der Hoff 0ce58fdb28 Prepare for next spec dev cycle 2017-11-15 16:23:14 +00:00
Travis Ralston b1801ea6db Spec /account/whoami 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-11-12 23:49:40 -07:00
Michael Telatynski c2b1b7a10e
mention that we can send tokens via headers 2017-10-27 09:52:53 +01:00
Richard van der Hoff 6b23b7fc0b Merge branch 'client_server/r0.2.0_updates' 2017-10-24 23:26:56 +01:00
Richard van der Hoff b94c4a9f36 Sneaky update to 0.2.0 spec to link unstable 
This doesn't count as a spec release, right??
 2017-10-24 23:21:33 +01:00
Richard van der Hoff a8afbfd27d Avoid external link in search swagger 2017-10-15 23:01:54 +01:00
Michael Telatynski bf3b49f13c document joined_members and joined_rooms endpoints (#999) 2017-10-10 16:16:27 +01:00
Richard van der Hoff 1e3f5683c8 Make clear that the /sync timeout is zero by default 2017-08-31 16:56:50 +01:00
Brendan Abolivier 750d980bc0 Room member (#950) 
* Fixed an incorrect membership on example
* Added precision on membership upon profile update
* Changed first example into a join
* Changed the state/{eventType}/{stateKey} example with an actual state key
 2017-07-14 15:30:56 +01:00
Richard van der Hoff da6938b818 Key management APIs (#894) 
Spec the e2e key-management APIs.
 2017-04-20 16:51:42 +01:00
Richard van der Hoff 8a9629167a httpsify the speculator link 2016-11-27 17:28:56 +00:00
Richard van der Hoff 461bfdb0d8 Merge branch 'master' into rav/device_management 2016-11-09 14:34:04 +00:00
Richard van der Hoff 22777970da Fix speculator link 
the link to the 'latest version' was broken
 2016-10-13 17:56:53 +01:00
Richard van der Hoff 9265b03008 Client device doc 
Document client devices, and the mods to the login and register apis to support
them.
 2016-10-12 17:26:01 +01:00
Richard van der Hoff cbc5774ade JSON key names also use underscores. 2016-10-12 11:37:41 +01:00
Richard van der Hoff 8523af1385 Document convention of using underscores in APIs 
Everybody has agreed to it. Now we just have to remember to do it.
 2016-10-12 10:29:53 +01:00
Richard van der Hoff 6c88d698ae uia fallback example: check event origin 2016-10-07 16:26:28 +01:00
Richard van der Hoff e850fd718d window.postmessage for Interactive Auth fallback 
Require that User-Interactive auth fallback pages call
`window.postMessage` to notify apps of completion.
 2016-10-06 19:54:49 +01:00
Richard van der Hoff 909aef2b18 Merge pull request #389 from matrix-org/erikj/create_room_is_direct 
Spec /createRoom is_direct flag, is_direct in member event and m.direct
 2016-10-06 17:19:48 +01:00
David Baker 301595c071 Linkify account_data API 
Also change other links because it turns out the .. isn't part
of the syntax
 2016-10-06 11:15:44 +01:00
David Baker 2a987c3369 Linkify endpoints properly 2016-10-05 18:19:17 +01:00
Richard van der Hoff a8d35b2409 UI Auth: servers should 401 when a request fails 
(ref https://matrix.org/jira/browse/SYN-744)
 2016-10-05 11:25:49 +01:00
Richard van der Hoff 37fb1ceb65 Merge pull request #395 from matrix-org/rav/kill_refresh_tokens 
Remove references to refresh tokens and tokenrefresh
 2016-10-04 17:55:38 +01:00