Commit graph

164 commits

Author SHA1 Message Date
Kegan Dougal 5614f7051b Updated howto.rst to use the new APIs. Updated JSFiddles to use 8008. Linked new fiddles with howto.rst. Added more explanations. 2015-01-22 11:53:11 +00:00
Matthew Hodgson ca0a642e66 change the world: make the default matrix API URL prefix /_matrix rather than /matrix to make it easier for existing websites to mount a HS in their namespace without collisions.
perl -pi -e 's#/matrix#/_matrix#g' ./cmdclient/console.py ./docs/client-server/howto.rst ./docs/client-server/specification.rst ./docs/client-server/swagger_matrix/directory ./docs/client-server/swagger_matrix/events ./docs/client-server/swagger_matrix/login ./docs/client-server/swagger_matrix/presence ./docs/client-server/swagger_matrix/profile ./docs/client-server/swagger_matrix/registration ./docs/client-server/swagger_matrix/rooms ./docs/server-server/specification.rst ./graph/graph.py ./jsfiddles/create_room_send_msg/demo.js ./jsfiddles/event_stream/demo.js ./jsfiddles/example_app/demo.js ./jsfiddles/register_login/demo.js ./jsfiddles/room_memberships/demo.js ./synapse/api/urls.py ./tests/federation/test_federation.py ./tests/handlers/test_presence.py ./tests/handlers/test_typing.py ./tests/rest/test_events.py ./tests/rest/test_presence.py ./tests/rest/test_profile.py ./tests/rest/test_rooms.py ./webclient/components/fileUpload/file-upload-service.js ./webclient/components/matrix/matrix-service.js
2015-01-22 11:53:11 +00:00
Kegan Dougal 1f3811b1b8 Fix JSFiddles to work with the new C-S API. 2015-01-22 11:53:11 +00:00
Kegan Dougal d5da30422c Added final jsfiddle: an example app demonstrating most of the c2s api. 2015-01-22 11:53:11 +00:00
Kegan Dougal eee7cd7730 Added more jsfiddles. 2015-01-22 11:53:11 +00:00
Kegan Dougal 8fb3367238 More fiddles, more fun! 2015-01-22 11:53:11 +00:00
Kegan Dougal 3dafe4133c Added registration/login jsfiddle, formatted so it can be loaded directly from jsfiddle. Requires jQuery 1.8.3 2015-01-22 11:53:11 +00:00
Matthew Hodgson 9a9d4b15d2 Merge pull request #8 from matrix-org/spec-18
Add spec for m.notice (SPEC-18)
2015-01-21 18:29:16 +00:00
Paul "LeoNerd" Evans a9a4c46a57 Add spec for m.notice (SPEC-18) 2015-01-21 18:26:27 +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
Kegan Dougal 62471348ca This is a comment, not a directive. Remove :: 2015-01-20 16:58:22 +00:00
Kegan Dougal 109c8a97a8 Use title heading sizings of =,-,~,+ since that is what most of our docs use. Inconsistent use breaks when you try to merge them. 2015-01-20 16:36:32 +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
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
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
Matthew Hodgson 3c16dbd63b it's 2015 2015-01-14 20:54:25 +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
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 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