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
Richard van der Hoff b2e0a855cc Add 'event' to event context API 
also link through to the event schemas
 2016-02-01 17:45:45 +00:00
Daniel Wagner-Hall 0da26cd7e1 Specify login behaviour for unknown 3pids 2016-01-29 16:49:54 +00:00
Mark Haines 245e8e8571 Add 3pid password login to the spec 2016-01-29 14:42:18 +00:00
Daniel Wagner-Hall 2e46b587b8 Require explicit un-banning 2016-01-15 14:08:40 +00:00
David Baker 169cc98101 M_INVALID_USERNAME to be consistent with the name of the parameter 2016-01-15 10:04:29 +00:00
David Baker 2301a792d7 Add an error code for invalid user names. 2016-01-14 17:19:04 +00:00
Daniel Wagner-Hall 9bc07ea093 Add ID to application services 2016-01-13 16:04:01 +00:00
Daniel Wagner-Hall 1e2b63763e /join and /room/:roomId/join aren't exact aliases 
Separate them, clarify their differences.

Also, fix some links which weren't being properly populated.
 2016-01-13 15:55:51 +00:00
Richard van der Hoff 91fa78eb53 Start development on next spec version 2016-01-11 15:52:08 +00:00
Richard van der Hoff cff1b4ae35 Merge pull request #251 from matrix-org/daniel/guestshiz 
Clarify guest /events and /sync
 2016-01-08 00:47:57 +00:00
Matthew Hodgson 411ab64712 fix misnamed key in example; thanks SkaveRat 2016-01-07 23:15:33 +00:00
Daniel Wagner-Hall 3edff684a1 Merge pull request #253 from matrix-org/daniel/guestupgrade 
Guests can upgrade to regular accounts
 2016-01-07 16:39:35 +00:00
Daniel Wagner-Hall f6b1b80678 Fix param name 2016-01-07 13:18:19 +00:00
Daniel Wagner-Hall 7d9547274c Clarify guest /events and /sync 2016-01-07 11:59:38 +00:00
Daniel Wagner-Hall 5e30d75ccb Add /_matrix/versions to spec 2016-01-06 17:43:20 +00:00
Daniel Wagner-Hall 713415015b Remove mention that /sync takes an inline filter 2016-01-06 15:51:07 +00:00
Daniel Wagner-Hall d3f05ae49a Guests can upgrade to regular accounts 2016-01-05 17:30:55 +00:00
Daniel Wagner-Hall ca67aa7b4f Tidy up guest access spec 
* Mention that /leave is allowed
* Mention that /sync is allowed
* Re-order such that the whole list of APIs fits on one screen
 2016-01-05 13:45:04 +00:00
Paul Evans c9ecfa7643 Merge pull request #242 from matrix-org/paul/federation 
Don't need to document /pdu/ any more
 2015-12-22 13:48:42 +00:00
Paul "LeoNerd" Evans 1f876778b5 Don't need to document /pdu/ any more 2015-12-21 16:50:56 +00:00
Paul Evans 0a2bdb1818 Merge pull request #240 from matrix-org/paul/federation 
Document the `/event` and `/backfill` S-S APIs
 2015-12-21 16:50:21 +00:00
Paul "LeoNerd" Evans 116253b2f5 Document the /event/:event_id/ federation endpoint 2015-12-17 20:45:57 +00:00
Richard van der Hoff e4dd346a81 Restore 'client behaviour' section 
Because it's the standard
 2015-12-17 14:07:35 +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 34bab312d3 Merge pull request #231 from matrix-org/daniel/oldversions 
Add links to old releases
 2015-12-17 11:24:28 +01:00
Paul "LeoNerd" Evans b9bee6ee73 Initial hack at some federation /backfill documentation 2015-12-14 20:00:49 +00:00
Matthew Hodgson f8f76794a3 fix random whitespace bug 2015-12-14 08:40:41 +00:00
Daniel Wagner-Hall 678dbbe08a s/-/_/ 2015-12-09 17:17:45 +00:00
Daniel Wagner-Hall 7f87760655 Add links to old releases 2015-12-09 16:45:56 +00:00
Daniel Wagner-Hall 8d184570a8 Mention intro before specs 2015-12-09 16:40:47 +00:00
Daniel Wagner-Hall 997f3303f3 Revert "Add links to old releases" 
This reverts commit de12870791.
 2015-12-09 16:38:40 +00:00
Daniel Wagner-Hall de12870791 Add links to old releases 2015-12-09 16:32:36 +00:00
Daniel Wagner-Hall 53a21fc0b6 Note why we're not versioning index and intro 2015-12-09 16:29:11 +00:00
Daniel Wagner-Hall 8eb84612f2 Add index page 2015-12-09 16:17:58 +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
Kegan Dougal bca3add9a7 Formatting 2015-12-08 16:38:48 +00:00
Kegan Dougal d01ff6b495 Add noddy push gateway placeholder 2015-12-08 16:37:51 +00:00
Daniel Wagner-Hall f22adad02e Merge pull request #225 from matrix-org/daniel/links 
Add link to speculator
 2015-12-08 16:19:17 +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
Daniel Wagner-Hall 4be078440d Don't mention server-server stuff in client-server spec 2015-12-08 15:42:37 +00:00
Erik Johnston c4085b0475 Merge pull request #139 from matrix-org/erikj/event_context_api 
Add event context api swagger
 2015-12-08 15:24:57 +00:00
