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

2861 commits

This branch
This branch
All branches
Author SHA1 Message Date
Travis Ralston 73958ecbff Document /event_auth and /query_auth 
/event_auth is a fairly easy endpoint to determine the use case of. /query_auth is a little harder to investigate and has a fairly interesting purpose: it appears to be used for the sending server to admit defeat and shop around for the right auth chain, correcting it's own perspective as it goes.

/query_auth is based off the following research points in synapse:
* 43ecfe0b10/synapse/handlers/federation.py (L1947-L1990)
* 43ecfe0b10/synapse/handlers/federation.py (L2049-L2187)
* 43ecfe0b10/synapse/handlers/federation.py (L1716-L1761)
* 43ecfe0b10/synapse/federation/federation_server.py (L393-L446)
* https://github.com/matrix-org/synapse/blob/master/synapse/federation/transport/server.py#L482-L487
 2018-08-03 09:27:19 -06:00
Travis Ralston 329baa1b9d
Merge pull request #1472 from turt2live/travis/s2s/get-event 
Document event retrieval endpoints in more detail
 2018-08-03 08:53:49 -06:00
Travis Ralston 1578da453b
Merge branch 'master' into travis/s2s/get-event 2018-08-03 08:01:43 -06:00
Travis Ralston 86d7f42173
Merge pull request #1455 from turt2live/travis/s2s/leaving-rooms 
Document how leaving rooms/rejecting invites over federation works
 2018-08-03 08:00:56 -06:00
Travis Ralston d48f1e1713
Merge pull request #1461 from turt2live/travis/s2s/transactions 
Improve documentation on how Transactions work
 2018-08-03 07:38:45 -06:00
Travis Ralston e766606f24 join -> leave 2018-08-02 18:54:12 -06:00
Travis Ralston 48972addbf
Merge pull request #1428 from turt2live/travis/s2s/joining-rooms 
Improve the documentation for joining rooms
 2018-08-02 16:44:31 -06:00
Travis Ralston a9258ed195 an -> a 2018-08-02 16:43:29 -06:00
Travis Ralston 5596243add origin is required 2018-08-02 16:43:24 -06:00
Travis Ralston 8b7bc60367 list -> array 2018-08-02 16:42:03 -06:00
Travis Ralston 9d474bb819 Document event retrieval endpoints in more detail 
This also adds a previously-undocumented endpoint: /state_ids

Backfill is technically not part of this section, however it is being left untouched to make the merge with #1469 easier (which moves it out of the file).

Reference material:
* Some calls to synapse on these endpoints with a relatively simple private room.
 2018-08-02 12:44:54 -06:00
Travis Ralston b96ee3e393
Merge pull request #1423 from turt2live/travis/s2s/keys 
Improve the server key exchange portion of the s2s specification
 2018-08-01 07:44:57 -06:00
Andrew Morgan 54a88eebf0
Merge pull request #1414 from matrix-org/anoa/third_party_cleanup 
Clarification on third party fields
 2018-08-01 01:38:01 -07:00
Ben Parsons 1d019c3757
Merge pull request #1340 from matrix-org/benparsons/prdefence 
expect "#<pull-number>" or "/pull/<pull-number>" in PRs field
 2018-07-31 15:17:42 +01:00
Ben Parsons d7919b6989 also scrape PRs when the full URL is pasted 2018-07-31 15:08:42 +01:00
Travis Ralston bc3e45d642
Merge pull request #1358 from uhoreg/ignore-emacs-tmp 
ignore emacs temporary files
 2018-07-30 17:09:08 -06:00
Travis Ralston f5af4d2fb5
Merge pull request #1457 from matrix-org/dbkr/fix_room_tags 
Fix room tags spec
 2018-07-30 17:06:54 -06:00
Travis Ralston 761b0e4819
Merge pull request #1459 from QMatrixClient/check_examples_windows 
Make check_examples.py work on Windows
 2018-07-30 17:05:13 -06:00
Travis Ralston 7679b4f1d1 Improve documentation on how Transactions work 
The response is based upon various sections of the Synapse code in how it generates a response.

There are no new fields added to the transaction. Originally, `previous_ids` and `pdu_failures` were to be documented however neither of these are used in the real world.
 2018-07-30 16:58:13 -06:00
user 5f8967c074 Move TODO. field1, field2... -> fields... 2018-07-30 19:21:54 +01:00
user a2e2ced03b Add reverse-lookup examples. 2018-07-30 11:12:05 +01:00
user d785ac78a3 Remove explode and replace with TODO, require auth on CS 2018-07-30 11:12:05 +01:00
Andrew Morgan 53137a3c53 c/p bug, fix operationIds, move rst docs to md 2018-07-30 11:09:50 +01:00
Andrew Morgan 3e4962f211 Document standardized extensions to OpenAPI v2 2018-07-30 11:09:50 +01:00
Andrew Morgan 273acb277c Change fields to use new extended query array syntax 2018-07-30 11:09:50 +01:00
Andrew Morgan 0ff882fb3b Field definitions for protocol metadata 2018-07-30 11:09:50 +01:00
Kitsune Ral 346db48588 Revert giving get() a default 
As per the PR review.

Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
 2018-07-29 14:04:07 +09:00
