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
1847 commits 30 branches 42 tags 32 MiB
Commit graph

562 commits

Author SHA1 Message Date
Erik Johnston 373c6c8270 Add ordering, pagination and grouping comments 2015-11-17 11:56:05 +00:00
Mark Haines c77b22778f Add some documentation on names of tags 2015-11-16 17:48:41 +00:00
Mark Haines 25769493b1 Fix template 2015-11-16 17:14:41 +00:00
Mark Haines e7fbe6f13b Limit the size of a tag 2015-11-16 17:13:02 +00:00
Mark Haines 48f35e15cb describe how to order rooms that don't have an order in their tags 2015-11-16 17:08:59 +00:00
Mark Haines 299af673da Specify how ordering of tags is supposed to work 2015-11-16 17:04:19 +00:00
Richard van der Hoff 7ff593b3de Merge branch 'rav/SPEC-254' into rav/flatten_sync 
Conflicts:
	specification/events.rst
 2015-11-16 16:56:39 +00:00
Mark Haines 3b390bff3c Merge branch 'master' into markjh/room_tags 
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
 2015-11-16 16:56:35 +00:00
Richard van der Hoff 0db055b4ea Fix another reference to 'txn_id' 2015-11-16 16:54:57 +00:00
Mark Haines 8f5783615c Merge branch 'master' into markjh/client_config 
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
 2015-11-16 16:51:45 +00:00
Paul "LeoNerd" Evans 233e8486bc Wording fix - objects contain keys, not list elements directly 2015-11-16 16:50:58 +00:00
Mark Haines c3769ef75c Add a module for client config to the specification 2015-11-16 16:49:32 +00:00
Paul "LeoNerd" Evans 6cbfba7011 'auth_events' is a List, not a String 2015-11-16 16:33:26 +00:00
Paul "LeoNerd" Evans 122c082fcf Comment about origin servers of invites having subsequently left the room 2015-11-16 16:29:43 +00:00
Paul "LeoNerd" Evans 923f05e554 More consistency around 'resident homeserver' 2015-11-16 15:34:11 +00:00
Paul "LeoNerd" Evans 36af793f05 s/full object/full event/ 2015-11-16 15:30:22 +00:00
Richard van der Hoff 29bd4d45ee Flatten the response to /sync 
Now that we don't expect there to be duplication betwen the 'timeline' and
'state' results, there's no point in having the state map. (That does mean the
events themselves need event_id fields though).

Also:

- move the contents of the 'unsigned' dictionary into the events themselves
- replace the state list with two layers of dictionary keyed on type and
  state_key
- rename the children of the 'rooms' dict from "joined/invited/archived" to
  "join/invite/leave" to match the membership states
 2015-11-16 00:00:48 +00:00
Richard van der Hoff 57995a815a Fix a number of untruths in the documentation about /sync. 
Attempts to make the /sync documentation better represent fact as it currently
stands - in particular document the structure of the returned events.
 2015-11-15 23:47:35 +00:00
Paul "LeoNerd" Evans 988d773476 /make_join protoevent no longer needs the pointless 'prev_state' key (SYN-517) 2015-11-13 17:49:22 +00:00
Paul "LeoNerd" Evans 885dd1e86c Explain the 'prev_events' join protoevent key 2015-11-13 16:39:31 +00:00
Paul "LeoNerd" Evans db5a90edcd Avoid using the words 'current state' when talking about the result of the /make_join request 2015-11-13 16:36:26 +00:00
Paul "LeoNerd" Evans aac45295ee Remark that the directory server step could be skipped in an invite case 2015-11-13 16:34:22 +00:00
Paul "LeoNerd" Evans d7c69fae43 Fix typo 'process' 2015-11-13 16:33:34 +00:00
Daniel Wagner-Hall ea364a108b Merge pull request #161 from matrix-org/daniel/guestdisplaynames 
Merge pull request #161 from matrix-org/daniel/guestdisplaynames

Guests are allowed to set displaynames
 2015-11-12 13:23:49 +00:00
