Commit graph

2883 commits

Author SHA1 Message Date
Richard van der Hoff 3ee75af06f Move 'Signing JSON' to appendices
Canonical JSON and JSON signing in general are common to the C-S spec. Move
them to the appendices instead of the S-S spec.
2016-10-31 12:36:47 +00:00
Richard van der Hoff a5e12814ef Split appendices up
Split appendices into multiple files
2016-10-31 12:01:37 +00:00
jan 7b4bba5cba Add mxpp to projects 2016-10-30 19:25:27 -07:00
Richard van der Hoff 0c3ecad3d4 Merge pull request #416 from matrix-org/rav/e2e_impl_sign_one_time_keys
E2e impl guide: sign one-time keys
2016-10-24 15:06:05 +01:00
Richard van der Hoff e53e3ab01a remove unsigned prop for verifying 2016-10-24 14:59:47 +01:00
Richard van der Hoff f0f6ea0cb3 E2e impl guide: sign one-time keys
We now sign our one-time keys.
2016-10-24 13:52:34 +01:00
Richard van der Hoff 41a528c551 Merge pull request #413 from matrix-org/rav/e2e_impl/rotate_megolm_sessions
E2E impl guide: Add details on rotating megolm sessions
2016-10-23 11:10:38 +01:00
Mark Haines 8a99d531a9 Merge pull request #414 from matrix-org/markjh/replays
Document the requirement that clients track the message_index
2016-10-21 16:52:52 +01:00
Mark Haines cbf94c88c2 Move the __ to where it should be 2016-10-21 15:50:54 +01:00
Mark Haines 6a5b66d2d8 Document the where the client gets the message index from 2016-10-21 15:48:44 +01:00
Mark Haines 8641ef299e Document the requirement that clients track the message_index 2016-10-21 15:25:33 +01:00
Richard van der Hoff c576a72673 E2E impl guide: Add details on rotating megolm sessions 2016-10-21 13:50:58 +01:00
Mark Haines 888e6a9f3b Merge pull request #404 from uhoreg/patch-2
add information about Perspectives
2016-10-21 09:52:05 +01:00
Richard van der Hoff 41da7a989f Merge pull request #412 from matrix-org/rav/e2e_impl/check_uks_attacks
E2E impl guide: Document unknown key-share mitigations
2016-10-19 17:28:03 +01:00
Richard van der Hoff 657525d0f4 E2E impl guide: Document unknown key-share mitigations
Document the fields to be added to Olm and the checks to be done to mitigate
the unknown key-share attacks.
2016-10-19 17:06:52 +01:00
Richard van der Hoff d93ef05f5e Merge pull request #411 from matrix-org/rav/e2e_impl/check_user_ids
E2E impl guide: check ids in device query
2016-10-19 11:45:15 +01:00
Richard van der Hoff 4d221bf77d Merge pull request #410 from matrix-org/rav/y_u_no_disable_e2e
Add an entry to the FAQ about disabling e2e
2016-10-19 11:45:03 +01:00
Richard van der Hoff 4368134970 Remove spurious backslashes 2016-10-18 20:41:16 +01:00
Richard van der Hoff 157e51fbc9 E2E impl guide: check ids in device query
Update the E2E impl guide to note that the user_id and device_id returned from
a device query need to be checked.
2016-10-18 20:40:42 +01:00
Richard van der Hoff 4c008a4771 Merge branch 'rav/e2e_guide' 2016-10-18 18:25:40 +01:00
Richard van der Hoff 05ca311be3 Put the E2E guide under guides 2016-10-18 18:03:20 +01:00
Richard van der Hoff 66a50855ff Merge branch 'rav/e2e_guide'
Land the E2E implementation guide
2016-10-18 16:06:56 +01:00
Richard van der Hoff 703b782ea1 e2e guide: remove refs to refresh tokens
refresh tokens are d34d
2016-10-18 16:06:22 +01:00
Richard van der Hoff 21888b5542 e2e guide: formatting tweaks 2016-10-18 16:05:17 +01:00
Richard van der Hoff e77dc0bd4c Add E2E implementation guide 2016-10-18 16:01:01 +01:00
Richard van der Hoff b6c59c137a Add an entry to the FAQ about disabling e2e 2016-10-17 00:37:19 +01:00
Richard van der Hoff 2ec43a5948 Add continuserv index
Oops, forgot this when adding support for the API docs to continuserv in
bfb65d8.
2016-10-14 17:57:07 +01:00
Richard van der Hoff d41438605d Use matrix.org for swagger UI
In the swagger UI, default to matrix.org rather than localhost, to make the UI
more useful.
2016-10-14 17:56:26 +01:00
Richard van der Hoff 33191e5555 Better examples 2016-10-14 15:57:52 +01:00
Richard van der Hoff dfbe416490 Better types for additionalProps
recurse down the definitions for additionalProps, so that the types are better
2016-10-14 15:57:52 +01:00
Richard van der Hoff aefe8f9430 Merge pull request #409 from matrix-org/rav/better_response_examples
Better support for examples in responses
2016-10-14 12:24:38 +01:00
Richard van der Hoff 57611ec523 More example formatting improvements
Generate more realistic example integers, and do some sanity checks on other
examples.
2016-10-14 12:20:00 +01:00
Richard van der Hoff b12b38d680 regrandfather json-formatted example params 2016-10-14 11:47:34 +01:00
Richard van der Hoff af84ca09a0 Better support for examples in responses
Walk the response schema to generate examples.
2016-10-14 11:17:06 +01:00
Richard van der Hoff 0f5e924ac9 Merge pull request #408 from matrix-org/rav/more_ordering_fixes
More ordering fixes
2016-10-14 10:37:18 +01:00
Richard van der Hoff d16385a74f More ordering fixes
We were breaking the ordering of objects defined by allOf reference
2016-10-14 10:33:23 +01:00
Erik Johnston d66792d5ca Mention order of returned results 2016-10-14 10:31:06 +01:00
Richard van der Hoff bfb65d8ceb Serve the API docs with continuserv 2016-10-13 23:54:08 +01:00
Hubert Chathi 0db7eed69d add information about Perspectives
add some information about how Perspectives works, link to their web site, and fix capitalization to match how the Perspectives Project capitalizes their name
2016-10-13 18:00:44 -04:00
Richard van der Hoff 28e7fcbeee Merge pull request #407 from matrix-org/rav/order_properties
Order props in the spec the same as the API
2016-10-13 22:15:43 +01:00
Richard van der Hoff e8915215a2 Merge pull request #405 from matrix-org/dbkr/push_examples_api_path
Fix API path in pushrules examples
2016-10-13 22:13:24 +01:00
Richard van der Hoff c66a83c9ff Order props in the spec the same as the API
Use an OrderedDict when reading the api docs so that properties defined in the
API are rendered in the same order in the spec.
2016-10-13 22:10:14 +01:00
Richard van der Hoff cfbee938b0 changelog: Fix a couple of punctuations 2016-10-13 18:06:43 +01:00
Richard van der Hoff 22777970da Fix speculator link
the link to the 'latest version' was broken
2016-10-13 17:56:53 +01:00
Richard van der Hoff f78e28ade1 Merge pull request #406 from matrix-org/rav/tmpl_work
Various spec templating fixes
2016-10-13 17:45:17 +01:00
Richard van der Hoff 93894ebbbe Fix spurious "None" in non-room events
Events like m.direct and m.tag don't inherit from either Message event or State
event, and were getting a "None" where there should have been a type.
2016-10-13 17:23:11 +01:00
Richard van der Hoff 3dd0fcabb3 Render the body of response objects with inheritance 2016-10-13 17:11:18 +01:00
David Baker 41f4661d1b Fix API path in pushrules examples 2016-10-13 15:14:29 +01:00
Oddvar Lovaas 09b568756c Merge pull request #403 from uhoreg/patch-1
s/vector/riot/
2016-10-13 14:56:25 +01:00
Hubert Chathi c26ed86215 s/vector/riot/
Replace references to Vector with Riot (when appropriate).
2016-10-12 23:20:55 -04:00