matrix-doc/api
Travis Ralston 42ae5c966a Clarify the limits of prev_events and auth_events
Fixes https://github.com/matrix-org/matrix-doc/issues/2307

These restrictions are due to a Synapse change which never made it to the spec prior to the MSC process. This is therefore documenting an omission.

Synapse's numbers are verified here: 207b1737ee/synapse/handlers/federation.py (L1183-L1213)

... and Synapse's handling of the backfill endpoint is described here: 207b1737ee/synapse/handlers/federation.py (L829-L837)

This also includes a mention that https://github.com/matrix-org/matrix-doc/pull/1594 should render the `auth_events` limitation unnecessary. 

No changes are required to the the "checks on receipt of a PDU" section of the server-server spec as it starts with "must be a valid event", to which an event is invalid if it contains too many prev or auth events.
2020-05-12 19:02:39 -06:00
..
application-service Switch to using $ instead of # for sub-types 2019-05-29 15:28:48 -06:00
client-server Merge pull request #2524 from uhoreg/e2e_misc_fixes_202005 2020-05-05 16:10:27 -04:00
files fix for https://github.com/matrix-org/matrix-doc/issues/270 2016-02-16 11:01:04 +00:00
identity Clarify what format the `country` is on phone number inputs 2019-11-04 15:25:49 -07:00
push-gateway Fix Push Gateway API example: Field renamed to event_id 2019-07-03 10:36:16 +01:00
server-server Clarify the limits of prev_events and auth_events 2020-05-12 19:02:39 -06:00
README README.rst: Add notes on how to build the spec 2017-10-25 09:57:02 +01:00
check_examples.py Fix examples for new schema 2019-02-01 11:14:42 -07:00
openapi_extensions.md Document OpenAPI extension 2018-08-12 16:52:07 +09:00
package.json Reinstate validator.js 2016-05-04 00:19:46 +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.