Commit Graph

233 Commits (a0316f67941d845252cf9c748356be0b445cd589)

Author SHA1 Message Date
Richard van der Hoff 2fa7aac3be Merge pull request #377 from Ralith/typos
Fix typo
8 years ago
Benjamin Saunders 80bfbbdd33 Fix typo
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
Richard van der Hoff 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.
8 years ago
Richard van der Hoff 0248afe6ac login with invalid token gives a 403 8 years ago
Richard van der Hoff 1f1dfdd91c More clarifications 8 years ago
Richard van der Hoff 41368dc5a7 document CAS login
Following the spirit of "document how it is, not how we wish it was", document
the CAS login bits.
8 years ago
Richard van der Hoff 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.
8 years ago
Richard van der Hoff 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.
8 years ago
Richard van der Hoff a64f9bbb63 C-S spec: Fix 'unstable' in link to /context API 8 years ago
Richard van der Hoff b5f9e896ba C-S spec: Fix 'unstable' in link to /context API 8 years ago
Richard van der Hoff a2ab6854ff CS spec: Add r0.2.0 to historical version list 8 years ago
Richard van der Hoff 8ac45d7948 Merge pull request #353 from matrix-org/rav/room_membership
Clarify the room-membership APIs
8 years ago
Richard van der Hoff 0c06ea0e67 Merge pull request #356 from matrix-org/rav/fix_redaction
Fix name of prev_content to preserve on redactions
8 years ago
Richard van der Hoff a9d3cfd13c Merge branch 'master' into rav/link_undeprecated_endpoints 8 years ago
Richard van der Hoff d92515bce3 Merge pull request #354 from matrix-org/rav/reorder_deprecated_initialsync
Move /room/x/initialSync to after the undeprecated APIs
8 years ago
Richard van der Hoff d8a47dbb5d Merge pull request #352 from matrix-org/rav/kill_old_sync
Remove references to intialSync etc, and rewrite syncing
8 years ago
Richard van der Hoff 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).
8 years ago
Richard van der Hoff 1c6eed5c35 Fix name of prev_content to preserve on redactions
The field is called prev_content, not prev_state.
8 years ago
Richard van der Hoff 6bcb1798f5 Mark deprecated endpoints with their replacements
Fixes https://matrix.org/jira/browse/SPEC-415
8 years ago
Richard van der Hoff 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.
8 years ago
Richard van der Hoff 4118ce6680 Add rationale to /sync 8 years ago
Richard van der Hoff 7186ecba7f Clarify the room-membership APIs
* give join/invite their own subsection
* move ban/unban into the banning section
* document forgettting and kicking
8 years ago
Richard van der Hoff 017935d8e9 Fix typo 8 years ago
Richard van der Hoff 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).
8 years ago
David Baker 4812be9142 Missing . 9 years ago
David Baker ead5648b8c Add requestToken endpoints
For password reset and 3pid adding
9 years ago
David Baker e4db7be8e2 Better structure for error response
& add server not trusted error
9 years ago
David Baker 572aa24a88 Add M_THREEPID_IN_USE 9 years ago
David Baker ec69f04793 Merge pull request #337 from matrix-org/rav/directory_docs
Improve documentation of directory API
9 years ago
Richard van der Hoff 7bbb664784 Improve documentation of directory API 9 years ago
David 92bb1c1b43 Update wording as per request from richvdh 9 years ago
David a7e40bed88 Add powerlevel name to value list 9 years ago
Richard van der Hoff 099d356dfb Add r0.1.0 to version list in C-S spec 9 years ago
Richard van der Hoff e7e9f5fa46 Document the /logout api
We have one, and it's useful, so we really ought to document it
9 years ago
Richard van der Hoff 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
9 years ago
Richard van der Hoff 351bbee016 Remove changelog from index.rst
... since it's explicitly unversioned.
9 years ago
Richard van der Hoff 7d20d2d903 Add old-version links to C-S API 9 years ago
Daniel Wagner-Hall f4f186baee Add _cs suffix to client-server http APIs
I'm about to add identity service APIs, so differentiating is good.
9 years ago
Mark Haines cc0dae3aeb Deduplicate a couple of places where "the" was written twice in a row 9 years ago
Daniel Wagner-Hall 0da26cd7e1 Specify login behaviour for unknown 3pids 9 years ago
Mark Haines 245e8e8571 Add 3pid password login to the spec 9 years ago
Daniel Wagner-Hall 2e46b587b8 Require explicit un-banning 9 years ago
David Baker 169cc98101 M_INVALID_USERNAME to be consistent with the name of the parameter 9 years ago
David Baker 2301a792d7 Add an error code for invalid user names. 9 years ago
Daniel Wagner-Hall 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.
9 years ago
Daniel Wagner-Hall 5e30d75ccb Add /_matrix/versions to spec 9 years ago
Daniel Wagner-Hall 678dbbe08a s/-/_/ 9 years ago
Daniel Wagner-Hall 4be078440d Don't mention server-server stuff in client-server spec 9 years ago
Daniel Wagner-Hall 217e22fc30 Format changelog more nicely 9 years ago
Daniel Wagner-Hall 19dfafe376 Remove superfluous space
This causes a <dt> to get rendered around the <tt>s which breaks some
formatting.
9 years ago
Daniel Wagner-Hall 39f43abbb7 Add per-API changelogs 9 years ago
Daniel Wagner-Hall 705556634a Add filters 9 years ago
Daniel Wagner-Hall 873b0dcecf Replace version numbers with release numbers 9 years ago
Daniel Wagner-Hall 19ce17cfed Merge pull request #200 from matrix-org/daniel/redact
Merge pull request #200 from matrix-org/daniel/redact
9 years ago
Daniel Wagner-Hall 2f3a00fe34 Consistently spell homeserver as homeserver 9 years ago
Daniel Wagner-Hall e072d215cf Specify redaction 9 years ago
Daniel Wagner-Hall c6e0322a9e Swaggerify /account 9 years ago
Daniel Wagner-Hall 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.
9 years ago
Daniel Wagner-Hall b479b54cd8 Add tables of contents to individual specs 9 years ago
Daniel Wagner-Hall bc514dc9c4 Merge pull request #178 from matrix-org/daniel/directory
Fix and include /directory api docs
9 years ago
Daniel Wagner-Hall 7f2813354d Swaggerify /ban 9 years ago
Daniel Wagner-Hall ad4d8ae7a6 Move client-server intro to client-server section 9 years ago
Daniel Wagner-Hall c25a806cef Fix and include /directory api docs 9 years ago
Daniel Wagner-Hall 8201eaa042 Swaggerify /rooms/:room_id/leave 9 years ago
Daniel Wagner-Hall d7357ef9b7 Specify /publicRooms 9 years ago
Richard van der Hoff 13eddd456f Proposal for adding full_state param to v2 sync 9 years ago
Erik Johnston 696f75d80b Rename section 9 years ago
Erik Johnston 3cf431cac1 Add link 9 years ago
Erik Johnston 9a5bd6d21f Use static 9 years ago
Erik Johnston 98dbf4d60b Better flow 9 years ago
Erik Johnston 0529b4a9a2 Reword 9 years ago
Erik Johnston 88c459d549 Add back in login v1 fallback API 9 years ago
Richard van der Hoff f47a49de43 Merge pull request #126 from matrix-org/rav/send_events_api
Add the room send and state APIs to the spec
9 years ago
Richard van der Hoff 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
9 years ago
Mark Haines 1d7cb6937f Merge pull request #123 from matrix-org/markjh/list_formatting
Fix list formatting
9 years ago
Richard van der Hoff 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.
9 years ago
Richard van der Hoff d18d406c41 Add the room send and state APIs to the spec 9 years ago
Mark Haines e3e8026025 Fix list formatting so that we aren't including everything in blockquotes 9 years ago
Daniel Wagner-Hall 74d42f0142 Allow rejecting invitations 9 years ago
Kegan Dougal 26f27d95fb Merge branch 'master' into registration-swagger
Conflicts:
	specification/client_server_api.rst
9 years ago
Kegan Dougal 62d53b4f33 Review comments round III 9 years ago
Kegan Dougal 85a6a5a530 Merge branch 'master' into proofing 9 years ago
Kegan Dougal 3d087df538 Kill number prefixes for good 9 years ago