Daniel Wagner-Hall 29d9c8eec6 Guests are allowed to set displaynames 2015-11-12 12:05:02 +00:00
Daniel Wagner-Hall 061105c9dc Guest users are allowed room initialSync 2015-11-11 17:18:58 +00:00
Daniel Wagner-Hall d7357ef9b7 Specify /publicRooms 2015-11-11 11:39:40 +00:00
Daniel Wagner-Hall 24c2036a35 3pid invites: remove mentions of display_name 2015-11-09 17:30:18 +00:00
Daniel Wagner-Hall e72151f2c3 Specify guest room access 
This was reviewed as PR #150 and merged from daniel/anonymousaccess
 2015-11-06 18:15:21 +00:00
Daniel Wagner-Hall 161441fa3a Update 3pid spec based on new implementation 2015-11-05 18:11:20 +00:00
Richard van der Hoff 8cba11b1cd Add some links to spec bugs for display names 
Just added a couple of TODO comments to useful jira bugs
 2015-11-05 11:06:31 +00:00
Richard van der Hoff 2fd5fc39a0 Add spec for calculating display names for rooms and users 
Merged from https://github.com/matrix-org/matrix-doc/pull/145
 2015-11-05 10:55:11 +00:00
Mark Haines 3953006792 Fix spelling 2015-11-03 15:54:33 +00:00
Paul "LeoNerd" Evans f6c55979e0 Remove TODO comment about SYN-490 as it's unlikely to matter for v1; we'll fix it in v2 2015-11-02 15:17:18 +00:00
Paul "LeoNerd" Evans 40fa339cf7 Draw a pretty (well at least I think it's pretty) ASCII diagram of the remote join handshake 2015-11-02 15:00:18 +00:00
Mark Haines 149890227a Fix wording 2015-11-02 13:35:11 +00:00
Mark Haines 52f55e0542 Allow room tags to have asssociated content, and return that content in the m.tag events 2015-11-02 13:31:25 +00:00
Mark Haines f557e69860 Note that m.tag events can appear in v1 initialSync and /events as well as v2 sync. Only add the room_id for v1 /events since it is redundant in v1 /initialSync 2015-11-02 10:13:47 +00:00
Mark Haines d297d83151 Mention that sender is renamed to user_id in v1 2015-10-29 18:45:53 +00:00
Mark Haines d067e50af5 Document the differences in event formatting between the v1 and v2 client APIs 2015-10-29 18:38:33 +00:00
Paul "LeoNerd" Evans 5b6f858802 Some initial notes by way of the remote join handshake; with several TODOs and unanswered questions 2015-10-28 20:28:49 +00:00
Paul "LeoNerd" Evans 745e607577 Use 'room' or 'room ID' instead of 'context' when describing federation protocol 2015-10-28 14:49:50 +00:00
Mark Haines 65066a76b3 Add the m.tags event to a `private_user_data key rather than including it under the ephemeral` key 2015-10-26 18:30:04 +00:00
Mark Haines 9b0d20315a Add the tags module to the specification targets 2015-10-26 16:22:04 +00:00
Mark Haines 12e33a3b09 Document a v2 api for setting tags on rooms 2015-10-26 16:14:24 +00:00
Richard van der Hoff 13eddd456f Proposal for adding full_state param to v2 sync 2015-10-26 15:52:45 +00:00
Erik Johnston 696f75d80b Rename section 2015-10-26 14:14:13 +00:00
Erik Johnston e2376e9a43 Merge branch 'erikj/login_fallback_v1' of github.com:matrix-org/matrix-doc 2015-10-26 14:11:21 +00:00
Erik Johnston 3cf431cac1 Add link 2015-10-26 14:10:02 +00:00
Kegsay a22f1cd230 Merge pull request #119 from matrix-org/paul/test-vectors 
Capture cryptographic test vectors for JSON or event signing from source
 2015-10-26 14:02:42 +00:00
Erik Johnston 9a5bd6d21f Use static 2015-10-26 13:56:07 +00:00
Erik Johnston 98dbf4d60b Better flow 2015-10-26 13:46:41 +00:00
Erik Johnston 0529b4a9a2 Reword 2015-10-26 13:45:36 +00:00
Erik Johnston 88c459d549 Add back in login v1 fallback API 2015-10-26 13:40:24 +00:00
Daniel Wagner-Hall 7c250f91ff Merge pull request #127 from matrix-org/daniel/exposedrooms 
Allow history to be noted as world-readable
 2015-10-26 10:30:32 +00:00
Kegsay 4823a133cd Merge pull request #124 from matrix-org/clarify_scale_crop 
Clarify 'scale' & 'crop' resize methods
 2015-10-26 09:57:32 +00:00
Richard van der Hoff f47a49de43 Merge pull request #126 from matrix-org/rav/send_events_api 
Add the room send and state APIs to the spec
 2015-10-23 17:05:30 +01:00
Richard van der Hoff 1945697456 Further tweaks to the room send and state APIs 
- fix confusion re empty/absent state_keys
- move 'types of room events' section earlier in the 'Events' section
- remove some redundant anchors
 2015-10-23 16:58:55 +01:00
Mark Haines 1d7cb6937f Merge pull request #123 from matrix-org/markjh/list_formatting 
Fix list formatting
 2015-10-23 16:53:29 +01:00
Richard van der Hoff 28ab643a4e Remove duplicated registration/login APIs 
Currently the spec duplicates all of the account-management APIs. There's still
work to be done here, but the complete duplication is confusing.
 2015-10-23 15:56:48 +01:00
Daniel Wagner-Hall 67880686d5 Allow history to be noted as world-readable 
SPEC-237
 2015-10-23 14:02:53 +01:00
Richard van der Hoff 587a8ba7ce Merge branch 'master' into rav/send_events_api 2015-10-23 13:48:58 +01:00
Richard van der Hoff d18d406c41 Add the room send and state APIs to the spec 2015-10-23 13:08:42 +01:00
David Baker 01064369a4 Add some clarification on the difference between 'scale' and 'crop' resize methods 2015-10-23 11:57:15 +01:00
Mark Haines e3e8026025 Fix list formatting so that we aren't including everything in blockquotes 2015-10-23 10:51:31 +01:00
Erik Johnston f0c74a9c83 Merge pull request #96 from matrix-org/erikj/search_actual 
Add search API
 2015-10-23 10:19:36 +01:00
Erik Johnston 4a558ad63b Typo 2015-10-23 10:19:25 +01:00
Kegan Dougal f95d19cecd Merge branch 'master' into appservice-swagger 
Conflicts:
	specification/application_service_api.rst
 2015-10-21 09:55:53 +01:00
Daniel Wagner-Hall 74d42f0142 Allow rejecting invitations 2015-10-20 11:08:22 +01:00
Paul "LeoNerd" Evans e38e4788f2 Spell 'cryptographic' correctly 2015-10-19 18:29:37 +01:00
Paul "LeoNerd" Evans 228acc59aa Capture cryptographic test vectors for JSON or event signing from source code 2015-10-19 18:26:52 +01:00
Paul Evans 84a8663019 Merge pull request #115 from matrix-org/paul/event-redaction 
Initial attempt at describing the event redaction algorithm
 2015-10-19 17:44:22 +01:00
Paul "LeoNerd" Evans 9252b3e1a2 Fix typo s/he/the/ 2015-10-19 17:44:09 +01:00
Paul "LeoNerd" Evans bfa9937bdc Minor wording updates 2015-10-19 17:28:31 +01:00
Daniel Wagner-Hall a9a9067d7e Merge pull request #114 from matrix-org/daniel/3pidtosigned 
Update 3pid invite section to reflect signed property
 2015-10-19 15:52:50 +01:00
Erik Johnston 1d01f69c3c Merge remote-tracking branch 'origin/master' into erikj/search_actual 2015-10-19 13:46:58 +01:00
Erik Johnston 111ca99519 Clarify that this doesn't include events that occurred after you left the room. 2015-10-19 13:46:30 +01:00
Kegsay 6546068c63 Merge pull request #101 from matrix-org/spec-182-asapi-user-creation 
SPEC-182: Make it clearer how ASes are supposed to create users
 2015-10-19 13:39:50 +01:00
Kegan Dougal f3088a0674 Merge branch 'master' into spec-182-asapi-user-creation 2015-10-19 13:39:21 +01:00
Kegan Dougal 26f27d95fb Merge branch 'master' into registration-swagger 
Conflicts:
	specification/client_server_api.rst
 2015-10-19 13:34:41 +01:00
Kegan Dougal ae90d15b3c Add m.room.avatar 2015-10-19 10:46:07 +01:00
Daniel Wagner-Hall c70067dd1e Simplify language 2015-10-19 10:44:26 +01:00
Daniel Wagner-Hall 22fdb8f911 Merge branch 'master' into daniel/as 2015-10-19 10:37:12 +01:00
Paul "LeoNerd" Evans 29720cd152 Initial attempt at describing the event redaction algorithm 2015-10-16 19:00:36 +01:00
Daniel Wagner-Hall 6161a920b6 Update 3pid invite section to reflect signed property 2015-10-16 18:29:20 +01:00
Kegan Dougal 62d53b4f33 Review comments round III 2015-10-16 15:58:11 +01:00
Kegan Dougal 85a6a5a530 Merge branch 'master' into proofing 2015-10-16 15:23:07 +01:00
Kegan Dougal 4bb042daeb Review comments round II 2015-10-16 15:22:50 +01:00
Kegan Dougal e0fe3c42c8 Review comments 2015-10-16 14:19:00 +01:00
Kegan Dougal 6770d6b2d6 Review comments 2015-10-16 14:05:18 +01:00
Daniel Wagner-Hall 20b11281ea Remove lies about OAuth which doesn't exist 2015-10-16 13:11:10 +01:00
Erik Johnston eb59b8e9d1 Mention count 2015-10-16 10:16:40 +01:00
Erik Johnston a6cb2e4339 Mention rank 2015-10-15 16:40:21 +01:00
Kegan Dougal eca98af896 Swaggerify /register endpoint 
Need to move registration/login/auth sections around once #94 lands.
 2015-10-15 16:38:12 +01:00
Erik Johnston 24e36adbe3 Mention e2e encryption 2015-10-15 16:09:11 +01:00
Erik Johnston 770cfbc5de Be explicit about the events the search is performed over 2015-10-15 16:08:24 +01:00
Erik Johnston 906c59385f s/had/has/ 2015-10-15 15:49:58 +01:00
Kegan Dougal 55cc5c5bb5 Swaggerify application services 2015-10-15 14:53:03 +01:00
Kegan Dougal 3d087df538 Kill number prefixes for good 2015-10-15 13:40:05 +01:00
Kegan Dougal 6b72ddfb8c Spelling and typos 2015-10-15 13:36:43 +01:00
Kegan Dougal 08ccacae17 Merge branch 'master' into proofing 
Conflicts:
	specification/0-intro.rst
 2015-10-15 13:26:37 +01:00
Erik Johnston c47a94658a Mention supported keys 2015-10-15 11:12:00 +01:00
Kegsay 3146b52f83 Merge pull request #102 from matrix-org/spec-207-asapi-unique-tokens 
SPEC-207: Add a warning about needing AS tokens to be unique and why
 2015-10-15 11:08:50 +01:00
Kegsay 604e268add Merge pull request #105 from matrix-org/spec-177-events-max-len 
Add in size limits as per SPEC-222
 2015-10-15 11:08:28 +01:00
Kegan Dougal 5de63b4f45 Merge branch 'master' into proofing 
Conflicts:
	specification/0-intro.rst
 2015-10-15 11:06:30 +01:00
Erik Johnston af347baa68 Better phrasing 2015-10-15 11:06:15 +01:00
Erik Johnston 96a4996c76 Mention search categories 2015-10-15 11:02:37 +01:00
Kegsay 3a2c8cd4b3 Merge pull request #91 from matrix-org/module-history-vis 
History visibility module
 2015-10-15 11:02:24 +01:00
Kegan Dougal 5aad67f74d Review comments round III 2015-10-15 11:01:11 +01:00
Kegsay c5dc383668 Merge pull request #85 from matrix-org/module-im 
Instant messaging module
 2015-10-15 10:59:41 +01:00
Kegan Dougal 507cb29e39 Review comments round deux 2015-10-15 10:37:15 +01:00
Kegan Dougal f51ee70633 Review comments round 2 2015-10-15 10:19:51 +01:00
Kegan Dougal c82c07ddd2 Review comments 2015-10-15 09:58:39 +01:00
Kegan Dougal c4d1b56843 Add a comment about enforcement. 2015-10-15 09:57:21 +01:00
Kegsay 1229ad24dd Merge pull request #103 from matrix-org/spec-165-mxc-security 
SPEC-165: Outline directory traversal attacks on MXC URIs
 2015-10-14 17:48:59 +01:00
Kegsay bc0ab32cfd Merge pull request #99 from matrix-org/spec-144-https-examples 
SPEC-144 : Use https examples not http
 2015-10-14 17:46:29 +01:00
Kegan Dougal e6eb19c461 Review comments 2015-10-14 17:34:25 +01:00
Erik Johnston 728b5a7951 Add very short summary 2015-10-14 17:20:00 +01:00
Erik Johnston 007bb1a69a Add extra new line 2015-10-14 16:26:14 +01:00
Erik Johnston 5e48b0b79a Add search to targets 2015-10-14 16:21:12 +01:00
Erik Johnston 38fcc563da Spell out full title 2015-10-14 16:20:08 +01:00
Erik Johnston 0efa3fd981 Add module 2015-10-14 16:17:04 +01:00
Kegan Dougal 6a0595bc46 Add in size limits as per SPEC-222 2015-10-14 16:15:55 +01:00
Erik Johnston d8bc0c9315 Add search module 2015-10-14 16:13:43 +01:00
Kegan Dougal f0d8052951 SPEC-205: Warn about password strengths in m.login.password section 2015-10-14 15:42:44 +01:00
Kegan Dougal 44b19a8b0e SPEC-165: Outline directory traversal attacks on MXC URIs 2015-10-14 15:27:56 +01:00
Kegan Dougal 45b1d08c7e SPEC-207: Add a warning about needing AS tokens to be unique and why 2015-10-14 15:16:12 +01:00
Kegan Dougal cd34d4e19b SPEC-182: Make it clearer how ASes are supposed to create users by linkifying the right text. 2015-10-14 15:12:15 +01:00
Kegan Dougal 3608f3a282 SPEC-144 : Use https examples not http. 2015-10-14 14:44:09 +01:00
Kegan Dougal 34bd8edec5 Move related auth sections together 2015-10-14 13:26:58 +01:00
Kegan Dougal 6f6861a11d Swaggerify the createRoom API 2015-10-14 13:17:51 +01:00
Kegan Dougal 07d7a3fa3a Shuffle pagination section around 2015-10-14 11:03:53 +01:00
Kegan Dougal 7bdb71b1c9 Tweak the syncing section 
Bring together disparate sections to make it more cohesive.
 2015-10-14 10:25:39 +01:00
Kegan Dougal e716e81963 Add dir parameter to pagination. Remove path references 
This section needs a lot of work to not lie.
 2015-10-14 09:58:03 +01:00
Kegan Dougal e561a663d3 Tweaks to intro, start using swagger APIs in the CS API section. 2015-10-13 16:53:27 +01:00
Kegan Dougal 4170dbd5cf Review comments 2015-10-13 11:29:54 +01:00
Kegan Dougal 173d00cea0 Review comments 2015-10-13 11:08:19 +01:00
Daniel Wagner-Hall 2502ca7ac6 Merge branch 'master' into daniel/threepidinvites-2 
Conflicts:
	specification/targets.yaml
 2015-10-12 18:11:01 +01:00
Daniel Wagner-Hall 4a1fb74897 Review comments 2015-10-12 18:08:51 +01:00
Kegan Dougal 8f5c796884 Linkify 'pushers' 2015-10-12 17:50:46 +01:00
Kegan Dougal e378de8379 Shuffle history visibility module to be in the module format 2015-10-09 11:04:11 +01:00
Kegan Dougal f2a6950cc3 Minor tweaks; allow objects without props/parents if a title is set 
This allows us to do things like {Tweaks} where Tweaks is defined somewhere
else.
 2015-10-08 16:21:26 +01:00
Daniel Wagner-Hall dc3c02aff5 Review comments 2015-10-08 10:08:38 -05:00
Daniel Wagner-Hall 21a40b317d Merge branch 'master' into daniel/threepidinvites-2 2015-10-08 09:41:17 -05:00
Kegan Dougal 9c95ee5c1f Modify wording and formatting 2015-10-08 15:36:03 +01:00
Kegan Dougal 31ae4b3859 Swaggerify push notification API 
Edit units.py to support nested JSON request keys
 2015-10-08 13:08:21 +01:00
Kegan Dougal a9618a981b Swaggerify the /enabled endpoint 2015-10-08 11:16:42 +01:00
Kegan Dougal 56ce432399 Get profile tag keys displaying correctly. 2015-10-08 10:14:05 +01:00
Kegan Dougal db25276856 Start adding in push definitions 
This is going to be painful to represent due to how the push API allows
mixed types (strings or objects) and mixed top-level keys ("content" rule kind
allowing "pattern" as a top-level key). We may wish to re-visit the design
of this API for v2.
 2015-10-07 17:44:05 +01:00
Kegan Dougal c5edc60c4c Add push YAML for pushers endpoint. 
Also display "required" text on required JSON body request params. Also
increase the size of the request param column to support longer param names
present in the pushers API.
 2015-10-07 16:01:36 +01:00
Kegan Dougal d3ed517ebf Finish laying out rough sections 2015-10-07 14:14:15 +01:00
Kegan Dougal a7400508c6 Define module titles from the template 2015-10-07 14:07:36 +01:00
Kegan Dougal 319ba8f404 Combine push files into one 
We can fork it out again if it makes sense, but certainly 2/3 of the files
were very small and it just adds more complexity when refactoring.
 2015-10-07 14:00:16 +01:00
Kegan Dougal 91ca36509b Flesh out IM module 2015-10-07 11:51:49 +01:00
Kegan Dougal 656bee78c4 Merge branch 'master' into module-im 2015-10-07 10:46:39 +01:00
Matthew Hodgson 7ae2573113 fix barefaced lie regarding the passivity of ASes 2015-10-06 14:13:40 -05:00
Matthew Hodgson 39faccb00d CS API is not just v1 surely 2015-10-06 09:38:46 -05:00
Kegan Dougal 8e5c832ff9 Flesh out more of the IM module 2015-10-05 13:45:23 +01:00
Kegan Dougal 47cf958b54 Merge branch 'master' into module-im 2015-10-05 10:16:44 +01:00
Erik Johnston 3b4c3522e6 Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/disable_federation 2015-10-05 09:17:28 +01:00
Kegsay 8c092e3d11 Merge pull request #74 from matrix-org/module-presence 
Presence module
 2015-10-02 16:24:53 +01:00
Kegan Dougal 417c5b53c4 Remove duplicate sentences from merge conflicts 2015-10-02 16:24:33 +01:00
Daniel Wagner-Hall b29fdebec2 Give example of verification dance 2015-10-02 09:14:31 -05:00
Kegan Dougal 458383585f Stub sections 2015-10-02 15:03:55 +01:00
Kegsay ead79614ff Merge pull request #78 from matrix-org/module-typing2 
Typing module
 2015-10-02 14:36:30 +01:00
Daniel Wagner-Hall 9d8dc7971d Review comments 2015-10-02 08:33:12 -05:00
Kegsay 68df99409a Merge pull request #83 from matrix-org/module-content-repo 
Content Repo Module
 2015-10-02 11:27:41 +01:00
Erik Johnston ccdd376f30 Merge pull request #63 from matrix-org/erikj/room_create_preset 
Update the room creation API spec to include new keys: 'preset' and 'initial_state'
 2015-10-02 11:13:06 +01:00
Kegan Dougal 09ac367847 Merge branch 'master' into module-content-repo 
Conflicts:
	templating/matrix_templates/units.py
 2015-10-02 10:46:46 +01:00
Kegan Dougal 4dabcd112e Remove redundant info now we have the http api template. Minor tweaks to display of schema with no names but a type 2015-10-02 10:44:50 +01:00
Erik Johnston 912a8ca760 Be more explicit about keys that are clobbered 2015-10-02 10:30:45 +01:00
Erik Johnston dbc72c43ac s/private_chat_shared_power/trusted_private_chat/ 2015-10-02 10:28:29 +01:00
Daniel Wagner-Hall af7d2ca9fc Update 3pid invite spec 
This takes into account:
 1) That finding the existing servers of a room is hard
 2) Federation
 2015-10-01 22:19:11 -05:00
