Commit Graph

246 Commits (6a3d68b7ed5560195bcadd9bbd05677cc69cd14f)

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