Commit Graph

1417 Commits (9599c3bc99bd1e7a2914d868f7349da4e9707b6f)

Author SHA1 Message Date
Daniel Wagner-Hall b8e2ac5c1b Swaggerify /login 9 years ago
Kegsay e788f565f8 Merge pull request #36 from matrix-org/daniel/threepidinvites
Swagger /room/{roomId}/invite
9 years ago
Kegsay 3011823c51 Merge pull request #27 from matrix-org/receipts
Document receipts
9 years ago
Daniel Wagner-Hall 2797fac3aa Swagger /room/{roomId}/invite
This is a transcription of the current spec, with nothing new or
controversial in it.
9 years ago
Daniel Wagner-Hall 04b2b2588f Fix up formatting and typos 9 years ago
Daniel Wagner-Hall d53943c8c2 Spec /room/{roomId}/join
This is just replacing the existing spec with a swagger version.

Subsequent pull requests will add 3pid join to this, as well as specing
the invite, leave, ban, and kick endpoints.
9 years ago
Erik Johnston 80bb51d9bb Make it clearer 9 years ago
Erik Johnston 4b24b887c7 Document m.room.history_visibility 9 years ago
Erik Johnston 83dfc2bf61 Fix some mistakes/typos 9 years ago
Erik Johnston 0dc22e7217 Document receipts 9 years ago
Paul "LeoNerd" Evans 49c52a96a7 Rename 'perspective server' to 'notary server' as that's what the Perspectives Project calls them too 9 years ago
Kegsay 880bf20403 Merge pull request #21 from matrix-org/paul/fixes
Three small fixes
9 years ago
Mark Haines 7d805f105e Mention that Olm uses AES in CBC mode 9 years ago
Mark Haines 88176ef148 Add notes on algorithm naming. Fix some typos 9 years ago
Paul "LeoNerd" Evans c6f2f711de Mention AAAA as well as A records; remark on default port 8448 for no-SRV fallback 9 years ago
Mark Haines d06580a481 Spelling 9 years ago
Mark Haines e1f201f9e6 Add description of the olm type and body JSON keys 9 years ago
Mark Haines c83e8480e8 Fix JSON syntax 9 years ago
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 9 years ago
Mark Haines 41d204e72c Name the key 'ciphertext' rather than 'ciphertexts' 9 years ago
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 10 years ago
Mark Haines 42ad1f8612 Add a link to signing JSON section of the spec. Fixup the markup a bit 10 years ago
Mark Haines 01927cee9b Rename "take" to "claim". Hyphenate "one-time". 10 years ago
Mark Haines 36e035c79e Add some specification for end-to-end 10 years ago
Matthew Hodgson f08588bf7e typo 10 years ago
Paul "LeoNerd" Evans 5f391b5617 Also document the directory server federation API 10 years ago
Paul "LeoNerd" Evans fc1e01f373 Add a small note about the meaning of the 'target' field 10 years ago
Paul "LeoNerd" Evans af1616ba9a Merge branch 'master' into paul/fixes 10 years ago
Paul "LeoNerd" Evans 28894ac1b7 Bugfix to embedded sign_json() python code 10 years ago
Paul "LeoNerd" Evans 9b046cbc04 Tiny fix to embedded YAML fragment 10 years ago
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.
10 years ago
Kegan Dougal 71e200a063 Remove version section. 10 years ago
Kegan Dougal e10859a887 Replace presence API with new template. 10 years ago
Kegan Dougal ec631c60d4 Add link to github commit for the spec as per request. 10 years ago
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.
10 years ago
Kegan Dougal f134728268 Link to msgtypes from the description of m.room.message. 10 years ago
Kegan Dougal 51df65bb49 Remove old power level references. Link to m.room.power_levels. 10 years ago
Kegan Dougal ac7ccfa622 Add {{presence_events}}. Factor out common code in MatrixSections. 10 years ago
Kegan Dougal 6f330bd879 Gut the old msgtypes section and replace with {{msgtype_events}} 10 years ago
Kegan Dougal f5059057b3 Update AS API docs (wording/layout tweaks, rationale). 10 years ago
Kegan Dougal 9d532f30e8 Add {{voip_events}}. Add more info on sections when asked via build.py -s 10 years ago
Kegan Dougal 89083b3a86 Add {{spec_version}}. Update build.py module docs. 10 years ago
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.
10 years ago
Kegan Dougal ed4ce6950c Template up common event fields from the 'core' json schema file. 10 years ago
Kegan Dougal 02c44a889e Remove stuff from 20_events.rst and replace with {{room_events}}. Update gendoc to call build.py for template vars. 10 years ago
Matthew Hodgson e729a9e425 Merge pull request #16 from matrix-org/key_v2_fixes
Add minimum_valid_until_ts to key/v2 API
10 years ago
Matthew Hodgson fa1ec93c78 typo 10 years ago
Matthew Hodgson 39b3de1df3 remove AS register/unregister APIs from the spec for now, but keep the useful info intact 10 years ago
Erik Johnston 580b4a1787 Merge pull request #15 from matrix-org/csauth
Document CS API V2 auth changes and new APIs.
10 years ago
Mark Haines 9752dc399e Update 30_server_server_api.rst
Missing '$'
10 years ago
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.
10 years ago
Mark Haines cdcaf69fb5 Update 30_server_server_api.rst 10 years ago
David Baker deb17914ca Link syntax 10 years ago
David Baker 199bb87ffa Add link to v1 docs. 10 years ago
David Baker 3343b7f84d Clarify n-factor auth and add the diagram back in as an example 10 years ago
David Baker e7d334c5cd Kill all camels 10 years ago
David Baker 233522b612 Fix typo 10 years ago
David Baker a52819ba69 Clarify dummy auth 10 years ago
David Baker fa8d8a9f95 Remove spurious array in error example 10 years ago
David Baker cfbc58c4fb Forgot bind_email param on register. 10 years ago
Matthew Hodgson 52692931d7 fix typos 10 years ago
David Baker e52146e47f V2PREFIX 10 years ago
David Baker dd12d901af Oops: missed recaptcha. Also make list in the same order as the details. 10 years ago
David Baker b71aaddad0 Try & fix RST errors 10 years ago
David Baker c583bf9570 wrong title level 10 years ago
David Baker 8495d9451e Document CS API V2 auth changes and new APIs. 10 years ago
Matthew Hodgson 04086975bd fix header depth 10 years ago
Matthew Hodgson 4255058680 typo 10 years ago
Matthew Hodgson dacf93b405 oooooops, apparently I forgot to 'git add' these when I refactored the spec last month :-/ 10 years ago
Mark Haines 6f269890be Add a brief reference to the perspectives project and mention what should happen if a server goes offline 10 years ago
Mark Haines 0db3182159 Describe what the expired_ts is 10 years ago
Mark Haines 4422e9ca2b Add a short summary of how the v2 key api is supposed to be used 10 years ago
Mark Haines ed21f50cc3 Add version 2 of the server key distribution API 10 years ago
David Baker 3f5a94484f Update spec where I changed it to allow omiting value for highlight 10 years ago
Matthew Hodgson 0f1514febb standardise on <foo> rather than :foo 10 years ago
Matthew Hodgson c0e55bb99e make intro match order of sections as per max g-j feedback 10 years ago
David Baker 07c4d6cd21 Add append flag to pushers to support multiple accounts. 10 years ago
Matthew Hodgson c1d7e82d29 rst fail 10 years ago
Matthew Hodgson 9ff5456b5e fix sections a bit more 10 years ago
Matthew Hodgson 0c6bd900a3 fix sections a bit 10 years ago
Matthew Hodgson c3f29ea720 Merge branch 'master' into ua925_reshuffle 10 years ago
Matthew Hodgson 58c28598af lots of fixes based on kegan's review of https://github.com/matrix-org/matrix-doc/pull/13 10 years ago
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.
10 years ago
Matthew Hodgson d552a043f8 remove LI section entirely until we decide how best to discourage it, otherwise it looks like we're endorsing it 10 years ago
Kegan Dougal 006932c70f Be clearer when specifying the version of the spec. 10 years ago
Kegan Dougal 5a0e40b984 Mark CS API as v1 in the spec. 10 years ago
Kegan Dougal 4b0e858529 Add $GIT_VERSION to the spec which is replaced by the gendoc script. 10 years ago
Kegan Dougal 42857df26f Syntax fixes 10 years ago
Kegsay 8e75c5ed67 Add in passive application services 10 years ago
Kegan Dougal f60c0ac96b Fix indentation levels on specification. 10 years ago
Paul "LeoNerd" Evans a9a4c46a57 Add spec for m.notice (SPEC-18) 10 years ago
Kegan Dougal 62471348ca This is a comment, not a directive. Remove :: 10 years ago
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. 10 years ago
Matthew Hodgson 5d177b0e18 mention event deduplication 10 years ago
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 10 years ago
Matthew Hodgson e2b49cc20f remove spurious sender_ts info and spec out m.file 10 years ago
Matthew Hodgson b3f99f9bf7 typo 10 years ago
Mark Haines 3fd1833bc5 Add more reasonable example for unsigned data in json signing example 10 years ago
Matthew Hodgson 2d5bb01a63 add in version, improve AS API a bit, move eventstream to the right place 10 years ago
Mark Haines b2295b9bc7 Add docs on server discovery 10 years ago
Mark Haines b7708a9b88 Move the request signing docs to the right bit of the spec 10 years ago
Mark Haines 3873a219f9 SPEC-33: Add server to server request authorization to the specification 10 years ago
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 10 years ago
Matthew Hodgson 2c9707633e tone down warning 10 years ago
Matthew Hodgson 2f1f37cc4c formatting, whitespace, and some rephrasing for clarity 10 years ago
Matthew Hodgson 64f56a15d7 fix english and whitespace 10 years ago
Mark Haines e5cb7aae07 Add some documentation for event signing 10 years ago
Mark Haines b73645ad8f Try turning on syntax high-lighting for JSON examples 10 years ago
Mark Haines 19e326d305 Reword introduction to federation API to mention event signing 10 years ago
Mark Haines 36fa322c5d Improve formatting and update PDU and transaction key names 10 years ago
Mark Haines 5e4b8798a4 Nicer formatting for the PDU field documentation 10 years ago
Mark Haines ae27cbe1a4 Put client-server links into the correct file 10 years ago
Mark Haines 7e244e8a0d remove trailing whitespace 10 years ago
Oddvar Lovaas 969cc408f1 Spelling and removing WIP warnings (as everything is equally WIP) 10 years ago
Matthew Hodgson eeb596b20b merge core_model into spec 10 years ago
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. 10 years ago
Matthew Hodgson 556e3f8a71 move matrix-generic documentation from synapse/docs into new matrix-doc project 10 years ago