Daniel Wagner-Hall fd3dde5e88 Add link to speculator 2015-12-08 14:42:10 +00:00
Paul "LeoNerd" Evans e32070f189 Decide that joining HS is the one that specifies the join event ID 2015-12-08 14:04:40 +00:00
Daniel Wagner-Hall a2283f5499 Remove /notify from client-server API 2015-12-08 13:25:31 +00:00
Daniel Wagner-Hall 217e22fc30 Format changelog more nicely 2015-12-08 13:18:36 +00:00
Daniel Wagner-Hall 19dfafe376 Remove superfluous space 
This causes a <dt> to get rendered around the <tt>s which breaks some
formatting.
 2015-12-08 10:34:48 +00:00
Erik Johnston dd276d4c4d Add event context module 2015-12-07 16:56:03 +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 2aef684e7e Add list of required supported groupings 2015-12-07 16:02:22 +00:00
Erik Johnston c61ae86102 Specify behaviour if server does not support pagination 2015-12-07 16:00:15 +00:00
Richard van der Hoff 3939ccf20c Remove e2e drafts from master 
This is now being tracked in the main spec, on the drafts/e2e branch.
 2015-12-07 14:45:46 +00:00
Daniel Wagner-Hall 39f43abbb7 Add per-API changelogs 2015-12-07 14:24:10 +00:00
Daniel Wagner-Hall 705556634a Add filters 2015-12-04 19:46:45 +00:00
Daniel Wagner-Hall 72e12bc2f5 Merge pull request #205 from jimmycuadra/signing-details-typo 
Fix typo in signing details
 2015-12-04 11:17:49 +00:00
Jimmy Cuadra 444fc5dbcd Fix typo in signing details. 2015-12-04 03:15:23 -08:00
Daniel Wagner-Hall 873b0dcecf Replace version numbers with release numbers 2015-12-04 11:09:35 +00:00
Daniel Wagner-Hall 63ca91f353 Move event signing to server-server spec 
It's *definitely* not a client concern.

It isn't really in the right place at the moment, but s-s is very much a
work in progress whereas c-s is nearly stable.
 2015-12-04 10:55:18 +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 4baba85fe5 Draftify e2e in anticipation of a spec release 2015-12-03 11:52:11 +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
Matthew Hodgson b946d39886 typo 2015-12-02 01:25:07 +00:00
Daniel Wagner-Hall c05da871ca Merge pull request #194 from matrix-org/daniel/clarify 
Merge pull request # 194 from matrix-org/daniel/clarify
 2015-12-01 18:46:39 +00:00
Daniel Wagner-Hall aa4ed10821 Unify v1 and v2 event schemas 2015-12-01 17:23:58 +00:00
Daniel Wagner-Hall 97fd1fdd62 Embed client and server release numbers 
Note that this also removes the changelog - I'm going to re-add the
changelog differently soon.
 2015-12-01 17:08:02 +00:00
Daniel Wagner-Hall f6229f649a Remove confusing wording 2015-12-01 16:58:40 +00:00
Daniel Wagner-Hall fd88be1830 Merge pull request #189 from matrix-org/daniel/sections 
Merge pull request # 189 from matrix-org/daniel/sections
 2015-12-01 16:43:17 +00:00
Erik Johnston 23b2497743 Expand on where pagination tokens can be returned 2015-12-01 15:31:35 +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 c9c433bc15 Make section depths consistent 2015-11-30 14:31:24 +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 b479b54cd8 Add tables of contents to individual specs 2015-11-27 18:52:58 +00:00
Daniel Wagner-Hall e401d3e262 Merge pull request #184 from matrix-org/daniel/splitspec 
Split spec into page-per-section
 2015-11-27 16:46:06 +00:00
Daniel Wagner-Hall e171acf01f Split spec into page-per-section 2015-11-27 16:45:47 +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
Richard van der Hoff d9130f0e13 Merge pull request #24 from matrix-org/markjh/end_to_end_encryption 
Basic specification for key distribution for end-to-end cryptography.
 2015-11-27 14:32:26 +00:00
Daniel Wagner-Hall ad4d8ae7a6 Move client-server intro to client-server section 2015-11-27 13:50:24 +00:00
Richard van der Hoff 0b1ba70a32 fix rst markup 
`` > `
 2015-11-27 13:33:58 +00:00
Richard van der Hoff 2dbb8ba56c Fix title levels 
make the title decoration consistent with the rest of the spec
 2015-11-27 12:53:03 +00:00
Richard van der Hoff 51ca25a472 Merge branch 'master' into markjh/end_to_end_encryption 2015-11-27 11:49:11 +00:00
Richard van der Hoff 5f4458b2ff Merge branch 'master' into markjh/end_to_end_encryption 2015-11-27 11:45:49 +00:00
Richard van der Hoff 8d41536757 Address kegan's comments 
Minor fixes to the e2e spec as raiseds by kegan
 2015-11-27 11:37:24 +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 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
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 032ee75537 Update specification wording to match s/config/account_data/ 2015-11-19 10:42:22 +00:00
Mark Haines 05c0092664 s/config/account_data/ 2015-11-19 10:38:22 +00:00
Paul Evans e95a1616af Merge pull request #143 from matrix-org/paul/federation-room-join 
Document the federation remote join handshake
 2015-11-18 19:21:04 +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 8201eaa042 Swaggerify /rooms/:room_id/leave 2015-11-17 15:31:10 +00:00
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