wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
docs-matrix-spec/api
History
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
..
application-service Convert 3pn errors to new definition 2018-07-12 12:16:11 -06:00
client-server Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 2018-07-18 08:28:16 -06:00
files fix for https://github.com/matrix-org/matrix-doc/issues/270 2016-02-16 11:01:04 +00:00
identity Add IS ping endpoint 2018-02-27 17:54:42 +01:00
push-gateway Add operationId to all endpoints of all APIs 2017-10-11 01:58:31 +09:00
server-server Improve the server key exchange portion of the s2s specification 2018-07-26 08:41:00 -06:00
check_examples.py Update the check_examples.py script to resolve references 2018-07-24 10:58:15 -06:00
package.json Reinstate validator.js 2016-05-04 00:19:46 +01:00
README README.rst: Add notes on how to build the spec 2017-10-25 09:57:02 +01:00
validator.js Provide doc-comments with makeHandler(); cleanup 2017-11-15 07:28:25 +09:00

README 

This directory contains swagger-compatible representations of our APIs. See
the main README.rst for details on how to make use of them.