Commit graph

79 commits

Author SHA1 Message Date
Kegan Dougal 6f330bd879 Gut the old msgtypes section and replace with {{msgtype_events}} 2015-05-27 16:42:01 +01:00
Kegan Dougal f5059057b3 Update AS API docs (wording/layout tweaks, rationale). 2015-05-27 11:42:51 +01:00
Kegan Dougal 9d532f30e8 Add {{voip_events}}. Add more info on sections when asked via build.py -s 2015-05-26 17:32:51 +01:00
Kegan Dougal 89083b3a86 Add {{spec_version}}. Update build.py module docs. 2015-05-26 17:09:30 +01:00
Kegan Dougal 96671ce833 Use the templating system to set {{git_version}}. Restructure sections code.
Restructured the sections code to be slightly more encapsulated than before.
This will be expanded to more clearly separate the templating system from
the specific implementation of the spec templates.
2015-05-26 14:33:32 +01:00
Kegan Dougal ed4ce6950c Template up common event fields from the 'core' json schema file. 2015-05-21 15:51:23 +01:00
Kegan Dougal 02c44a889e Remove stuff from 20_events.rst and replace with {{room_events}}. Update gendoc to call build.py for template vars. 2015-05-20 15:40:06 +01:00
Matthew Hodgson e729a9e425 Merge pull request #16 from matrix-org/key_v2_fixes
Add minimum_valid_until_ts to key/v2 API
2015-05-20 12:55:02 +01:00
Matthew Hodgson fa1ec93c78 typo 2015-05-09 14:53:48 +01:00
Matthew Hodgson 39b3de1df3 remove AS register/unregister APIs from the spec for now, but keep the useful info intact 2015-05-09 14:49:16 +01:00
Erik Johnston 580b4a1787 Merge pull request #15 from matrix-org/csauth
Document CS API V2 auth changes and new APIs.
2015-05-07 17:55:51 +01:00
Mark Haines 9752dc399e Update 30_server_server_api.rst
Missing '$'
2015-04-28 17:49:33 +01:00
Mark Haines 9bfbbce0f4 Update 30_server_server_api.rst
Use a query parameter for minimum_valid_until_ts for the GET version of the query api.
2015-04-28 17:47:16 +01:00
Mark Haines cdcaf69fb5 Update 30_server_server_api.rst 2015-04-28 17:39:03 +01:00
David Baker deb17914ca Link syntax 2015-04-27 13:21:22 +01:00
David Baker 199bb87ffa Add link to v1 docs. 2015-04-27 13:19:47 +01:00
David Baker 3343b7f84d Clarify n-factor auth and add the diagram back in as an example 2015-04-24 13:42:02 +01:00
David Baker e7d334c5cd Kill all camels 2015-04-24 13:32:36 +01:00
David Baker 233522b612 Fix typo 2015-04-24 11:01:40 +01:00
David Baker a52819ba69 Clarify dummy auth 2015-04-24 10:20:57 +01:00
David Baker fa8d8a9f95 Remove spurious array in error example 2015-04-24 09:57:16 +01:00
David Baker cfbc58c4fb Forgot bind_email param on register. 2015-04-23 22:44:39 +01:00
Matthew Hodgson 52692931d7 fix typos 2015-04-23 22:42:10 +01:00
David Baker e52146e47f V2PREFIX 2015-04-23 22:34:33 +01:00
David Baker dd12d901af Oops: missed recaptcha. Also make list in the same order as the details. 2015-04-23 22:31:54 +01:00
David Baker b71aaddad0 Try & fix RST errors 2015-04-23 18:39:38 +01:00
David Baker c583bf9570 wrong title level 2015-04-23 18:33:24 +01:00
David Baker 8495d9451e Document CS API V2 auth changes and new APIs. 2015-04-23 18:30:15 +01:00
Matthew Hodgson 04086975bd fix header depth 2015-04-23 16:19:46 +01:00
Matthew Hodgson 4255058680 typo 2015-04-23 16:17:22 +01:00
Matthew Hodgson dacf93b405 oooooops, apparently I forgot to 'git add' these when I refactored the spec last month :-/ 2015-04-23 16:15:07 +01:00
Mark Haines 6f269890be Add a brief reference to the perspectives project and mention what should happen if a server goes offline 2015-04-23 16:06:07 +01:00
Mark Haines 0db3182159 Describe what the expired_ts is 2015-04-23 15:32:58 +01:00
Mark Haines 4422e9ca2b Add a short summary of how the v2 key api is supposed to be used 2015-04-23 15:30:57 +01:00
Mark Haines ed21f50cc3 Add version 2 of the server key distribution API 2015-04-23 15:04:22 +01:00
David Baker 3f5a94484f Update spec where I changed it to allow omiting value for highlight 2015-04-17 10:35:42 +01:00
Matthew Hodgson 0f1514febb standardise on <foo> rather than :foo 2015-03-29 08:19:40 -04:00
Matthew Hodgson c0e55bb99e make intro match order of sections as per max g-j feedback 2015-03-28 21:40:12 -04:00
David Baker 07c4d6cd21 Add append flag to pushers to support multiple accounts. 2015-03-25 16:15:17 +00:00
Matthew Hodgson c1d7e82d29 rst fail 2015-03-23 17:52:23 +00:00
Matthew Hodgson 9ff5456b5e fix sections a bit more 2015-03-23 15:55:07 +00:00
Matthew Hodgson 0c6bd900a3 fix sections a bit 2015-03-23 15:51:29 +00:00
Matthew Hodgson c3f29ea720 Merge branch 'master' into ua925_reshuffle 2015-03-23 15:36:36 +00:00
Matthew Hodgson 58c28598af lots of fixes based on kegan's review of https://github.com/matrix-org/matrix-doc/pull/13 2015-03-19 14:21:08 +01:00
Matthew Hodgson 598e9b3113 big reshuffle:
* try to make 00_basis slightly more accessible and less terse
 * move CS API before Events, as it's meaningless to dive into specific events if you haven't been introduced to how the CS API works
 * Try to improve the beginning of the CS API by merging back in some of kegan's original v1 content (which has subsequently been deleted somewhere along the line?)
 * document m.presence event consistently
 * move typing from drafts to spec
 * move push stuff from drafts to spec
...and lots of other stuff

move push & typing from drafts into main spec.
2015-03-16 00:14:03 -04:00
Matthew Hodgson d552a043f8 remove LI section entirely until we decide how best to discourage it, otherwise it looks like we're endorsing it 2015-02-19 20:23:11 +00:00
Kegan Dougal 006932c70f Be clearer when specifying the version of the spec. 2015-02-19 17:25:15 +00:00
Kegan Dougal 5a0e40b984 Mark CS API as v1 in the spec. 2015-02-19 16:36:53 +00:00
Kegan Dougal 4b0e858529 Add $GIT_VERSION to the spec which is replaced by the gendoc script. 2015-02-19 16:32:45 +00:00
Kegan Dougal 42857df26f Syntax fixes 2015-02-19 14:28:18 +00:00