Kitsune Ral c6bfac41c5 Bypass jsonschema references resolver 
jsonschema's resolver doesn't work with local files on Windows.
resolve_references only works with the local files (on Windows as well)
but that's exactly what's needed for the case (as long as we don't have
remote references, that is).

Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
 2018-07-29 12:40:19 +09:00
Kitsune Ral d17ec7f184 Check that path starts with file://, not file:/// 
Because file:/// is not a thing on Windows.
 2018-07-29 12:40:18 +09:00
Kitsune Ral 2c9f00d37a Follow PEP 8 2018-07-29 12:40:17 +09:00
Kitsune Ral 31687608dc Factor out common code 2018-07-29 12:40:16 +09:00
Travis Ralston 73b0a03b9b Remove more padding 2018-07-27 08:39:15 -06:00
David Baker 2dc51d416d Ignore stuff in m. you don't understand 2018-07-27 12:27:30 +01:00
David Baker 5ddf5374db Missing comma 2018-07-27 12:24:29 +01:00
David Baker f90ed4b77d Make non-namespaced tags verboten 2018-07-27 12:08:04 +01:00
David Baker e4fd088fcc Fix room tags spec 2018-07-27 12:05:30 +01:00
Travis Ralston cafd1a9ab3 Use more modern timestamps 2018-07-26 16:46:33 -06:00
Travis Ralston e27f4a69a0 Key versions must be [0-9a-zA-Z_] 2018-07-26 16:46:13 -06:00
Travis Ralston 8f1a4ae0ea Formatting 2018-07-26 16:43:51 -06:00
Travis Ralston bdccfca726 Timestamps should be in milliseconds 2018-07-26 16:43:43 -06:00
Travis Ralston cad1db2a14 Unpadded means unpadded 2018-07-26 16:43:16 -06:00
Travis Ralston 9dbb627d7b Undo accidental changes to the operation ID 2018-07-26 16:42:40 -06:00
Travis Ralston 2f71703427 Deprecate key ID querying 2018-07-26 16:42:21 -06:00
Travis Ralston 9fdd8a6f96 Document how leaving rooms/rejecting invites over federation works 
Fixes https://github.com/matrix-org/matrix-doc/issues/1401

This is very similar to the joining rooms handshake, and much of it is a near copy/paste of the make_join and send_join API. The major difference is the send_leave API doesn't return anything.

References:
* Handling of make_leave: d69decd5c7/synapse/handlers/federation.py (L1285-L1310)
* send_leave route: d69decd5c7/synapse/federation/transport/client.py (L267)
* make_leave route: d69decd5c7/synapse/federation/transport/server.py (L396)
* send_leave returning nothing: d69decd5c7/synapse/handlers/federation.py (L1346)
 2018-07-26 14:59:43 -06:00
Travis Ralston 1b374eafbc
Merge pull request #1454 from turt2live/travis/fix-proposals-blocked 
Only get issues that are proposals when finding proposals
 2018-07-26 09:59:16 -06:00
Travis Ralston 4f24d2101f Only get issues that are proposals when finding proposals 
Otherwise we end up with not-proposals showing up in the list.
 2018-07-26 09:51:08 -06:00
Travis Ralston c2f1c6e78d Improve the joining rooms handshake documentation 
There isn't a whole lot to this section that needed work. The section overall lost the table schema in favour of having the endpoints close by.

The directory query is improved in https://github.com/matrix-org/matrix-doc/pull/1443
 2018-07-26 08:43:08 -06:00
Travis Ralston 8e97b0ca81 Improve the server key exchange portion of the s2s specification 
Most of the text has been shuffled into the swagger definitions to bring it closer to where it matters.

This also attempts to clarify what is out in the wild. Most importantly, the first version of the key exchange is outright removed from the specification. Other research points/questions are:

* What is a "Key ID"?
  * 1241156c82/synapse/rest/key/v2/local_key_resource.py (L81-L83)
  * 1241156c82/synapse/rest/key/v2/local_key_resource.py (L88-L91)
* Returning a cached response if the server throws a 400, 500, or otherwise not-offline status code
  * 1241156c82/synapse/rest/key/v2/remote_key_resource.py (L227-L229)
* `minimum_valid_until_ts` default
  * This branch of the ladder: 1241156c82/synapse/rest/key/v2/remote_key_resource.py (L192)
* Returning empty arrays when querying offline/no servers
  * Queried by hand against matrix.org as a notary server with a fake domain name to query
* Returning all keys even when querying for specific keys
  * Queried by hand using matrix.org as a notary server against a server publishing multiple keys.

The examples and descriptions were also improved as part of this commit.
 2018-07-26 08:41:00 -06:00
Travis Ralston b0744aa1e9
Merge pull request #1413 from turt2live/travis/s2s/join-swagger 
Convert joins/invites to swagger
 2018-07-26 08:39:26 -06:00
Travis Ralston af0629a520 Full stop 2018-07-26 08:36:12 -06:00