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

245 commits

Author SHA1 Message Date
Kegsay 51a7681ece Merge pull request #4 from matrix-org/use-cases 
Add Client-Server v2 General API Design
 2015-01-21 10:30:27 +00:00
Kegsay fcbdc39674 Add section on device IDs for reg/login 
Final cleanup before merge
 2015-01-21 10:28:01 +00:00
Kegsay ccf8408e92 More tweaks from comments 2015-01-21 10:19:48 +00:00
Kegsay 31deddccdf Add presence API from notes 2015-01-21 09:53:47 +00:00
Kegsay 90dfee1c27 Remove TODO note on regex 2015-01-20 17:49:09 +00:00
Kegsay 23d3e50812 Add use case justification for regex 2015-01-20 17:48:43 +00:00
Kegsay 7a2b6abee5 Flesh out ID conventions 
Going down the API route.
 2015-01-20 14:22:48 +00:00
Erik Johnston 5279541c28 Update erikj_federation.rst 
Update state resolution rules to indicate what you should do if none of the merged events are allowed by the newly merged auth events.
 2015-01-20 11:08:43 +00:00
Kegsay 3b35e95630 Tweaks based on feedback 2015-01-19 17:37:23 +00:00
Kegsay 61b8664286 Clarify profile propagation section more 2015-01-19 17:24:28 +00:00
Kegsay a1964b466b Add profile propagation notes 
After much IRL discussion
 2015-01-19 17:17:33 +00:00
Kegsay ef0091f3f2 Remove session section 
This is no longer required.
 2015-01-19 12:03:52 +00:00
Kegsay ae0fb938ad Update IRC example to reflect new room ID 2015-01-19 10:45:51 +00:00
Kegsay 117b090192 Add registration API extension. 
For AS provisioning of users with its namespace.
 2015-01-19 10:33:08 +00:00
Kegsay 603361bfd6 Update user and room query APIs 
Expect the AS to create these entities, rather than the HS.
 2015-01-19 10:20:39 +00:00
Erik Johnston 38efa9c5c2 Reword auth resolution section 2015-01-16 16:09:07 +00:00
Erik Johnston 91aba39fe7 Reword note about auth chains 2015-01-16 15:17:09 +00:00
Erik Johnston 5f99858575 Mention possible types for auth events. 2015-01-16 15:12:47 +00:00
Erik Johnston bb968e5bdd Clarify m.room.create auth 2015-01-16 15:12:34 +00:00
Kegsay 828d6992e5 Small thoughts about the IRC example. 2015-01-16 14:35:20 +00:00
Kegsay bd6fc4b5bf Add draft Pushing API. Add Examples section. 
Work through an IRC example; raise issues in the notes
section. Add retry notes on HS>AS API calls.
 2015-01-16 14:29:53 +00:00
Kegsay 1d45dc08ca Add room query API. Remove linking API. 
Also add section on ID conventions which need thinking about.
 2015-01-16 10:56:42 +00:00
Erik Johnston 78a697c535 Briefly touch on how to handle incoming events 2015-01-16 10:24:43 +00:00
Erik Johnston 406742afaa A few notes on how we could do state resolution of auth events 2015-01-16 10:15:07 +00:00
Erik Johnston 4b76181f74 Rearrange sections 2015-01-16 10:15:07 +00:00
Kegsay f33b722e4b More clarifications 
s/as_token/access_token/ for CS extensions. Clarify when room queries are made.
 2015-01-16 08:28:55 +00:00
Kegsay 1b3e27a05a Add Linking HTTP API 
Also add note on masquerading problem.
 2015-01-15 17:26:36 +00:00
Kegsay 0313397e42 Clarification on IDs 
Specifically using the term "virtual user ID" in more places to mean the namespace of AS user IDs.
 2015-01-15 16:51:20 +00:00
Kegsay e0e9beebc0 Add draft Linking API 
Also re-add sigils to regex.
 2015-01-15 16:48:39 +00:00
Kegsay 7d56113b4f Clarification and tweaks 
Room ID namespace clarifications and s/as_token/access_token/g for client-server extensions.
 2015-01-15 14:27:20 +00:00
Kegsay d4ea43d2b9 Outline what the CS extensions look like in HTTP 2015-01-15 13:56:03 +00:00
Kegsay 9401d9a62e Flesh out the required CS extensions 2015-01-15 13:48:50 +00:00
Kegsay d8cd4a45d4 Modify Register API 
As per https://github.com/matrix-org/matrix-doc/pull/5#issuecomment-70059200
 2015-01-15 09:50:38 +00:00
