wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
docs-matrix-spec/api
History
Travis Ralston 2ac80d38d7 Document the /publicRooms endpoint for federation 
This intentionally doesn't document the third party network aspect of the endpoint. This is scheduled for a later area for dealing with third party network/IDs and is reported as https://github.com/matrix-org/matrix-doc/issues/1476

The client-server response has been broken out to a shared file: both the client-server and server-server /publicRoom endpoints return the same thing, with slightly different inputs.

The inputs (and behaviour) are based upon the docstring here: 43ecfe0b10/synapse/federation/transport/server.py (L583-L612)
2018-08-03 11:23:44 -06:00
..
application-service Move TODO. field1, field2... -> fields... 2018-07-30 19:21:54 +01:00
client-server Document the /publicRooms endpoint for federation 2018-08-03 11:23:44 -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 Document the /publicRooms endpoint for federation 2018-08-03 11:23:44 -06:00
check_examples.py Revert giving get() a default 2018-07-29 14:04:07 +09:00
openapi_extensions.md Move TODO. field1, field2... -> fields... 2018-07-30 19:21:54 +01: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.