Kegan Dougal 87b6dd845e Flesh out content repo; modify templating to support headers 
Edit content-repo.yaml to include examples and headers.
Restructure content module to conform to the module template.
Adjust the HTTP API template to give 1 more char to the response
param to fit "Content-Disposition" correctly.
Edit the templating system to support displaying enums for
swagger APIs (before it was just JSON schema). Also add support
for introspecting headers from swagger. Finally, replace - with
_ when forming the {{ template_var }} else things whine.
 2015-10-01 17:55:16 +01:00
Kegsay 8aad238cda Merge pull request #80 from matrix-org/module-receipts 
Receipts module
 2015-10-01 17:33:38 +01:00
Kegan Dougal da2be7eae4 Merge branch 'master' into module-voip 
Conflicts:
	specification/modules/voip_events.rst
 2015-10-01 15:48:42 +01:00
Kegan Dougal 1520f3647f Merge branch 'master' into module-typing2 
Conflicts:
	specification/modules/typing_notifications.rst
 2015-10-01 15:47:46 +01:00
Kegan Dougal cc6f256b24 Merge branch 'master' into module-presence 
Conflicts:
	specification/modules/presence.rst
 2015-10-01 15:46:52 +01:00
Kegan Dougal 6000887201 Merge branch 'master' into module-receipts 
Conflicts:
	specification/modules/receipts.rst
 2015-10-01 15:44:53 +01:00
