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

206 commits

Author SHA1 Message Date
Andrew Morgan
4ec3a43a85 Replace "3pid" with "3PID" 2019-02-05 12:58:11 +00: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
d94a70f49d Warn clients about changes in event format 2019-02-01 08:40:18 -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
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.
 2019-01-16 16:13:53 -07:00
Travis Ralston
d6c33ea0a5 Make CAS a subset of SSO 2019-01-09 14:41:46 -07:00
Travis Ralston
3e7a5f5ea4 Initial draft for SSO support 2019-01-09 00:09:38 -07:00
Konstantinos Sideris
192a6c2ab9 Use example.org on examples instead of domain.com which is a real domain 
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
 2018-09-02 17:58:21 +03:00
Travis Ralston
735de03e07 Add r0 version links 
These were missed in the release process.
 2018-08-31 17:40:32 -06:00
Travis Ralston
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
 2018-08-31 16:42:43 -06:00
Travis Ralston
7ac76fa27c Actually we're going with "identity server" afterall 2018-08-31 15:04:00 -06:00
Travis Ralston
ec248b436f Identity Service is lowercase 2018-08-31 15:04:00 -06:00
Travis Ralston
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.
 2018-08-31 15:04:00 -06:00
Travis Ralston
835f5de387 Generalize the token name even more 2018-08-31 14:22:07 -06:00
Travis Ralston
f299fe023a English 2018-08-31 12:51:31 -06:00
Travis Ralston
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
 2018-08-31 12:36:08 -06:00
Travis Ralston
3146fc339a Merge remote-tracking branch 'matrix-org/master' into travis/c2s/clarify-errors 2018-08-31 11:15:03 -06:00
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
d57b40d0cc Clarify how the client should treat errors 
This is based on observation and rough interpretation and may need additional review from people.

Fixes https://github.com/matrix-org/matrix-doc/issues/1188
 2018-08-30 23:06:32 -06:00
Travis Ralston
e6adf9f6b9 Document known client-server error codes 
Covers part of https://github.com/matrix-org/matrix-doc/issues/603 (updating all the endpoints is being done as a separate PR/commit). 

Reference: 74854a9719/synapse/api/errors.py (L30-L61)
 2018-08-30 23:05:51 -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