Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-24 01:58:36 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
753 commits 30 branches 42 tags 32 MiB
Commit graph

189 commits

Author SHA1 Message Date
Kegan Dougal 510553ee00 Remove smurf suffixes. Add anchor for feature profiles. 2015-09-25 15:29:33 +01:00
Kegan Dougal 9fac152d32 Explain what the clients are and the column reference 2015-09-25 15:26:58 +01:00
Kegan Dougal c6375ed3d1 Flesh out feature profiles section 
Add table detailing the profiles. Add anchors to link through to each module
following a well-defined format (rather than the name of the module section).
Allow UTF-8 in the spec.
 2015-09-25 15:09:15 +01:00
Erik Johnston 18dc7784df Mention precedence 2015-09-25 14:34:06 +01:00
Erik Johnston 078dd0165f Update the room creation API spec to include new keys: 'preset' and 'initial_state' 2015-09-25 11:58:47 +01:00
Kegan Dougal 1da64db302 Use relative depths for groups instead of absolute ones 
This means the group can be agnostic to how deeply nested it is,
improving reusability of groups.
 2015-09-23 14:29:37 +01:00
Kegan Dougal 29bae15790 Fix typo 2015-09-23 11:30:07 +01:00
Kegan Dougal 5115346297 Add instant_messaging module; modify batesian section rules 
Previously, all `m.room.*` events were wodged into `{{room_events}}` which
isn't great when you want to pull specific ones out. Batesian had a 1:1
mapping of `render_foo()` to a section `{{foo}}`, and having to constantly
add functions for new types is a PITA. Batesian now supports returning a
`dict` instead of a section `string` where the keys are the `{{foo}}` and
the value is what will be inserted. Also add conflicting section key checks
to avoid multiple definitions of the same `{{foo}}`. Define dicts for
event schemata and swagger HTTP APIs.

Using this new feature, split out the instant messaging stuff from the events
section, and replace `{{room_events}}` with a list of specific events e.g.
`{{m_room_member_event}}`.
 2015-09-23 10:48:49 +01:00
Kegan Dougal 5b134119bd Add presence module; fix relative title bug 
If a relative title appeared after an HTTP API table, it
would insert the wrong level because it thought that part
of the table was a title.
 2015-09-23 09:59:54 +01:00
Kegan Dougal b49cb57fe5 Move events sections to CS API 2015-09-22 17:32:31 +01:00
Kegan Dougal 16693a644a Various review fixes 2015-09-22 16:59:49 +01:00
Kegan Dougal b0eb985523 Merge branch 'master' into spec-restructure-modules 2015-09-22 16:04:41 +01:00
Kegan Dougal 0c0ac3e814 Fix common event fields template to use subtitle char 2015-09-22 14:07:23 +01:00
Kegan Dougal e8cdfcbba2 Rename spec files to not have numbers everywhere; update targets.yaml 2015-09-22 14:01:55 +01:00
Kegan Dougal f71763b0d3 Implement relative title styles 
Templates don't know at what level they will be inserted. Previously, we
hard-coded the title style which is not compatible with the build target
system. Define a set of styles which will be replaced by the gendoc script
when it encounters them:
 '<' : Make this title a sub-heading
 '/' : Make this title a heading at the same level
 '>' : Make this title a super-heading

The build target system is now basically complete and functioning.
 2015-09-22 13:08:15 +01:00
Kegan Dougal 067363c629 Get the desired title levels right; print out the actual level used to stdout 2015-09-21 17:21:08 +01:00
Kegan Dougal 8590cc84b5 Process and extract targets in gendoc.py 2015-09-21 15:33:28 +01:00
Kegan Dougal 568982ee2e Represent nested deps in targets.yaml along with title styles 
This will allow us to programatically position .rst snippets *anywhere*
which will for once and for all remove the horrid title level mismatch bugs.

We require this in order to allow people to re-shuffle the spec without
having to adjust the spec itself (e.g. 2 targets with different levels of
nesting).
 2015-09-21 14:49:54 +01:00
Kegan Dougal 703f913a47 Add a 'targets.yaml' files in /specification 
We're well beyond the point now where a simple `cat` of .rst files to "build"
the spec is practical. We may want to slice and dice the spec in different
ways to address various cross-cutting concerns. To this end, there is now a
'targets' file which contains the "build targets" for the spec, which contains
the sorting order for the .rst files. For now, we just have a single
target: 'main'.
 2015-09-21 14:31:57 +01:00