Kegan Dougal c972dad8b3 Flesh out receipts module. Add receipts swagger 
Add templating support for v2 apis.
 2015-10-01 15:41:54 +01:00
Kegsay 4a7a682c0f Merge pull request #65 from matrix-org/spec-feature-profiles 
Spec feature profiles
 2015-10-01 12:16:30 +01:00
Kegan Dougal 365a9076b9 Add nested dict template support; Add x-pattern 
For cases where event schema specify `patternProperties` it would be nice
to give that pattern a "human-readable" form rather than a raw regex. This
is now supported by specifying `x-pattern` in the value part of the specified
pattern e.g. `patternProperties:{ "^.*":{ x-pattern: "$THING", ... } }`

Templating had limited record type descriptions limited to value primitives
e.g. `{string: integer}`. It now supports inspecting the values recursively
if the value is `object`.

Updated `m.receipt` to take both these points into account to make it read
better. Tweak receipt module text.
 2015-10-01 12:11:26 +01:00
Kegan Dougal 3b73b07bab Clarifications that room invites are m.call.invites not actual invites 2015-10-01 11:11:08 +01:00
Kegan Dougal e82661413e Add /turnServer endpoint 2015-10-01 11:04:42 +01:00
Kegan Dougal d092b22848 Rename to 'Managing history visibility' 2015-10-01 09:23:08 +01:00
Kegan Dougal 6c3e70d272 Start fleshing out voip module 2015-09-30 17:32:44 +01:00
Kegan Dougal 91b6347f74 Explain what 'embedded' clients are 2015-09-30 16:48:47 +01:00
Kegan Dougal be9402b66f Move feature profiles section to modules as a sub-section 2015-09-30 16:43:09 +01:00
Kegan Dougal 0320e8cef3 Table tweaks from PR 2015-09-30 16:41:47 +01:00
Kegan Dougal 097dc50180 Minor tweaks 2015-09-30 15:51:20 +01:00
Kegan Dougal a82f2ad4ac Flesh out typing module 2015-09-30 15:51:12 +01:00
Kegan Dougal 2b7e02c080 Add sections for typing. Add swagger, JSON schema and example m.typing event 2015-09-30 15:51:04 +01:00
Kegan Dougal 52f6496cf0 Merge branch 'master' into module-presence 2015-09-30 10:56:17 +01:00
Kegan Dougal 4e1e82f995 Fix paragraph CSS and adjust where paragraphs are in the RST 
The CSS for `nature.css` was such that it was preventing `p` tags from
having sufficient vertical whitespace. This meant that you couldn't insert
any kind of spacing between lengthy sections (they just appeared as new lines).