Matthew Hodgson b19a799a0e notes on how to build pstn gateway ASes 2015-01-15 01:57:03 +00:00
Kegsay cdeb0faf85 Remove block quotes of shame 2015-01-14 17:17:18 +00:00
Kegsay d240e1f856 Add TODO APIs 2015-01-14 17:01:33 +00:00
Kegsay ad7d675d3d Draft Registration and User Query APIs 2015-01-14 16:40:50 +00:00
Erik Johnston b28f404240 Add ToC 2015-01-14 16:30:25 +00:00
Erik Johnston 7108316ea8 Mention the fields that the server should compute when creating events 2015-01-14 16:24:33 +00:00
Erik Johnston 232e2675dd Brief mention of state conflict resolution 2015-01-14 16:24:33 +00:00
Erik Johnston f09e5a676f Mention state resolution algorithm 2015-01-14 16:24:33 +00:00
Erik Johnston 7d32717c9b A couple of more notes on auth resolution. 2015-01-14 16:24:33 +00:00
Kegan Dougal 68c774689a Add stub AS HTTP API doc 2015-01-14 15:34:07 +00:00
Kegsay 540b3a41ff RSTify; typos 2015-01-14 15:15:40 +00:00
Mark Haines ee41165610 Remove cs-v2-http-api since it's in the client_server_v2_http_api branch now 2015-01-14 11:57:07 +00:00
Mark Haines 6324f8c1ca Fix the size of the reference id hash tuple 2015-01-14 11:49:46 +00:00
Erik Johnston 90ad08e866 Merge branch 'master' of github.com:matrix-org/matrix-doc 2015-01-14 11:39:39 +00:00
Erik Johnston 48f9670b87 More comments on auth chain resolution 2015-01-14 10:59:28 +00:00
Kegsay 4b23a16abb Few minor RST tweaks 2015-01-14 10:53:49 +00:00
Kegsay 8ca0c65fd3 RST Formatting for github 2015-01-14 10:44:47 +00:00
Kegsay a1aaf78186 Typing API, Action ID, Event ordering changes 
Apply most changes discussed in https://github.com/matrix-org/matrix-doc/pull/4#issuecomment-69751210
- Revert typing API to be like v1
- Revert Action IDs to be like Transaction IDs are for v1. Keep the echo down the event stream though.
- Add batching notes to some Action APIs and remove ordering by action ID.
Sessions still need to scrapped.
 2015-01-14 09:28:41 +00:00
Matthew Hodgson 91ad3924fc initial http api proposal for initialsync, eventstream and history 
+ our theoretical design workflow atm
 2015-01-14 01:08:27 +00:00
Mark Haines ae9aacd89d Add a JSON schema for matrix federation events 2015-01-13 19:03:11 +00:00
Matthew Hodgson b557e71121 update AS API to merge in feedback from the pull request 2015-01-13 16:25:28 +00:00
Matthew Hodgson e283d8e4ea WIP http api definition for cs-v2 2015-01-13 13:20:45 +00:00
Matthew Hodgson 1c69ba974f some comments on general_api 2015-01-13 13:20:25 +00:00
Kegan Dougal d5099b2656 Add session API. Add server-generated events. 
Moved 'Inviting' API from Final to ONGOING in light of issues brought up
from PR comments and irl discussions.
 2015-01-13 09:51:53 +00:00
Kegan Dougal d987afe3e2 80 characters 2015-01-13 09:17:13 +00:00
Erik Johnston 569d496430 Rearrange sections 2015-01-12 16:57:02 +00:00
Kegsay e2894045d5 Initial Sync: Ongoing > Draft with additional work 
Descoped some points to v2.1 as discussed irl.
 2015-01-12 15:52:19 +00:00
Erik Johnston e0a9328432 Auth chains 2015-01-12 15:05:02 +00:00
Erik Johnston f993c30a11 Quick summary of failures. 2015-01-12 14:13:08 +00:00
Kegan Dougal 8fc472c13c Clarify rejected events better. 2015-01-12 13:29:48 +00:00
Kegan Dougal 4a4f9151ef Add notes on patching power levels and compacting initial sync events. 2015-01-12 13:20:04 +00:00
Kegan Dougal 6705f0891d Factor out parts of room history APIs. Add in a terminology section for the different kinds of tokens. s/public rooms/published rooms/g 2015-01-12 12:59:11 +00:00
Kegan Dougal 49fd110cc4 Remove old csv2 rst from closed PR. 2015-01-12 11:50:00 +00:00
Kegan Dougal eb237ed297 Blob v2 features into 2.0/2.1 2015-01-12 11:49:20 +00:00
Erik Johnston 53449c4f8a Basic outline of invitations 2015-01-09 16:35:29 +00:00
Erik Johnston c481469073 Quick summary of joining a remote room 2015-01-09 15:52:40 +00:00
Erik Johnston 936d437a21 Add definitions and validation rules of some of the event fields 2015-01-09 14:16:15 +00:00
Erik Johnston 71e25e70d3 Add section about auth events and more todos 2015-01-09 14:03:18 +00:00
Erik Johnston 67100b541a Add file with random disconnected bits of spec of current federation api 2015-01-09 13:29:14 +00:00
Kegsay 79c510dadc Add TODO stub for room knocking 
Mainly for SPEC-60
 2015-01-08 17:39:01 +00:00
