0
0
Fork 0
Commit Graph

1400 Commits

Author SHA1 Message Date
Mark Haines c83e8480e8 Fix JSON syntax 2015-07-24 15:55:21 +01:00
Mark Haines 6597aaa448 Start describing the plaintext payload format for encrypted messages, add the exact URLs used for key queries from clients and for key queries for federation 2015-07-24 11:21:14 +01:00
Mark Haines 41d204e72c Name the key 'ciphertext' rather than 'ciphertexts' 2015-07-24 09:43:46 +01:00
Mark Haines 6f69707c71 Update e2e spec: Group ciphertext by device key rather than device id, add return to docs for /keys/upload, Use "m.room.encrypted" for now, rather than trying to add an encrypted content to arbitrary event types 2015-07-17 19:30:36 +01:00
Mark Haines 42ad1f8612 Add a link to signing JSON section of the spec. Fixup the markup a bit 2015-07-14 09:38:08 +01:00
Mark Haines 01927cee9b Rename "take" to "claim". Hyphenate "one-time". 2015-07-14 09:21:25 +01:00
Mark Haines 36e035c79e Add some specification for end-to-end 2015-07-13 19:31:11 +01:00
Matthew Hodgson f08588bf7e typo 2015-07-09 23:17:38 +01:00
Paul "LeoNerd" Evans 5f391b5617 Also document the directory server federation API 2015-07-09 20:28:48 +01:00
Paul "LeoNerd" Evans fc1e01f373 Add a small note about the meaning of the 'target' field 2015-07-09 19:52:34 +01:00
Paul "LeoNerd" Evans af1616ba9a Merge branch 'master' into paul/fixes 2015-07-09 19:52:03 +01:00
Paul "LeoNerd" Evans 28894ac1b7 Bugfix to embedded sign_json() python code 2015-07-03 20:11:27 +01:00
Paul "LeoNerd" Evans 9b046cbc04 Tiny fix to embedded YAML fragment 2015-06-08 18:21:11 +01:00
Kegan Dougal e572cc662a Restructure the first few sections.
Remove unecessary sections; put presnece/profile sections on the right level.
Move Living Standard warning to the top of the Introduction section.
2015-06-02 16:27:52 +01:00
Kegan Dougal 71e200a063 Remove version section. 2015-06-02 16:12:23 +01:00
Kegan Dougal e10859a887 Replace presence API with new template. 2015-06-02 16:01:26 +01:00
Kegan Dougal ec631c60d4 Add link to github commit for the spec as per request. 2015-06-02 13:48:52 +01:00
Kegan Dougal bb9537b824 Add a CHANGELOG. Modify table CSS.
Hook up templating system to read the CHANGELOG for version and changelog info.
Modified nature.css to make it clearer on table headings/sub-headings. Use the
full _matrix/client path on title links to make it clear it is for v1.
2015-06-01 17:48:16 +01:00
Kegan Dougal f134728268 Link to msgtypes from the description of m.room.message. 2015-05-28 11:57:44 +01:00
Kegan Dougal 51df65bb49 Remove old power level references. Link to m.room.power_levels. 2015-05-28 11:30:48 +01:00
Kegan Dougal ac7ccfa622 Add {{presence_events}}. Factor out common code in MatrixSections. 2015-05-28 10:45:00 +01:00
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
Kegsay 8e75c5ed67 Add in passive application services 2015-02-19 14:17:31 +00:00
Kegan Dougal f60c0ac96b Fix indentation levels on specification. 2015-02-19 13:42:01 +00:00
Paul "LeoNerd" Evans a9a4c46a57 Add spec for m.notice (SPEC-18) 2015-01-21 18:26:27 +00:00
Kegan Dougal 62471348ca This is a comment, not a directive. Remove :: 2015-01-20 16:58:22 +00:00
Kegan Dougal 109c8a97a8 Use title heading sizings of =,-,~,+ since that is what most of our docs use. Inconsistent use breaks when you try to merge them. 2015-01-20 16:36:32 +00:00
Matthew Hodgson 5d177b0e18 mention event deduplication 2014-12-24 19:56:20 +00:00
Matthew Hodgson cef1e784f9 general editing throughout the overview section; merge in bits of erik's model to overview section and split the original back out into drats 2014-11-17 21:08:36 -08:00
Matthew Hodgson e2b49cc20f remove spurious sender_ts info and spec out m.file 2014-11-17 01:11:30 +00:00
Matthew Hodgson b3f99f9bf7 typo 2014-11-17 01:11:30 +00:00
Mark Haines 3fd1833bc5 Add more reasonable example for unsigned data in json signing example 2014-11-12 14:23:40 +00:00
Matthew Hodgson 2d5bb01a63 add in version, improve AS API a bit, move eventstream to the right place 2014-11-12 15:32:47 +02:00
Mark Haines b2295b9bc7 Add docs on server discovery 2014-11-12 12:01:56 +00:00
Mark Haines b7708a9b88 Move the request signing docs to the right bit of the spec 2014-11-12 11:02:06 +00:00
Mark Haines 3873a219f9 SPEC-33: Add server to server request authorization to the specification 2014-11-12 10:38:57 +00:00
Matthew Hodgson f4df22f7ef shuffle the server-server chapters a bit, and split out security model and other miscellanei into a new appendices chapter. Add a vestigial application services section 2014-11-11 21:13:09 +02:00
Matthew Hodgson 2c9707633e tone down warning 2014-11-11 21:11:01 +02:00
Matthew Hodgson 2f1f37cc4c formatting, whitespace, and some rephrasing for clarity 2014-11-11 20:24:22 +02:00
Matthew Hodgson 64f56a15d7 fix english and whitespace 2014-11-11 18:15:06 +00:00
Mark Haines e5cb7aae07 Add some documentation for event signing 2014-11-06 18:41:30 +00:00
Mark Haines b73645ad8f Try turning on syntax high-lighting for JSON examples 2014-10-24 16:35:47 +01:00
Mark Haines 19e326d305 Reword introduction to federation API to mention event signing 2014-10-24 12:51:12 +01:00
Mark Haines 36fa322c5d Improve formatting and update PDU and transaction key names 2014-10-23 10:51:30 +01:00
Mark Haines 5e4b8798a4 Nicer formatting for the PDU field documentation 2014-10-20 16:30:36 +01:00
Mark Haines ae27cbe1a4 Put client-server links into the correct file 2014-10-20 11:59:36 +01:00
Mark Haines 7e244e8a0d remove trailing whitespace 2014-10-20 11:57:52 +01:00
Oddvar Lovaas 969cc408f1 Spelling and removing WIP warnings (as everything is equally WIP) 2014-10-17 19:08:37 +01:00
Matthew Hodgson eeb596b20b merge core_model into spec 2014-10-17 18:56:49 +01:00
Matthew Hodgson 8b4a35e341 as per the big spec meeting, split specification.rst into 4 chapters. merge in specification-NOTHAVE and spec-additions.rst whilst at it. 2014-10-10 01:38:04 +02:00
Matthew Hodgson 556e3f8a71 move matrix-generic documentation from synapse/docs into new matrix-doc project 2014-10-09 20:30:40 +02:00