This PR fixes this so you can actually have some whitespace between paragraphs.
As a result of this change, some parts of the spec appeared to have too much
whitespace. These were often sections which shouldn't have begun a new
paragraph anyway (e.g. a single sentence being an entire paragraph, `TODO`
blocks resulting in new paragraphs). This PR fixes the most offending areas
where we shouldn't have been inserting new paragraphs.
 2015-09-30 10:43:02 +01:00
Kegan Dougal 069e4e39f4 Move presence specific sections from intro to presence module 2015-09-30 10:22:51 +01:00
Erik Johnston 73b4090f52 Add private_chat_shared_power 2015-09-30 10:22:12 +01:00
Kegan Dougal 0a04672d76 Start converting the presence module. Add Rationale admonition. 2015-09-29 17:57:44 +01:00
Kegan Dougal cdf9f011e9 Add room history visibility as a module. 2015-09-29 16:33:34 +01:00
Kegan Dougal 82c27884ba Make E2E optional 2015-09-29 16:29:16 +01:00
Erik Johnston 83b9497664 Add context and example 2015-09-29 16:21:10 +01:00
Kegsay c96f02c2b0 Merge pull request #69 from matrix-org/erikj/login_token 
m.login.token
 2015-09-29 13:26:29 +01:00
Erik Johnston 6e6bc8a5a9 Mandate macaroon 2015-09-28 14:51:44 +01:00
Erik Johnston ce53a17180 Add txn_id rationale 2015-09-28 14:51:10 +01:00
Erik Johnston 4776e0c04c Add creation_content key 2015-09-28 14:49:55 +01:00
Kegan Dougal 5abea1f2bc Minor tweaks 2015-09-28 14:07:34 +01:00
Kegan Dougal 70518ae655 Clarify template suffixes 2015-09-28 14:03:54 +01:00
Kegan Dougal 643468e914 Mention swagger. Clarify how event type template vars are formed. 2015-09-28 14:01:54 +01:00
Kegan Dougal c2fc1a2fb1 Add basic module template. 
This has the core sections for events/server/client/security.
 2015-09-28 13:41:31 +01:00
Kegan Dougal db8f3c0d59 Desktop clients should have a GUI 2015-09-28 13:11:34 +01:00
Erik Johnston 97154cc6b2 s/nonce/txn_id/ 2015-09-28 13:09:54 +01:00
Erik Johnston 4c9f524cab Neaten things up 2015-09-28 09:32:03 +01:00
Erik Johnston 317c2f20d3 Draft login token spec 2015-09-28 09:29:35 +01:00
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