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

247 commits

Author SHA1 Message Date
Richard van der Hoff b41d771c15 Fix typos in /sync example response 2015-11-15 23:58:04 +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
Richard van der Hoff 3f0262081c Update sync API defn to reflect SPEC-254 changes 
State now corresponds to the start of the timeline, not the end.
 2015-11-15 23:47:35 +00:00
Daniel Wagner-Hall 061105c9dc Guest users are allowed room initialSync 2015-11-11 17:18:58 +00:00
Daniel Wagner-Hall dcf54e11b1 Specify /publicRooms world_readable and guest_access 
Depends on https://github.com/matrix-org/matrix-doc/pull/154
 2015-11-11 11:53:31 +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
Daniel Wagner-Hall 232b10b0f6 Merge branch 'master' of github.com:matrix-org/matrix-doc 2015-11-05 13:25:51 +00:00
Mark Haines b7cc5b1018 Merge pull request #141 from matrix-org/markjh/full_http_api_docs 
Include the full schema for an http API in the docs
 2015-11-04 16:03:22 +00:00
Mark Haines ebc0237109 Add the missing titles to the schema 2015-11-03 19:35:44 +00:00
Mark Haines d53814097f Add example content to the tags in example tag events 2015-11-03 15:57:06 +00:00
Mark Haines e9d361841b Fix tag examples 2015-11-03 15:42:58 +00:00
Daniel Wagner-Hall 2e3a0b4e00 Specify guest accounts 2015-11-02 15:26:06 +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 ad86426e95 Add private_user_data to v1 room /initialSync 2015-10-30 16:55:18 +00:00
Mark Haines b49472e3b0 Add private_user_data to v1 /initialSync 2015-10-30 16:52:34 +00:00
Mark Haines 451801bf38 Add an example of `prev_content in unsigned` to v2 /sync 2015-10-29 18:40:05 +00:00
Matthew Hodgson 6c1df04b4b typo 2015-10-29 02:11:47 +00:00
Richard van der Hoff ece42688d0 Clarify the interaction between full_state and timeout. 2015-10-26 19:20:58 +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 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
Kegsay ade0ad5ed1 Merge pull request #129 from matrix-org/erikj/search_actual 
Add filter param to search API
 2015-10-26 10:20:56 +00:00
Erik Johnston 36634df355 Add filter param 2015-10-26 10:19:48 +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
Mark Haines 637718108e Add newline before list 2015-10-23 16:52:37 +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
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 d2bbc461e4 mark stateKey as required in room/{id}/state 
Swagger insists that path params be mandatory.
 2015-10-23 13:25:12 +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
Mark Haines cc14620932 Add a newline before the list 2015-10-23 11:36:07 +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
Kegan Dougal f95d19cecd Merge branch 'master' into appservice-swagger 
Conflicts:
	specification/application_service_api.rst
 2015-10-21 09:55:53 +01:00
Kegan Dougal 4c3e1b9ed3 Find replace fail 2015-10-21 09:53:25 +01:00
Kegan Dougal bd539c72b4 More review comments 2015-10-21 09:52:44 +01:00
Erik Johnston 1d01f69c3c Merge remote-tracking branch 'origin/master' into erikj/search_actual 2015-10-19 13:46:58 +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 f450fc1db6 Typo 2015-10-19 13:32:43 +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
Erik Johnston 716c5b7a8b Add 400 and 429 response codes 2015-10-16 10:26:14 +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 cfca4a6c09 s/creteria/criteria/ 2015-10-15 15:51:02 +01:00
Kegan Dougal f20faa80e5 Swagger validation 2015-10-15 14:58:00 +01:00
Kegan Dougal 55cc5c5bb5 Swaggerify application services 2015-10-15 14:53:03 +01:00
Kegan Dougal 5de63b4f45 Merge branch 'master' into proofing 
Conflicts:
	specification/0-intro.rst
 2015-10-15 11:06:30 +01:00
Kegan Dougal 1f2f14dc08 YAML tweaks 2015-10-14 17:07:25 +01:00
Kegan Dougal 84af5776d7 Newlines 2015-10-14 17:02:39 +01:00
Erik Johnston 2b9484cf48 Spell things correctly 2015-10-14 15:35:39 +01:00
Erik Johnston 392a1c5ad8 Another title 2015-10-14 15:06:16 +01:00
Erik Johnston ca9e44baac Moar titles 2015-10-14 15:01:21 +01:00
Erik Johnston a7a5cb088b Add titles 2015-10-14 14:35:08 +01:00
Erik Johnston e42c8b5b63 Add search API 2015-10-14 14:19:11 +01:00
Richard van der Hoff 4a9db39277 Clean up some untruths in the login api doc 
add "type", and "username" -> "user"
 2015-10-14 13:38:28 +01:00