Kegsay af3baef164 Add draft Account Management API 
Mainly for SPEC-50
 2015-01-08 17:37:05 +00:00
Kegsay c068dd414e Send message API: Add compact flag notes 2015-01-07 15:28:05 +00:00
Kegsay efd9b8a53e Add draft User Profile API 2015-01-07 11:33:05 +00:00
Kegsay a42ab43265 Add draft room alias API 2015-01-07 10:53:34 +00:00
Matthew Hodgson 7a4515def8 support arbitrary ordering of mail-style use case, and add mergable threads to IM 2015-01-06 19:45:40 +00:00
Mark Haines 6515dbc467 Add note about typing notifs to Multi-Threaded IM 2015-01-06 19:28:27 +00:00
Mark Haines 8f1d06e94b Add use cases for email and multithreaded IM 2015-01-06 19:23:59 +00:00
Kegsay 33b2ee562c Formatting. 2015-01-06 17:27:05 +00:00
Kegsay f88527724f TODO/notes consistency. Add a few minor points. 2015-01-06 17:25:31 +00:00
Kegan Dougal 9408bc8260 Add notes to ONGOING APIs. 2015-01-06 17:20:00 +00:00
Kegan Dougal 6ce518eb19 Add v2 path prefix. Add draft public room list API. 2015-01-06 16:54:14 +00:00
Kegan Dougal 2c18690766 Add back in missed TODOs 2015-01-06 16:35:41 +00:00
Kegan Dougal dbedfacfa4 Rejig sections. Add a TOC to reduce duplication of API status. 2015-01-06 16:19:04 +00:00
Kegan Dougal a01dd787c5 Add read-up-to markers and clear up the remaining TODO notes. 2015-01-06 15:49:52 +00:00
Kegan Dougal 1e27cddf95 Missed a marker 2015-01-06 15:04:08 +00:00
Kegan Dougal 760fc2e15b Refactor document to be clearer on where the APIs are. Mark each one as either TODO, ONGOING, Draft or Final. 2015-01-06 15:00:28 +00:00
Kegan Dougal 494a691a8c Limit 80; fix RST formatting. 2015-01-06 14:27:44 +00:00
Kegan Dougal 14624607bb Add summary block with high-level view of the proposed APIs. 2015-01-06 13:23:31 +00:00
Kegan Dougal 3996007449 Add a bunch of TODO points. Tweak wording and give more info on some APIs. 2015-01-06 13:06:01 +00:00
Matthew Hodgson 259cdd253a fix plural 2015-01-06 11:54:02 +00:00
Matthew Hodgson deb24aecf4 some thoughts on invisibility 2015-01-05 18:42:22 +00:00
Mark Haines 72f0245701 Note that default HS to search is the on the client connects to 2015-01-05 17:54:15 +00:00
Mark Haines a0063b1143 Add a section for searching for public rooms to the use cases 2015-01-05 17:52:24 +00:00
Mark Haines 4e8713c9ce Add a chat history screen to the im client use case 2015-01-05 16:01:30 +00:00
Matthew Hodgson 01bc9eb4a1 some forgotten AS use cases 2015-01-05 15:16:10 +00:00
Kegan Dougal cf9bdf87fb Add summary 2015-01-05 13:34:52 +00:00
Kegsay 3ec7a27edb Clarify what deleted events look like 2014-12-31 16:12:44 +00:00
Kegsay 9af912eba5 Add capability API 2014-12-31 16:05:24 +00:00
Kegsay 6e8cbb1eba Small HTTP note on message ordering 2014-12-31 13:53:45 +00:00
Kegsay 6904b2868e Update general_api.rst 
Add info on smaller APIs / edge cases.
 2014-12-31 12:36:56 +00:00
Kegsay 2ae66c661a General VoIP outline 2014-12-30 16:26:27 +00:00
Kegsay 65348aa578 Add more info on sessions, filtering and updates/replies to 2014-12-30 15:37:26 +00:00
Kegan Dougal fe052ea4f8 Match numbering used in the document 2014-12-30 10:04:33 +00:00
Kegan Dougal 12382bbd85 Add back in the use case bullet points 2014-12-30 10:04:33 +00:00
Matthew Hodgson f91f569f30 explain why the @.irc.freenode style prefixes are a good idae 2014-12-30 03:10:11 +00:00
Matthew Hodgson 5f97e28c9b initial formal proposal for the AS API 2014-12-30 03:00:37 +00:00
Kegsay 1a92548b9c Add general API design 
Several missing sections: VoIP, presence, typing, but many core ordering and event mapping issues are addressed.
 2014-12-29 16:46:48 +00:00
