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
6dfc923c1d
Remove references to intialSync etc, and rewrite syncing
...
The 'Events' section of the C-S spec was full of outdated references to the v1
sync api, which is long dead. (https://matrix.org/jira/browse/SPEC-414 ).
Also, try to clarify why /sync distinguishes state and timeline
(https://matrix.org/jira/browse/SPEC-423 ).
2016-07-12 13:10:36 +01:00
4812be9142
Missing .
2016-07-07 15:58:20 +01:00
ead5648b8c
Add requestToken endpoints
...
For password reset and 3pid adding
2016-07-07 14:52:45 +01:00
e4db7be8e2
Better structure for error response
...
& add server not trusted error
2016-06-30 16:22:01 +01:00
572aa24a88
Add M_THREEPID_IN_USE
2016-06-30 15:40:20 +01:00
ec69f04793
Merge pull request #337 from matrix-org/rav/directory_docs
...
Improve documentation of directory API
2016-06-16 14:14:00 +01:00
7bbb664784
Improve documentation of directory API
2016-06-16 13:58:45 +01:00
92bb1c1b43
Update wording as per request from richvdh
2016-06-13 22:59:52 +08:00
a7e40bed88
Add powerlevel name to value list
2016-06-13 10:34:16 +08:00
099d356dfb
Add r0.1.0 to version list in C-S spec
2016-05-13 10:35:22 +01:00
e7e9f5fa46
Document the /logout api
...
We have one, and it's useful, so we really ought to document it
2016-05-08 22:26:49 +01:00
3bce28a15c
Clarifications to the 'Client authentication' section
...
* Use the terminology 'login type' everywhere instead of mixing up 'stage type'
and 'login type'
* Don't have a separate 'APIs using the User-Interactive Authentication
mechanism' section, because (a) it doesn't make much sense to organise the
APIs this way, and (b) it was a set of lies anyway.
* Move '/account/password' definition into registration.yaml so that register
and password can share a section in the spec; remove duplicate doc for
/password.
* Write some words on using 3pids for /login
2016-05-06 17:28:35 +01:00
351bbee016
Remove changelog from index.rst
...
... since it's explicitly unversioned.
2016-05-05 15:23:21 +01:00
7d20d2d903
Add old-version links to C-S API
2016-05-05 15:22:39 +01:00
f4f186baee
Add _cs suffix to client-server http APIs
...
I'm about to add identity service APIs, so differentiating is good.
2016-03-08 17:42:41 +00:00
cc0dae3aeb
Deduplicate a couple of places where "the" was written twice in a row
2016-03-07 11:31:49 +00:00
0da26cd7e1
Specify login behaviour for unknown 3pids
2016-01-29 16:49:54 +00:00
245e8e8571
Add 3pid password login to the spec
2016-01-29 14:42:18 +00:00
2e46b587b8
Require explicit un-banning
2016-01-15 14:08:40 +00:00
169cc98101
M_INVALID_USERNAME to be consistent with the name of the parameter
2016-01-15 10:04:29 +00:00
2301a792d7
Add an error code for invalid user names.
2016-01-14 17:19:04 +00:00
1e2b63763e
/join and /room/:roomId/join aren't exact aliases
...
Separate them, clarify their differences.
Also, fix some links which weren't being properly populated.
2016-01-13 15:55:51 +00:00
5e30d75ccb
Add /_matrix/versions to spec
2016-01-06 17:43:20 +00:00
678dbbe08a
s/-/_/
2015-12-09 17:17:45 +00:00
4be078440d
Don't mention server-server stuff in client-server spec
2015-12-08 15:42:37 +00:00
217e22fc30
Format changelog more nicely
2015-12-08 13:18:36 +00:00
19dfafe376
Remove superfluous space
...
This causes a <dt> to get rendered around the <tt>s which breaks some
formatting.
2015-12-08 10:34:48 +00:00
39f43abbb7
Add per-API changelogs
2015-12-07 14:24:10 +00:00
705556634a
Add filters
2015-12-04 19:46:45 +00:00
873b0dcecf
Replace version numbers with release numbers
2015-12-04 11:09:35 +00:00
19ce17cfed
Merge pull request #200 from matrix-org/daniel/redact
...
Merge pull request #200 from matrix-org/daniel/redact
2015-12-03 15:57:52 +00:00
2f3a00fe34
Consistently spell homeserver as homeserver
2015-12-02 19:23:33 +00:00
e072d215cf
Specify redaction
2015-12-02 15:27:25 +00:00
c6e0322a9e
Swaggerify /account
2015-12-01 13:53:03 +00:00
6c66bfc755
Flatten out v1 and v2_alpha directories
...
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
2015-11-30 11:22:57 +00:00
b479b54cd8
Add tables of contents to individual specs
2015-11-27 18:52:58 +00:00
bc514dc9c4
Merge pull request #178 from matrix-org/daniel/directory
...
Fix and include /directory api docs
2015-11-27 16:21:15 +00:00
7f2813354d
Swaggerify /ban
2015-11-27 15:42:21 +00:00
ad4d8ae7a6
Move client-server intro to client-server section
2015-11-27 13:50:24 +00:00
c25a806cef
Fix and include /directory api docs
2015-11-26 15:03:39 +00:00
8201eaa042
Swaggerify /rooms/:room_id/leave
2015-11-17 15:31:10 +00:00
d7357ef9b7
Specify /publicRooms
2015-11-11 11:39:40 +00:00
13eddd456f
Proposal for adding full_state param to v2 sync
2015-10-26 15:52:45 +00:00
696f75d80b
Rename section
2015-10-26 14:14:13 +00:00
3cf431cac1
Add link
2015-10-26 14:10:02 +00:00
9a5bd6d21f
Use static
2015-10-26 13:56:07 +00:00
98dbf4d60b
Better flow
2015-10-26 13:46:41 +00:00
0529b4a9a2
Reword
2015-10-26 13:45:36 +00:00
88c459d549
Add back in login v1 fallback API
2015-10-26 13:40:24 +00:00
f47a49de43
Merge pull request #126 from matrix-org/rav/send_events_api
...
Add the room send and state APIs to the spec
2015-10-23 17:05:30 +01:00
1945697456
Further tweaks to the room send and state APIs
...
- fix confusion re empty/absent state_keys
- move 'types of room events' section earlier in the 'Events' section
- remove some redundant anchors
2015-10-23 16:58:55 +01:00
1d7cb6937f
Merge pull request #123 from matrix-org/markjh/list_formatting
...
Fix list formatting
2015-10-23 16:53:29 +01:00
28ab643a4e
Remove duplicated registration/login APIs
...
Currently the spec duplicates all of the account-management APIs. There's still
work to be done here, but the complete duplication is confusing.
2015-10-23 15:56:48 +01:00
d18d406c41
Add the room send and state APIs to the spec
2015-10-23 13:08:42 +01:00
e3e8026025
Fix list formatting so that we aren't including everything in blockquotes
2015-10-23 10:51:31 +01:00
74d42f0142
Allow rejecting invitations
2015-10-20 11:08:22 +01:00
26f27d95fb
Merge branch 'master' into registration-swagger
...
Conflicts:
specification/client_server_api.rst
2015-10-19 13:34:41 +01:00
62d53b4f33
Review comments round III
2015-10-16 15:58:11 +01:00
85a6a5a530
Merge branch 'master' into proofing
2015-10-16 15:23:07 +01:00
3d087df538
Kill number prefixes for good
2015-10-15 13:40:05 +01:00
Richard van der Hoff