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

392 commits

Author SHA1 Message Date
Richard van der Hoff ff26e0dc48 Add some missing titles to the filter upload spec 2016-01-07 18:31:09 +00:00
Daniel Wagner-Hall 0e967edfd9 Fix thinko 2016-01-07 12:38:32 +00:00
Daniel Wagner-Hall 7d9547274c Clarify guest /events and /sync 2016-01-07 11:59:38 +00:00
Daniel Wagner-Hall 48aab7bad9 Return room avatar URLs in /publicRooms 2016-01-06 18:00:21 +00:00
Daniel Wagner-Hall 5e30d75ccb Add /_matrix/versions to spec 2016-01-06 17:43:20 +00:00
Erik Johnston 48f56bfbfb Support 3pid invites in /createRoom 2016-01-05 10:52:47 +00:00
Daniel Wagner-Hall 1eee36e889 Merge pull request #232 from matrix-org/daniel/deprecatestuff 
Deprecated deprecated APIs
 2016-01-05 10:44:41 +00:00
Matthew Hodgson c7d11335cf Merge branch 'master' of git+ssh://github.com/matrix-org/matrix-doc 2016-01-05 02:48:14 +00:00
Matthew Hodgson 691d9ba664 typo :( 2016-01-05 02:47:55 +00:00
Mark Haines 4c43939977 more backticks 2015-12-22 11:48:11 +00:00
Mark Haines 9b4a37f57b backticks 2015-12-22 11:44:05 +00:00
Mark Haines 288c7ed353 Add top level filters for filtering by room id. 2015-12-21 20:44:06 +00:00
Mark Haines 2ea66e9300 Merge branch 'markjh/account_data_filters' into markjh/room_filter 2015-12-21 20:38:50 +00:00
Mark Haines a32ed96a0f Document filtering for account data 2015-12-21 20:31:02 +00:00
Mark Haines e413f05c87 Merge pull request #243 from matrix-org/markjh/wildcards 
Filters don't support wildcards for senders or room ids
 2015-12-21 20:25:26 +00:00
Mark Haines c9349b302a Filters don't support wildcards for senders or room ids 2015-12-21 17:17:28 +00:00
Richard van der Hoff b7c255a887 Tweaks/clarifications to search spec 
Fixes https://matrix.org/jira/browse/SPEC-305
 2015-12-17 13:40:22 +00:00
Daniel Wagner-Hall b6cd3adc2f Merge pull request #233 from matrix-org/daniel/txnid 
Merge pull request #233 from matrix-org/daniel/txnid
 2015-12-17 11:24:07 +01:00
Christine Dodrill 7090e491de fix a typo in the example json for the old sync description 2015-12-11 08:10:37 -08:00
Erik Johnston 7980e65502 Merge pull request #234 from matrix-org/erikj/search_yet_agian 
Note that count is approximate
 2015-12-11 12:47:47 +00:00
Erik Johnston 88b350ca8b Better wording 2015-12-11 11:41:51 +00:00
Erik Johnston a2082e4b38 Note that count is approximate 2015-12-11 10:54:01 +00:00
Daniel Wagner-Hall dbba737135 Explain scope of uniqueness of txnid 2015-12-10 15:47:27 +00:00
Daniel Wagner-Hall 3e086909f1 Deprecated deprecated APIs 2015-12-10 14:47:14 +00:00
Daniel Wagner-Hall a484f04b33 Merge pull request #221 from matrix-org/daniel/pushaway 
Merge pull request #221 from matrix-org/daniel/pushaway
 2015-12-09 14:04:02 +00:00
Mark Haines a33e49fd1e Merge pull request #224 from matrix-org/markjh/filter_inline 
Allow the filter JSON to be passed inline in the /sync request
 2015-12-09 11:53:43 +00:00
Mark Haines c3a1318886 Make it explicit that the JSON filter object is passed as a string 2015-12-09 10:50:02 +00:00
Erik Johnston c96848d1bc Merge pull request #169 from matrix-org/erikj/search_yet_agian 
Search: Document event context, groups and orders.
 2015-12-08 16:11:03 +00:00
Erik Johnston 95255bcdf5 Use rst not html 2015-12-08 16:02:55 +00:00
Erik Johnston e1fda6b6b6 Remove double the 2015-12-08 15:35:59 +00:00
Erik Johnston 9c98c80bde Fix up filter description 2015-12-08 15:26:06 +00:00
Mark Haines ed70bcb180 Add a rationale for allowing both inline filters and passing filters by id. 2015-12-08 14:36:50 +00:00
Mark Haines 878ce2f206 Allow the filter JSON to be passed inline in the /sync request 2015-12-08 14:32:11 +00:00
Erik Johnston 6025569a73 Remove unused 403 stub 2015-12-08 14:10:45 +00:00
Erik Johnston 0fb88e26f0 Add tags 2015-12-08 14:07:08 +00:00
Erik Johnston 4290882034 Remove superfluous quote 2015-12-08 14:06:59 +00:00
Erik Johnston 8e7f6d44f6 Remove v1 references 2015-12-08 14:01:16 +00:00
Erik Johnston 4967b092aa Add description of state response key 2015-12-08 13:37:32 +00:00
Daniel Wagner-Hall a2283f5499 Remove /notify from client-server API 2015-12-08 13:25:31 +00:00
Erik Johnston f4b9433c7b Better wording 2015-12-07 16:33:48 +00:00
Erik Johnston 584104c432 Make example valid event id 2015-12-07 16:32:43 +00:00
Erik Johnston fda07e0d41 Merge remote-tracking branch 'origin/master' into erikj/event_context_api 2015-12-07 16:31:55 +00:00
Erik Johnston 856dd9100e Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian 2015-12-07 16:28:14 +00:00
Erik Johnston 118a6aa040 Reword groupings descriptions 2015-12-07 16:06:25 +00:00
Erik Johnston 1ef9cc37e3 Typo 2015-12-07 15:58:31 +00:00
Erik Johnston fca8e5abe7 Add top level next_batch key to example 2015-12-07 15:54:08 +00:00
Daniel Wagner-Hall f81b967e2d Make all the schema files yaml 2015-12-07 13:56:36 +00:00
Daniel Wagner-Hall 1f5b6271f2 Generate swagger-ui output for client-server API 
Depends on:
https://github.com/matrix-org/matrix-doc/pull/212
https://github.com/matrix-org/matrix-doc/pull/208
https://github.com/matrix-org/matrix-doc/pull/207
for the actual rendered output to not throw javascript errors at runtime.
 2015-12-07 12:45:13 +00:00
Daniel Wagner-Hall c9fee294df Merge pull request #211 from matrix-org/daniel/extractas 
Move application service swagger out of c-s dir
 2015-12-07 12:00:27 +00:00
Daniel Wagner-Hall 97579f15cb Merge pull request #212 from matrix-org/daniel/pushdictification 
Take object, not bool, as param
 2015-12-07 10:39:36 +00:00
Daniel Wagner-Hall 705556634a Add filters 2015-12-04 19:46:45 +00:00
Daniel Wagner-Hall 9c733a45e8 Take object, not bool, as param 
Throughout our API we take objects. And swagger is unhappy with not
doing so.
 2015-12-04 17:36:19 +00:00
Daniel Wagner-Hall 614ee9ea1b Move application service swagger out of c-s dir 2015-12-04 17:34:48 +00:00
Mark Haines 140206ca69 s/archived/leave/ 2015-12-04 17:32:59 +00:00
Mark Haines 79d109f7cc Add an flag to control whether rooms the user has left are included in the sync 2015-12-04 16:44:11 +00:00
Daniel Wagner-Hall e0ebabf8cc Explicitly document /rooms/{roomId}/state/{eventType} without state key 2015-12-04 11:42:19 +00:00
Daniel Wagner-Hall 873b0dcecf Replace version numbers with release numbers 2015-12-04 11:09:35 +00:00
Daniel Wagner-Hall f308b7543c Specify /admin/whois/{userId} 2015-12-03 16:26:45 +00:00
Daniel Wagner-Hall 19ce17cfed Merge pull request #200 from matrix-org/daniel/redact 
Merge pull request #200 from matrix-org/daniel/redact
 2015-12-03 15:57:52 +00:00
Daniel Wagner-Hall 2f3a00fe34 Consistently spell homeserver as homeserver 2015-12-02 19:23:33 +00:00
Daniel Wagner-Hall e072d215cf Specify redaction 2015-12-02 15:27:25 +00:00
Daniel Wagner-Hall 7f07da4b50 Remove obsolete documentation 2015-12-01 17:29:09 +00:00
Daniel Wagner-Hall aa4ed10821 Unify v1 and v2 event schemas 2015-12-01 17:23:58 +00:00
Daniel Wagner-Hall 681c258206 Fix turnServer endpoint 2015-12-01 16:56:28 +00:00
Erik Johnston ca7ef1b536 Update Results description 2015-12-01 15:34:25 +00:00
Erik Johnston 5e8bb34f36 Change the results dict to a list 2015-12-01 15:33:13 +00:00
Erik Johnston 46fd0b252c Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian 2015-12-01 15:06:13 +00:00
Daniel Wagner-Hall c6e0322a9e Swaggerify /account 2015-12-01 13:53:03 +00:00
Daniel Wagner-Hall 6c66bfc755 Flatten out v1 and v2_alpha directories 
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
 2015-11-30 11:22:57 +00:00
Daniel Wagner-Hall 3951785f19 Fix alias path 2015-11-27 16:23:31 +00:00
Daniel Wagner-Hall bc514dc9c4 Merge pull request #178 from matrix-org/daniel/directory 
Fix and include /directory api docs
 2015-11-27 16:21:15 +00:00
Daniel Wagner-Hall 7f2813354d Swaggerify /ban 2015-11-27 15:42:21 +00:00
Mark Haines a20a49abf6 Merge pull request #168 from matrix-org/markjh/client_config 
Add API for setting client config
 2015-11-27 15:32:21 +00:00
Mark Haines c5f457cee9 Merge pull request #132 from matrix-org/markjh/room_tags 
Document a v2 api for setting tags on rooms
 2015-11-27 15:31:54 +00:00
Daniel Wagner-Hall f0c99a6925 Generate API docs from swagger 2015-11-27 15:03:22 +00:00
Mark Haines c539b208f9 Merge branch 'markjh/room_tags' into markjh/client_config 
Conflicts:
	api/client-server/v2_alpha/sync.yaml
 2015-11-26 16:56:39 +00:00
Mark Haines d39494b6df Fix typo in sync example 2015-11-26 16:55:12 +00:00
Daniel Wagner-Hall 5e30b5b8d7 Remove POST version of /send 
PUT should always be used.
 2015-11-26 16:46:29 +00:00
Daniel Wagner-Hall c25a806cef Fix and include /directory api docs 2015-11-26 15:03:39 +00:00
Mark Haines 5ccc39b850 Say that type is an event type 2015-11-20 18:45:09 +00:00
Mark Haines e76068a2a6 Merge branch 'markjh/room_tags' into markjh/client_config 2015-11-20 18:40:56 +00:00
Mark Haines 5bae15d47b Merge branch 'master' into markjh/room_tags 
Conflicts:
	api/client-server/v2_alpha/sync.yaml
 2015-11-20 18:39:15 +00:00
Erik Johnston 46870da57d Add optional profile info and state in search response 2015-11-20 15:29:36 +00:00
Richard van der Hoff d8dd380dfa Merge pull request #164 from matrix-org/rav/SPEC-254 
Fix /sync documentation, post SPEC-254
 2015-11-20 15:17:55 +00:00
Mark Haines 05c0092664 s/config/account_data/ 2015-11-19 10:38:22 +00:00
Richard van der Hoff d7d59d78e1 /sync: Put state dict back to being a list 
Turning the state into a dict-of-dicts caused more pain than it solved. Put it
back to a list.
 2015-11-18 16:17:29 +00:00
Mark Haines 40f7eab73f s/private_user_data/account_data/ 2015-11-18 15:44:18 +00:00
Mark Haines 24c4b8b095 Merge branch 'markjh/room_tags' into markjh/client_config 
Conflicts:
	api/client-server/v1/rooms.yaml
	api/client-server/v1/sync.yaml
	api/client-server/v2_alpha/sync.yaml
	specification/targets.yaml
 2015-11-18 15:30:16 +00:00
Mark Haines fcbb985073 s/private_user_data/account_data/ 2015-11-18 15:27:26 +00:00
Richard van der Hoff 6653362f31 Unflatten 'unsigned' 
It turns out that flattening 'unsigned' comes with too many downsides. Let's
stick with the status quo.
 2015-11-18 15:15:21 +00:00
Daniel Wagner-Hall 6763317e64 Specify /rooms/:room_id/forget 2015-11-17 10:33:46 -05:00
Daniel Wagner-Hall 8201eaa042 Swaggerify /rooms/:room_id/leave 2015-11-17 15:31:10 +00:00
Erik Johnston ffed14a0cd Add next_batch token 2015-11-17 10:02:02 +00:00
Erik Johnston 8991c4fa78 Fix schema and example 2015-11-16 18:00:48 +00:00
Erik Johnston 5e0e4a8518 Document group and context response keys 2015-11-16 17:22:56 +00:00
Mark Haines 299af673da Specify how ordering of tags is supposed to work 2015-11-16 17:04:19 +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
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
Mark Haines 22b3159a39 Add examples of v1 initialSync and v2 /sync returning the client config 2015-11-16 16:34:39 +00:00
Mark Haines 769c5285ab Add API for setting client config 2015-11-16 16:33:57 +00:00
Erik Johnston e2eb0c7ad9 Add new request options 2015-11-16 16:04:23 +00:00
Richard van der Hoff e1b12a753e Fix typos and missing file 2015-11-16 00:17: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 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
Erik Johnston fa2fe2ddd9 Add event context api swagger 2015-10-29 12:43:36 +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