You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
matrix-spec/api
Travis Ralston 6ad71f785e Improve documentation for pushers and push gateways
This fixes a number of formatting issues alongside a few documentation problems:
* The push gateway can actually expect less parameters than previously advertised. This is for user privacy.
* Introduction of the `m.email` pusher for email-capable homeservers.
* Fields not being flagged as required on some endpoints.
* Document the `event_id_only` format

Note: this does not attempt to document push rules, just pushers.

Fixes https://github.com/matrix-org/matrix-doc/issues/1374
Fixes https://github.com/matrix-org/matrix-doc/issues/1087
6 years ago
..
application-service Move TODO. field1, field2... -> fields... 6 years ago
client-server Improve documentation for pushers and push gateways 6 years ago
files fix for https://github.com/matrix-org/matrix-doc/issues/270 9 years ago
identity convert IS endpoints to Swagger (#1427) 6 years ago
push-gateway Improve documentation for pushers and push gateways 6 years ago
server-server Merge pull request #1469 from turt2live/travis/s2s/backfill 6 years ago
README README.rst: Add notes on how to build the spec 7 years ago
check_examples.py Revert giving get() a default 6 years ago
openapi_extensions.md Document OpenAPI extension 6 years ago
package.json Reinstate validator.js 9 years ago
validator.js Provide doc-comments with makeHandler(); cleanup 7 years ago

README

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