Commit graph

228 commits

Author SHA1 Message Date
Matthew Hodgson 246531813b typo 2015-02-12 20:23:43 +00:00
Kegan Dougal 2b4641d1f0 Merge branch 'master' into v2-presence 2015-02-09 09:23:53 +00:00
Kegan Dougal 56f4467ced Fix syntax error 2015-02-09 09:19:45 +00:00
Kegan Dougal 7a59d401f6 Fix syntax errors 2015-02-09 09:17:55 +00:00
Kegan Dougal 2740e50a9f Merge branch 'master' into push 2015-02-09 09:14:39 +00:00
Kegan Dougal 74225013c5 Merge branch 'as-http-api' of github.com:matrix-org/matrix-doc into as-http-api 2015-02-09 09:13:52 +00:00
Kegan Dougal fa055e14ad Merge branch 'master' into as-http-api 2015-02-09 09:13:31 +00:00
Kegan Dougal 65b3cf3740 Merge branch 'master' into application-services 2015-02-09 09:12:58 +00:00
Matthew Hodgson 2c8b875cf1 typoe 2015-02-08 02:33:53 +00:00
Matthew Hodgson 6c5d07a0d1 typoe 2015-02-08 02:32:06 +00:00
Kegan Dougal 6c21f499e8 Final syntax fixes 2015-02-06 13:08:12 +00:00
Kegan Dougal 047355b5c9 More syntax fixes 2015-02-06 13:05:28 +00:00
Kegan Dougal 3b696878f5 Fix a bunch of rst syntax errors. 2015-02-06 12:59:08 +00:00
Kegsay 36395c2611 Add info on M_EXCLUSIVE 2015-02-06 11:01:20 +00:00
Kegsay e7c522b606 Add information on exclusive namespaces 2015-02-05 16:06:47 +00:00
David Baker 7c0d1c86d8 How to tell server default rules from other rules. 2015-02-05 14:56:07 +00:00
David Baker 8360be247b Leave out what characters are allowed in a rule ID as we allow most thigs in matrix usernames currently. 2015-02-05 13:15:34 +00:00
David Baker 94af47ffd4 Server default riules will have a rule_id when you need it to work out what the rule does. 2015-02-05 13:03:10 +00:00
David Baker e6c9e77d35 Change server default rules. 2015-02-05 10:49:48 +00:00
David Baker 8184855d5a add note about scope of rule_ids. 2015-02-04 16:30:57 +00:00
David Baker dbbf9626b4 Fix various incorreect examples in the doc. 2015-02-04 11:34:32 +00:00
David Baker f24e951b02 s/instance_handle/profile_tag/ 2015-02-03 16:21:09 +00:00
David Baker 91d12dc955 Replace set_sound with more generic set_tweaks. 2015-02-03 15:38:12 +00:00
David Baker 8920d58cc4 Strongly recommend standard URI scheme for notification pokes. 2015-02-03 14:35:01 +00:00
David Baker 067e4bb777 Add docs for http notification poke protocol. 2015-02-03 14:21:56 +00:00
David Baker 1a5678786f Doc deleting & getting rules. 2015-02-02 18:36:04 +00:00
David Baker c40b97aaf5 Rule adding API with examples 2015-02-02 18:16:36 +00:00
David Baker 88178e376e Oops, before is *more* important. 2015-02-02 17:26:58 +00:00
David Baker 0c79798f70 More WIP API docs and remove spurious line. 2015-02-02 17:10:09 +00:00
David Baker b7a6e8f7b5 Finish non-API doc parts of push rules. 2015-02-02 16:25:53 +00:00
David Baker f68fa8d6f8 Push rules c/s spec. 2015-02-02 15:14:45 +00:00
David Baker c27fb8a262 Add WIP docs for the client-server bit of push. 2015-02-02 13:49:18 +00:00
David Baker 0a07d68818 Add overview on push. 2015-01-28 18:20:28 +00:00
Kegan Dougal 0e2a3a892f Presence modifications from MatrixPresence notes.
- Idle is no longer a flag but a full state like online|offline.
- Clarify status examples.
- Add device ID to presence state API given it is per device.
- Add note on device specificity on event stream presence parameter.
- Add global appear-offline API.
2015-01-22 09:46:25 +00:00
Kegsay bd48e4ab6d Move invite data to a note
Done in order to clarify that this API "should probably have something like this" rather than "will have this".
2015-01-21 13:09:16 +00:00
Kegsay e309db547a Specifically reference join_rules
In reference to SPEC-63
2015-01-21 11:58:45 +00:00
Kegsay 03eaa21508 Add blurb on invites for initialSync 2015-01-21 11:56:55 +00:00
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