Kegan Dougal f520ac9d82 Create a modules folder to group together similar parts of the spec 2015-09-21 14:25:52 +01:00
Kegan Dougal c77ef1a2cc Add stub files feature_profiles and modules 2015-09-21 14:17:31 +01:00
Kegan Dougal f2c952ec58 Reshuffle spec into sections roughly right as per PR #52 2015-09-21 14:13:18 +01:00
Mark Haines f33c0846c3 Merge remote-tracking branch 'origin/master' into markjh/document_v1_rooms_api 2015-09-18 17:38:03 +01:00
Kegan Dougal 1f6b12b3e8 Modify and enforce the file format/structure used 
Convert the file format to be of the form ##_##_something.rst where the
first ## is the top-level section number and the second ## is the
second-level section number, e.g. 07_01_push_cs_api.rst means
Section 7.1 - This is now enforced in gendoc.py along with the title line
style that should be used (= for top-level, - for 2nd level) which will
give helpful suggestions if you trip up. This feels much more intuitive
now looking in /specification
 2015-09-18 11:43:53 +01:00
Kegan Dougal 9ed39665c8 PR feedback 2015-09-18 11:09:04 +01:00
Kegan Dougal 8e7b33ac99 Fix more typos/spelling errors 2015-09-18 09:40:53 +01:00
Kegan Dougal 3f9d183c2a More typo/layout fixes 
Split out identity servers to a separate file
 2015-09-18 09:25:40 +01:00
Kegan Dougal 620d3dcb26 Test commit 2015-09-17 17:51:44 +01:00
Kegan Dougal faa95e172f More formatting fixes; typos; etc 2015-09-17 17:49:57 +01:00
Kegan Dougal af32ec194a Move VoIP events to 22_voip_events 
20_events is a huge as it is, this makes it easier to find what section
you actually want when editing.
 2015-09-17 16:38:58 +01:00
Kegan Dougal 5b59c67510 Minor formatting fixes. Fix state event templating. 2015-09-17 16:34:20 +01:00
Mark Haines 7eb8b4fde2 Add new-style docs for the APIs for getting events for a room 2015-09-15 15:52:36 +01:00
Daniel Wagner-Hall 59a4e84361 s/registration/login/ 2015-09-14 17:10:46 +01:00
Daniel Wagner-Hall b8e2ac5c1b Swaggerify /login 2015-09-14 13:49:27 +01:00
Kegsay e788f565f8 Merge pull request #36 from matrix-org/daniel/threepidinvites 
Swagger /room/{roomId}/invite
 2015-09-11 11:59:21 +01:00
Kegsay 3011823c51 Merge pull request #27 from matrix-org/receipts 
Document receipts
 2015-09-10 16:18:19 +01:00
Daniel Wagner-Hall 2797fac3aa Swagger /room/{roomId}/invite 
This is a transcription of the current spec, with nothing new or
controversial in it.
 2015-09-09 17:55:40 +01:00
Daniel Wagner-Hall 04b2b2588f Fix up formatting and typos 2015-09-09 13:18:23 +01:00
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.
 2015-09-08 16:35:08 +01:00
Erik Johnston 80bb51d9bb Make it clearer 2015-09-04 11:21:14 +01:00
Erik Johnston 4b24b887c7 Document m.room.history_visibility 2015-09-01 11:53:30 +01:00
Erik Johnston 83dfc2bf61 Fix some mistakes/typos 2015-08-28 15:01:02 +01:00
Erik Johnston 0dc22e7217 Document receipts 2015-08-28 14:50:31 +01:00
Paul "LeoNerd" Evans 49c52a96a7 Rename 'perspective server' to 'notary server' as that's what the Perspectives Project calls them too 2015-08-05 11:35:48 +01:00
Kegsay 880bf20403 Merge pull request #21 from matrix-org/paul/fixes 
Three small fixes
 2015-08-05 11:29:46 +01:00
Paul "LeoNerd" Evans c6f2f711de Mention AAAA as well as A records; remark on default port 8448 for no-SRV fallback 2015-07-31 18:05:33 +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