Commit graph

519 commits

Author SHA1 Message Date
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).
2016-07-12 17:28:30 +01:00
Richard van der Hoff
885e6797f2 Fix double-negative in room naming 2016-07-12 14:50:49 +01:00
Richard van der Hoff
7b4c21fa77 Add link to room name bug 2016-07-12 11:47:39 +01:00
Richard van der Hoff
d4194dd24e Clarify the room-naming behaviour
Make behaviour on empty `m.room.name` and `m.room.canonical_alias` events
explicit.
2016-07-11 17:49:27 +01:00
David Baker
4812be9142 Missing . 2016-07-07 15:58:20 +01:00
David Baker
ead5648b8c Add requestToken endpoints
For password reset and 3pid adding
2016-07-07 14:52:45 +01:00
David Baker
ef4c03894d Merge pull request #343 from matrix-org/dbkr/threepid_requesttoken
Spec for endpoint-specific 3pid verification token
2016-07-05 15:17:18 +01:00
Richard van der Hoff
df3f4b4ecf Fix link to draft e2e spec 2016-06-30 18:01:32 +01:00
David Baker
e4db7be8e2 Better structure for error response
& add server not trusted error
2016-06-30 16:22:01 +01:00
David Baker
572aa24a88 Add M_THREEPID_IN_USE 2016-06-30 15:40:20 +01:00
David Baker
b0194a3016 Spec for endpoint-specific 3pid verification token
As per proposal https://docs.google.com/document/d/13mapDbaOnbob9ZYRDiGm1YbeZhFOBj_R1OvgBA9pA5s/edit?pref=2&pli=1#
2016-06-30 14:50:17 +01:00
Mark Haines
af091ff614 Document changes to the default push rules 2016-06-22 16:34:23 +01:00
Mark Haines
30a3302921 Merge pull request #274 from matrix-org/markjh/default_rules
Update the predefined push rules in the spec
2016-06-22 16:14:21 +01:00
Erik Johnston
e80e32173f Merge pull request #278 from matrix-org/erikj/presence
Update presence spec.
2016-06-22 14:08:44 +01:00
David Baker
ec69f04793 Merge pull request #337 from matrix-org/rav/directory_docs
Improve documentation of directory API
2016-06-16 14:14:00 +01:00
Richard van der Hoff
7bbb664784 Improve documentation of directory API 2016-06-16 13:58:45 +01:00
David
92bb1c1b43 Update wording as per request from richvdh 2016-06-13 22:59:52 +08:00
David
a7e40bed88 Add powerlevel name to value list 2016-06-13 10:34:16 +08:00
Richard van der Hoff
099d356dfb Add r0.1.0 to version list in C-S spec 2016-05-13 10:35:22 +01:00
Richard van der Hoff
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
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
2016-05-06 17:28:35 +01:00
Richard van der Hoff
5cc9066159 Add git versions to other parts of the spec 2016-05-06 09:49:26 +01:00
Richard van der Hoff
01f8173c84 Put each bit of spec in its own directory
I want to change the URLs for the spec sections on the website from
<version>/<section>.html to <section>/<version>.html, to better reflect how we
do the versioning.

This puts each bit of spec in its own directory, updates the index to point to
the right place, and fixes continuserv to deal with directories as well as
files.

This will probably require fixes to the speculator too, but I'll have to come
back to that.
2016-05-05 18:26:17 +01:00
Richard van der Hoff
351bbee016 Remove changelog from index.rst
... since it's explicitly unversioned.
2016-05-05 15:23:21 +01:00
Richard van der Hoff
7d20d2d903 Add old-version links to C-S API 2016-05-05 15:22:39 +01:00
Richard van der Hoff
5b010de2b3 Fix typo 2016-05-05 15:15:39 +01:00
Richard van der Hoff
e68193d2e0 Attempt to clarify the spec versioning. Again. 2016-05-05 15:03:04 +01:00
Matthew Hodgson
17b8fccd4c rephrase intro 2016-05-05 14:00:53 +01:00
Jimmy Cuadra
c44d61b3a9 Clarify which documents are generated from scripts. 2016-05-04 02:30:44 -07:00
Jimmy Cuadra
22b542e3f9 Fix grammar in spec index. 2016-05-04 02:27:29 -07:00
Jimmy Cuadra
5b18db9096 Make list of APIs on the index a table. 2016-05-04 01:42:01 -07:00
Jimmy Cuadra
4b27d6a7a4 Reorganize spec index. 2016-05-04 01:42:01 -07:00
Richard van der Hoff
cd4e7306ca Merge pull request #305 from matrix-org/rav/show_own_leave_event
Clarify `history_visibility` behaviour
2016-04-08 11:47:17 +01:00
David Baker
71cb646541 Change id in the push gateway poke to be event_id and spec that it's the Matrix event ID of the message. Correct the spec for badge count pushes which omit fields previously described as mandatory. Add more detail about when to use event_id to suppress dupes. Also add the push gateway doc so it's actually included in the spec. 2016-04-06 18:28:21 +01:00
Richard van der Hoff
b59d16c4d1 Clarify history_visibility behaviour
Clear up some lies in the history_visibility section, and clarify behaviour for
`m.room.history_visibility` and the user's own `m.room.member` events.
2016-04-06 17:55:01 +01:00
Daniel Wagner-Hall
313f09f5c0 Specify address validating and binding 2016-03-10 16:54:38 +00:00
Kegsay
506accee27 Merge pull request #288 from matrix-org/markjh/pushrule_stream
Add a snippet of documentation for a m.push_rules event.
2016-03-10 14:05:42 +00:00
Daniel Wagner-Hall
fecff8afdc Specify association lookup 2016-03-10 13:59:34 +00:00
Daniel Wagner-Hall
30c9fee0b2 Specify ephemeral invitation signing 2016-03-10 13:57:45 +00:00
Daniel Wagner-Hall
097b69dc1e Loosely specify invitation storage 2016-03-09 17:27:44 +00:00
Daniel Wagner-Hall
e0c55eeccf Add initial identity server spec
More to come
2016-03-09 15:49:23 +00:00
Daniel Wagner-Hall
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
Mark Haines
c3c95d0c09 Fix grammar and add backticks for /sync 2016-03-08 10:17:27 +00:00
Mark Haines
cc0dae3aeb Deduplicate a couple of places where "the" was written twice in a row 2016-03-07 11:31:49 +00:00
Mark Haines
5407cc8e05 Add a snippet of documentation for a m.push_rules event. 2016-03-04 14:41:30 +00:00
Erik Johnston
3d4d91a462 Reword to make sense 2016-03-01 16:15:59 +00:00
Erik Johnston
167a08a805 Allow idle timeout to be configurable 2016-03-01 16:13:41 +00:00
Erik Johnston
bc68177471 Grammar 2016-03-01 16:07:25 +00:00
Erik Johnston
f1a8306d08 Spec currently_active time and idle timeout behaviour 2016-02-23 11:25:47 +00:00
Richard van der Hoff
68a4306773 Split room previews into a separate module
Guest access and room peeking are orthogonal
2016-02-19 15:26:28 +00:00