48569c2156
Merge pull request #1853 from matrix-org/anoa/3pid_typos
...
Replace "3pid" with "3PID"
2019-02-11 15:11:28 +00:00
df7223f992
Add changelogs
2019-02-11 10:02:05 +00:00
5721712eae
Add M_RESOURCE_LIMIT_EXCEEDED
...
Original proposal: https://github.com/matrix-org/matrix-doc/issues/1504
No changes from the original proposal or implementations have been made intentionally here.
2019-02-10 17:47:17 -07:00
85578f9842
Fix spelling mistake: endponts -> endpoints
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1677
2019-02-06 22:19:47 -07:00
4ec3a43a85
Replace "3pid" with "3PID"
2019-02-05 12:58:11 +00:00
fe7f582233
Fix several spelling mistakes
...
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2019-02-01 16:43:46 -06:00
d94a70f49d
Warn clients about changes in event format
2019-02-01 08:40:18 -07:00
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
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
d6c33ea0a5
Make CAS a subset of SSO
2019-01-09 14:41:46 -07:00
3e7a5f5ea4
Initial draft for SSO support
2019-01-09 00:09:38 -07:00
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
735de03e07
Add r0 version links
...
These were missed in the release process.
2018-08-31 17:40:32 -06:00
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
7ac76fa27c
Actually we're going with "identity server" afterall
2018-08-31 15:04:00 -06:00
ec248b436f
Identity Service is lowercase
2018-08-31 15:04:00 -06:00
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
835f5de387
Generalize the token name even more
2018-08-31 14:22:07 -06:00
f299fe023a
English
2018-08-31 12:51:31 -06:00
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
3146fc339a
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/clarify-errors
2018-08-31 11:15:03 -06:00
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
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
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
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
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
5019fb7c49
Merge pull request #1359 from uhoreg/well-known
...
.well-known discovery
2018-08-29 10:40:54 -04:00
3869f68a5c
Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions
2018-08-21 12:22:35 -06:00
6612dbecf1
tweak wording for validation
2018-08-17 11:54:14 -04:00
d6c54b0278
unaccessible isn't a word
2018-08-15 16:39:01 -06:00
ca87876f1b
Clarify that the Authorization header is preferred
2018-08-15 16:37:52 -06:00
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
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
a264120b38
put server discovery as its own section
2018-08-14 18:06:03 -04:00
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
6a3cf10be9
Merge remote-tracking branch 'origin/master' into well-known
2018-08-14 17:00:56 -04:00
292d334509
document new login identifier object ( #1390 )
2018-08-10 16:19:17 -04:00
07aeaadef9
update links which used to point to docs/spec/intro
2018-07-24 11:41:03 +01:00
423d5593f5
Generify how OPTIONS and CORS are handled
2018-07-09 15:40:03 -06:00
ce1e2c0904
incorporate feedback from reviewers
2018-07-04 17:58:37 -04:00
0779d81e52
Clarify which requests should have CORS headers
...
Spoilers: all of them.
2018-07-04 14:30:39 -06:00
4ca54404fa
Document the CORS/preflight headers
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1006
2018-07-03 16:15:55 -06:00
0dd330962d
initial draft of .well-known discovery
2018-07-03 14:14:26 -04:00
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
4d90d2b495
fix depr link
2018-02-07 08:26:27 +00:00
7e94cd5a0b
Typo in client-server spec: ether -> either
2018-01-20 19:15:01 +13:00
784adade9b
changes based on Pull Request feedback
2017-12-21 17:45:26 +00:00
3d8fe6e090
merge profiles with user directory into user data, also fix typo
2017-12-18 17:01:52 +00:00
97445195f6
add user_directory
2017-12-17 23:42:44 +00:00
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
0ce58fdb28
Prepare for next spec dev cycle
2017-11-15 16:23:14 +00:00
b1801ea6db
Spec /account/whoami
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
2017-11-12 23:49:40 -07:00
c2b1b7a10e
mention that we can send tokens via headers
2017-10-27 09:52:53 +01:00
6b23b7fc0b
Merge branch 'client_server/r0.2.0_updates'
2017-10-24 23:26:56 +01:00
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
a8afbfd27d
Avoid external link in search swagger
2017-10-15 23:01:54 +01:00
bf3b49f13c
document joined_members and joined_rooms endpoints ( #999 )
2017-10-10 16:16:27 +01:00
1e3f5683c8
Make clear that the /sync timeout is zero by default
2017-08-31 16:56:50 +01:00
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
da6938b818
Key management APIs ( #894 )
...
Spec the e2e key-management APIs.
2017-04-20 16:51:42 +01:00
8a9629167a
httpsify the speculator link
2016-11-27 17:28:56 +00:00
461bfdb0d8
Merge branch 'master' into rav/device_management
2016-11-09 14:34:04 +00:00
22777970da
Fix speculator link
...
the link to the 'latest version' was broken
2016-10-13 17:56:53 +01:00
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
cbc5774ade
JSON key names also use underscores.
2016-10-12 11:37:41 +01:00
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
6c88d698ae
uia fallback example: check event origin
2016-10-07 16:26:28 +01:00
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
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
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
2a987c3369
Linkify endpoints properly
2016-10-05 18:19:17 +01:00
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
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
f4c7fdfd03
Remove references to refresh tokens and tokenrefresh
...
refresh tokens are dead.
2016-10-03 17:05:56 +01:00
ebaaa7e3b3
Review feedback
...
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
2016-09-29 13:18:45 +01:00
cade909e25
Fix inconsistencies regarding redacted_because
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
2016-08-30 21:18:55 -07:00
77b668a5dc
Fix some obsolete uses of user_id key in events
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
2016-08-26 23:06:41 -07:00
2fa7aac3be
Merge pull request #377 from Ralith/typos
...
Fix typo
2016-08-26 10:28:52 +01:00
80bfbbdd33
Fix typo
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
2016-08-26 02:23:16 -07:00
c51c4acf7f
Clarifications to authentication mechanisms
...
* Make the purpose of the `auth` key in /register requests explicit, and say
that it should be empty at first.
* Restructure the UA-auth section a bit.
* In the UA-auth section, say that clients should submit no `auth` to start
with, and add 'Stage 0' representing this to the example.
* s/{stage,login} type/authentication type/ in the UA-auth section. Seems
clearer to me.
* Try to distinguish the example responses from the example requests by giving
an HTTP header.
2016-08-15 10:28:15 +01:00
0248afe6ac
login with invalid token gives a 403
2016-08-09 16:28:29 +01:00
1f1dfdd91c
More clarifications
2016-08-09 15:51:12 +01:00
41368dc5a7
document CAS login
...
Following the spirit of "document how it is, not how we wish it was", document
the CAS login bits.
2016-08-08 17:33:48 +01:00
ec20f15407
/tokenrefresh should expire the access token
...
It's possible for clients to call /tokenrefresh before the access_token has
expired, potentially leading to a proliferation of valid access_tokens.
2016-07-19 09:17:14 +01:00
2370a4c970
Spell out the state algorithm for createRoom
...
Fixes https://matrix.org/jira/browse/SPEC-429 .
Synapse currently follows the specified ordering, but does *not* give the
specified error when the state is invalid (instead it creates the room anyway
but gives a 403 M_FORBIDDEN). Still, I don't think that should be a real
problem for any real clients, and nothing would break if we changed this in
synapse, so it might as well go in the spec anyway.
2016-07-18 13:01:45 +01:00
a64f9bbb63
C-S spec: Fix 'unstable' in link to /context API
2016-07-14 16:23:59 +01:00
b5f9e896ba
C-S spec: Fix 'unstable' in link to /context API
2016-07-14 16:20:59 +01:00
a2ab6854ff
CS spec: Add r0.2.0 to historical version list
2016-07-14 15:40:49 +01:00
8ac45d7948
Merge pull request #353 from matrix-org/rav/room_membership
...
Clarify the room-membership APIs
2016-07-13 11:34:14 +01:00
0c06ea0e67
Merge pull request #356 from matrix-org/rav/fix_redaction
...
Fix name of prev_content to preserve on redactions
2016-07-13 11:14:07 +01:00
a9d3cfd13c
Merge branch 'master' into rav/link_undeprecated_endpoints
2016-07-13 11:09:53 +01:00
d92515bce3
Merge pull request #354 from matrix-org/rav/reorder_deprecated_initialsync
...
Move /room/x/initialSync to after the undeprecated APIs
2016-07-13 11:07:11 +01:00
d8a47dbb5d
Merge pull request #352 from matrix-org/rav/kill_old_sync
...
Remove references to intialSync etc, and rewrite syncing
2016-07-13 10:54:02 +01:00
49cd65dd58
Add a license to the spec
...
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
2016-07-12 17:28:30 +01:00
1c6eed5c35
Fix name of prev_content to preserve on redactions
...
The field is called prev_content, not prev_state.
2016-07-12 16:34:16 +01:00
6bcb1798f5
Mark deprecated endpoints with their replacements
...
Fixes https://matrix.org/jira/browse/SPEC-415
2016-07-12 16:18:48 +01:00
9d267795e0
Move /room/x/initialSync to after the undeprecated APIs
...
It's a bit incongruous to have to read through the deprecated /initialSync to
get to the good stuff. Separate out intialSync so that we can move it later in
the spec.
2016-07-12 15:03:20 +01:00
4118ce6680
Add rationale to /sync
2016-07-12 14:48:03 +01:00
7186ecba7f
Clarify the room-membership APIs
...
* give join/invite their own subsection
* move ban/unban into the banning section
* document forgettting and kicking
2016-07-12 14:18:48 +01:00
017935d8e9
Fix typo
2016-07-12 14:15:52 +01:00
Andrew Morgan