Kegan Dougal 6f6861a11d Swaggerify the createRoom API 2015-10-14 13:17:51 +01:00
Kegan Dougal 41fb0645a9 Add message pagination API 2015-10-14 11:16:58 +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
Daniel Wagner-Hall 2502ca7ac6 Merge branch 'master' into daniel/threepidinvites-2 
Conflicts:
	specification/targets.yaml
 2015-10-12 18:11:01 +01:00
Kegsay 616f3990aa Merge pull request #87 from matrix-org/module-push 
Push Module
 2015-10-12 17:51:44 +01:00
Kegan Dougal 8f5c796884 Linkify 'pushers' 2015-10-12 17:50:46 +01:00
Mark Haines d42c3195e6 Use 'true' rather than '1' for archived flag 2015-10-08 18:06:52 +01:00
Mark Haines 241096dc81 Add a flag to initial sync to indicate we want rooms that the user has left 2015-10-08 17:25:38 +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 befa23624e It's dangerous to go alone, take this. 2015-10-08 13:41:47 +01:00
Kegan Dougal 65504db7bb Display nested keys on arrays of objects. Make it valid swagger. 2015-10-08 13:40:21 +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 f6da9d7760 Give valid swagger. Split out rule/ruleset to separate definitions. 2015-10-08 09:57:40 +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 9540069acd Use valid JSON 2015-10-07 16:06:11 +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
Mark Haines 034241eb20 Missing symlink for the v2 swagger APIs 2015-10-06 17:43:04 +01:00
Mark Haines 509d178d58 Fix the receipts API to be valid swagger 2015-10-06 17:40:45 +01:00
Mark Haines 4f606cf3a7 Add the fields required by the templating system to v2 sync 2015-10-06 17:31:05 +01:00
Mark Haines 5a5a6565ff Merge pull request #68 from matrix-org/markjh/v2_sync_api 
Swagger documentation for the v2 sync API
 2015-10-06 16:51:06 +01:00
Mark Haines 0ce533d153 Split the room_map into separate sections based on whether they are 
"joined/invited/archived".

Rename the room_map to rooms and remove the grouping indirection. When we
want groups then we can add them under a separate key, either at the
top-level or as part of the events themselves.
 2015-10-06 13:42:03 +01:00
Mark Haines 0e5b00feaa Fix event type in v2 sync example 2015-10-05 16:10:25 +01:00
Mark Haines bbb5fa9398 Fix the state_key in the example v2 response, include the "sender" key in the list of keys included with invite_state events 2015-10-05 15:36:01 +01:00
Mark Haines a7b808c5cd Add a invite_state key for holding the state that is bundled with an 
invite. This is kept separate from the actual state for the room as
it may be derived from an incomplete, unverified copy of the state
that was bundled with an invite event received over federation.
 2015-10-05 15:26:33 +01:00
Mark Haines ed0f6d3ff3 Typo 2015-10-05 14:22:50 +01:00
Mark Haines 97cdd8106c s|client/api/v2_alpha|/client/v2_alpha| 2015-10-05 14:21:16 +01:00
Mark Haines 047419f2ad Remove the room_id since it is redundent. Remove text about invite event handling till we've thought about it some more. 2015-10-02 16:21:48 +01:00
Mark Haines bde003fe86 Split the rooms out into a separate top level key. 
Divide the rooms into separate groups in preparation for adding tag
support.

Further subdivide the rooms into "joined/invited/archived" based the
membership of the user in the room because that membership affects what
events the user can view from the room. E.g only users that are joined
to a room may see the ephemeral events for the room.
 2015-10-02 16:14:24 +01:00
Kegsay ead79614ff Merge pull request #78 from matrix-org/module-typing2 
Typing module
 2015-10-02 14:36:30 +01:00
Mark Haines a73cc50aa9 s|client/api/v2_alpha|client/v2_alpha| 2015-10-02 13:03:39 +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 3d9dbe42e6 Bump to swagger-parser 3.2.1 - remove x- keys on headers 
Removed x- keys due to https://github.com/BigstickCarpet/swagger-parser/issues/23
 2015-10-02 10:21:48 +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
Daniel Wagner-Hall d2c56fb7a3 Merge branch 'master' into daniel/threepidinvites-2 2015-10-01 21:18:50 -05:00