Matthew Hodgson 40424eded9 a few forgotten things 2014-12-24 20:23:39 +00:00
Matthew Hodgson 30fc5284db spell out that the media repo is distributed... 2014-12-24 17:36:05 +00:00
Kegan Dougal 6c9bbb0062 Add in context feature which got lost. 2014-12-24 17:27:07 +00:00
Kegan Dougal a4dd358ac6 Expand example to be message/topic/name/member and not just message. 2014-12-24 17:27:06 +00:00
Kegan Dougal d8cc46e08e Strawman client-server v2 proposal. 2014-12-24 17:27:06 +00:00
Mark Haines fc3b135cbb Ascii art for object model 2014-12-23 14:50:34 +00:00
Kegan Dougal 8e3e67fa39 Add stub object model 2014-12-23 14:06:10 +00:00
Kegsay f92ac373c4 Update data_flows.rst 
Add bug tracking.
 2014-12-23 14:01:30 +00:00
Kegsay eb9a8c39e7 Update data_flows.rst 
Add some data flows for IM.
 2014-12-23 12:04:05 +00:00
Kegan Dougal 2f1d6cc8e2 Add data models. 2014-12-22 16:50:55 +00:00
Kegan Dougal 3fb8eb8cf7 rstify 2014-12-22 15:41:06 +00:00
Kegan Dougal 494b7b9843 Add fundamental client use cases. 2014-12-22 15:39:11 +00:00
Kegsay 37a7f2108e Update human-id-rules.rst 
Mention case canonicalisation on registration.
 2014-12-22 14:48:28 +00:00
Kegsay f2422eae3f Update human-id-rules.rst 
Moar clarify.
 2014-12-22 14:41:32 +00:00
Kegsay 408a0519ec Update human-id-rules.rst 
Clarify position on capitalisation.
 2014-12-22 14:39:16 +00:00
Kegan Dougal 4f3ee12409 Proposal for human ID rules. 
Includes handling of namespaces for bots, handing of capitalisation, spoof
checks and escape sequences.
 2014-12-22 10:46:50 +00:00
Kegan Dougal 31496deb63 Add c-s use cases: not yet sanitised for human consumption. 2014-12-19 12:53:10 +00:00
Mark Haines e3b83479a3 Return a mxc URI rather than a token from _matrix/media/v1/upload 2014-12-15 19:22:39 +00:00
Paul "LeoNerd" Evans 01b4dae166 Give m.typing events a toplevel 'content', in which is given the list of user IDs 2014-12-12 11:53:48 +00:00
Paul "LeoNerd" Evans 2edca3ca7f Initial draft hack for typing notification docs 2014-12-11 19:04:18 +00:00
Mark Haines f52385a1dd Add a draft spec for the media repository 2014-12-11 18:48:17 +00:00
Matthew Hodgson d0dd75a18f general editing throughout the overview section; merge in bits of erik's model to overview section and split the original back out into drats 2014-11-17 21:08:17 -08:00
Erik Johnston 37bbd649c4 Add a section about state/auth querying 2014-11-14 15:19:58 +00:00
Erik Johnston 1ec0c79d9f Badly explain pdu failures 2014-11-14 14:02:15 +00:00
Erik Johnston 1eacc25a18 Talk about how to deal with unauthorized events 2014-11-14 11:30:43 +00:00
Erik Johnston b8d5fa724c First (WIP) draft on new s-s apis 2014-11-14 10:29:02 +00:00
Mark Haines 6090049c3e Fix formating 2014-11-12 14:43:56 +00:00
Matthew Hodgson c7d0039c26 move stuff from synapse/doc 2014-11-12 03:13:15 +02:00
Matthew Hodgson 44f6077705 what was versioning.rst 2014-11-11 21:11:47 +02:00
Matthew Hodgson eeb596b20b merge core_model into spec 2014-10-17 18:56:49 +01:00
Erik Johnston aa8806c9fd Add deleting state section 2014-10-13 13:37:05 +01:00
Erik Johnston feabd4c015 Add Architecture section 2014-10-13 13:36:57 +01:00
Erik Johnston e7599bdf46 Reword some of the sentences to make it clearer. 2014-10-13 11:46:55 +01:00
Erik Johnston a2d9e8ca22 Add draft core_model.rst 2014-10-10 16:35:34 +01:00
Matthew Hodgson 556e3f8a71 move matrix-generic documentation from synapse/docs into new matrix-doc project 2014-10-09 20:30:40 +02:00