774 Commits (dafea96621d6383f6b44d9368024bb95c8ab94a7)

Author	SHA1	Message	Date
Andrew Morgan	0ff882fb3b	Field definitions for protocol metadata	6 years ago
Kitsune Ral	346db48588	Revert giving get() a default ... As per the PR review. Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>	6 years ago
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>	6 years ago
Kitsune Ral	d17ec7f184	Check that path starts with file://, not file:/// ... Because file:/// is not a thing on Windows.	6 years ago
Kitsune Ral	2c9f00d37a	Follow PEP 8	6 years ago
Kitsune Ral	31687608dc	Factor out common code	6 years ago
Travis Ralston	73b0a03b9b	Remove more padding	6 years ago
David Baker	5ddf5374db	Missing comma	6 years ago
David Baker	e4fd088fcc	Fix room tags spec	6 years ago
Travis Ralston	cafd1a9ab3	Use more modern timestamps	6 years ago
Travis Ralston	e27f4a69a0	Key versions must be [0-9a-zA-Z_]	6 years ago
Travis Ralston	bdccfca726	Timestamps should be in milliseconds	6 years ago
Travis Ralston	cad1db2a14	Unpadded means unpadded	6 years ago
Travis Ralston	9dbb627d7b	Undo accidental changes to the operation ID	6 years ago
Travis Ralston	2f71703427	Deprecate key ID querying	6 years ago
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)	6 years ago
Travis Ralston	fcaa299f81	Include information on how invite_room_state works ... This is completely optional, and the events included are up to the sender. Sources: * Structure: d69decd5c7/synapse/handlers/message.py (L896-L904) * What events are recommended: d69decd5c7/synapse/config/api.py (L30-L40)	6 years ago
Travis Ralston	f873bae0cc	Improve documentation for how non-third party invites work ... The details are fairly straightforward. An `event` has been added to the response body because that's what Synapse returns, despite the spec saying otherwise until now: d69decd5c7/synapse/federation/federation_server.py (L339)	6 years ago
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	6 years ago
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.	6 years ago
Travis Ralston	d914c402e2	Improve the profile query to have more sane responses ... This is a mix of Synapse and Dendrite behaviour, mostly Dendrite. Synapse returns `null` for field values that aren't set, however Dendrite just doesn't return them and instead opts for an empty object. Further, synapse is lacking in error codes in this area. Dendrite does some additional validation on this API which introduces more errors for bad requests, instead of defaulting to empty objects/200 OK responses. Likewise, Dendrite returns a 404 when the user is not found while Synapse returns 200 OK/empty object.	6 years ago
Travis Ralston	0ddf578b61	Combine all queries into their own section ... This removes the Directory and Profile sections, instead opting to document them as Queries. The behaviour of profile queries is based on Synapse's behaviour. A few issues have been opened to improve the behaviour: * https://github.com/matrix-org/matrix-doc/issues/1434 * https://github.com/matrix-org/matrix-doc/issues/1435 * https://github.com/matrix-org/matrix-doc/issues/1436 * https://github.com/matrix-org/matrix-doc/issues/1437 This fixes https://github.com/matrix-org/matrix-doc/issues/1404	6 years ago
Travis Ralston	b0744aa1e9	Merge pull request #1413 from turt2live/travis/s2s/join-swagger ... Convert joins/invites to swagger	6 years ago
Travis Ralston	af0629a520	Full stop	6 years ago
Travis Ralston	9f399a08fe	Full stops ... I'm never going to remember these	6 years ago
Travis Ralston	0d1b82a601	Add the event_id to unsigned PDUs ... This went missing in the swagger conversion. The example already has an event_id.	6 years ago
Travis Ralston	eaf175056f	Full stops	6 years ago
Travis Ralston	797aca87bd	Update the check_examples.py script to resolve references ... The script previously wasn't chasing down valid references in examples.	6 years ago
Travis Ralston	7314405904	Update comment	6 years ago
Travis Ralston	45ec8269e6	Fill out the required fields in all the examples	6 years ago
Travis Ralston	9c1c541a38	Remove extra "required" declarations ... "required" is something that is handled as an array, and these are invalid. The `type` in both cases is covered by a required array elsewhere	6 years ago
Travis Ralston	004998b98f	Convert invites to swagger ... The whole section reads like a description for the endpoint, and has been replaced by the swagger definition now (rather than at a later stage). All the same information should be kept.	6 years ago
Travis Ralston	f09c4fd286	Convert joins to swagger	6 years ago
Travis Ralston	cb4fcd1d09	Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger	6 years ago
Travis Ralston	88beaf4ad8	Completely remove /pull ... It's not been in use for years - we can safely let it disappear	6 years ago
Travis Ralston	21c4af70a9	Fix schema definitions (spelling, attributes)	6 years ago
Travis Ralston	2aafde4549	Merge pull request #1419 from turt2live/travis/s2s/3pinvites-swagger ... Convert third party invite exchange to swagger	6 years ago
Travis Ralston	89384c96c1	Full stops, language.	6 years ago
Travis Ralston	e226b60c7f	Merge remote-tracking branch 'matrix-org/master' into travis/s2s/transactions-swagger	6 years ago
Travis Ralston	bafdcf3640	Full stops, spelling, and operation IDs.	6 years ago
Travis Ralston	7cb918407d	Merge remote-tracking branch 'matrix-org/master' into travis/s2s/keys-swagger	6 years ago
Travis Ralston	05fb94e195	Merge remote-tracking branch 'matrix-org/master' into travis/better-errors	6 years ago
Travis Ralston	272f3d8432	Fix documentation link	6 years ago
Travis Ralston	cf93c88337	Convert third party invite exchange to swagger	6 years ago
Travis Ralston	d2b0b1bbda	Merge pull request #1379 from turt2live/travis/preset-guests ... Document guest_access in /createRoom presets; Make presets a table	6 years ago
Travis Ralston	e5da1e1741	Improve upon the transaction schema and examples ... Reduces data duplication and makes the objects more reusable for other areas of the spec	6 years ago
Travis Ralston	51faf8ed2e	Convert the general query API to swagger ... Includes "moving" the directory query API into the same area. This will make more sense once the other query types are specified.	6 years ago
Travis Ralston	1829589d23	Convert 3pn errors to new definition	6 years ago
Travis Ralston	197c36c520	Merge remote-tracking branch 'matrix-org/master' into travis/better-errors	6 years ago
Travis Ralston	91c59e7384	Merge pull request #1353 from matrix-org/anoa/as_thirdparty_lookup ... Thirdparty Entity Lookup API	6 years ago
Andrew Morgan	291a4dfc76	Third party lookup module. Fix wording	6 years ago
Travis Ralston	6e3993effe	Merge remote-tracking branch 'matrix-org/master' into travis/preset-guests	6 years ago
Travis Ralston	84e07a0c10	Convert errors in presence.yaml	6 years ago
Travis Ralston	16125f16f5	Spec retry_after_ms on ratelimit errors	6 years ago
Travis Ralston	8b513b9f8e	Merge remote-tracking branch 'matrix-org/master' into travis/better-errors	6 years ago
Andrew Morgan	8999887245	Path -> query params	6 years ago
Andrew Morgan	9bde78ac28	$ref needs to be under a schema:	6 years ago
Andrew Morgan	114bcf1a2e	Use $ref, clean up, fix errors, AS is now a C-S module.	6 years ago
Travis Ralston	374ec00046	Convert things that mention "Transaction" to swagger ... There's two kinds of transactions currently: one with EDUs and one without. The one with EDUs is only used on /send, however the schema is still somewhat worth splitting out for simplicity. The examples are brought apart to make them slightly more reusable for when they get dumped into the relevant sections of the spec (see TODO in server_server_api.rst) Further, the Transactions stuff introduces tuples to the spec. The units.py has been updated to support this.	6 years ago
Travis Ralston	3e13ec2841	Fix required properties in POST /query	6 years ago
Travis Ralston	96889f16e9	Split out and fix the /server and /query key APIs	6 years ago
Travis Ralston	bd2c0b7c98	Convert server keys to swagger	6 years ago
Travis Ralston	fbee83d5cf	Clarify some of the properties on the search result ... Fixes https://github.com/matrix-org/matrix-doc/issues/773	6 years ago
Travis Ralston	d7a979da63	Merge remote-tracking branch 'matrix-org/master' into travis/all-the-auth	6 years ago
Travis Ralston	516000bdc3	Fix error reference in media repo	6 years ago
Travis Ralston	ab75fc4b20	Merge remote-tracking branch 'matrix-org/master' into travis/better-errors	6 years ago
Travis Ralston	e7a6ff1064	Merge branch 'master' into travis/spec-reason	6 years ago
Travis Ralston	1722734a51	Merge pull request #1364 from turt2live/travis/server-name-join ... Document the server_name query parameter on /join/{roomIdOrAlias}	6 years ago
Will Hunt	ff3c379339	Merge pull request #1189 from Half-Shot/hs/upload-limits ... GET media/config 🎉	6 years ago
Will Hunt	77f4ac54aa	Wordy intro sentence for description	6 years ago
Will Hunt	2e6cc8045c	Better indent of description	6 years ago
Will Hunt	d5ce87e956	Split summary up into description and summary	6 years ago
Travis Ralston	bbf63d116c	Fix reference to error.yaml in forget room API	6 years ago
Travis Ralston	55c27d6212	Merge branch 'master' into travis/better-errors	6 years ago
Travis Ralston	4485b2f025	Merge branch 'master' into travis/server-name-join	6 years ago
Travis Ralston	c1c1f28c79	Merge branch 'master' into travis/dont-forget-to-leave	6 years ago
Travis Ralston	3935861445	Merge pull request #1380 from turt2live/travis/define-roomevent ... Define RoomEvent on /rooms/{roomId}/messages	6 years ago
Andrew Morgan	e81e0328c2	Fix single protocol metadata endpoint path, remove 500s	6 years ago
Travis Ralston	16860ddd22	De-quote	6 years ago
Andrew Morgan	4c38012122	I can spell	6 years ago
Andrew Morgan	e6218b56ab	Switch properties to schema	6 years ago
Andrew Morgan	a6dad76c01	Fix indentation	6 years ago
Andrew Morgan	cc3724b54a	fix indentation, error messages. add rest of PR	6 years ago
Kitsune Ral	dfdc5f9bef	search.yaml: Rename some titles to avoid confusion between request and response schemas ... Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>	6 years ago
Travis Ralston	436b410698	Document the error code when someone tries to forget a room they are in	6 years ago
Travis Ralston	9b1f3a1f47	Document guest_access in /createRoom presets; Make presets a table ... Previously the presets ended up being rendered as one long string (the indentation was not respected). This was hard to read and wasn't very clear. Now that there's a larger amount of information, it makes some sense to put it into a table. Tables don't work nicely when nested in another table, so the preset definitions have been moved into the general route description. This commit also updates the documentation to reference `preset`, not `presets` given the param is singular. Fixes https://github.com/matrix-org/matrix-doc/issues/881	6 years ago
Travis Ralston	9e796192e4	Document that clients must leave before forgetting rooms ... Fixes https://github.com/matrix-org/matrix-doc/issues/1011	6 years ago
Travis Ralston	05c85fd840	Spec the 403 on GET /presence/{userId}/status	6 years ago
Kitsune Ral	981d1004bc	Add a missing $ref	6 years ago
Travis Ralston	442ad99727	Merge pull request #1273 from QMatrixClient/content-repo-use-default ... Add 'default' to formally enforce the description	6 years ago
Travis Ralston	caa6d4d9ad	Give all errors a schema reference ... This just helps keep an overall structure	6 years ago
Travis Ralston	7cd22f5690	Describe the rate limit error everywhere ... Fixes https://github.com/matrix-org/matrix-doc/issues/1153	6 years ago
Travis Ralston	1f12637d3f	Getting presence requires authentication	6 years ago
Travis Ralston	a6b0125da6	Our swagger doesn't support explode yet	6 years ago
Travis Ralston	d279fdafa6	Document the server_name query parameter on /join/{roomIdOrAlias} ... Fixes https://github.com/matrix-org/matrix-doc/issues/904	6 years ago
Travis Ralston	7d94aaace8	Explicitly declare that the kick/ban reason will be on the membership event ... Fixes https://github.com/matrix-org/matrix-doc/issues/798	6 years ago
Travis Ralston	2409c84968	Document the GET version of /login ... Fixes https://github.com/matrix-org/matrix-doc/issues/677	6 years ago
Andrew Morgan	d73b247688	3PE lookup service	6 years ago
Will Hunt	a1309d636c	Remove "Clients should handle gracefully" sentence	6 years ago
Will Hunt	41c18bed0f	+repository	6 years ago
Will Hunt	21e957edfb	Better note for /config	6 years ago
Will Hunt	1820df02d9	media => content repository	6 years ago
Will Hunt	091b2a6771	Hard limit on requiring accessToken. Rephrased some sections	6 years ago
Will Hunt	eeaf4385d7	Speling is my weakniss	6 years ago
Will Hunt	80935eadcf	Update content-repo.yaml	6 years ago
Will Hunt	ddc152347b	Extending words and rate limiting	6 years ago
Terrill Tsang	f032d6d1c3	Update keys.yaml ... Fixed an end to end document bug , a format misleading in an claim response	6 years ago
Will Hunt	1140c0c05b	Document StateEvent for /createRoom (#1329)	6 years ago
Will Hunt	6d0a56d190	Suggestions by Travis tend to be sensible ones	6 years ago
Will Hunt	6b9640bcb4	upload_size => m.upload.size	6 years ago
Will Hunt	077cd04a6d	/limits => /config	6 years ago
user	5ab5fe08d1	Small grammatical and stylistic fixes	6 years ago
Michael Telatynski	df5455de1f	re-arrange fields in example /search request to make them a valid request.	6 years ago
Michael Telatynski	64f97c5b78	add example of highlights field in /search response	6 years ago
Michael Telatynski	4ff5887c91	spec the highlights field in /search response	6 years ago
Kitsune Ral	42fba1a87e	Add 'default' to formally enforce the description ... A quick follow up on #1265. Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>	6 years ago
Travis Ralston	3dc54b20c6	Merge branch 'master' into travis/clarify-routing-loops	6 years ago
Travis Ralston	8610effad7	Merge branch 'master' into travis/reporting	6 years ago
Travis Ralston	7cc15f3315	Document the allow_remote query param on the media repo ... Fixes https://github.com/matrix-org/matrix-doc/issues/837 Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Travis Ralston	9037f506ac	Document how to report content ... Fixes: https://github.com/matrix-org/matrix-doc/issues/739 Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Travis Ralston	4278cd56a4	Document /logout/all ... Fixes https://github.com/matrix-org/matrix-doc/issues/700 Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Florian Jacob	cc54a4f8cb	/rooms/{roomId}/members: specify access_token requirement ... as the behaviour of which members the users see is user-specific and therefore requires authentication. Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>	6 years ago
Richard van der Hoff	bb39bea44d	Merge pull request #1169 from mujx/event-id-format ... Use the correct event_id format on examples	6 years ago
Valentin Deniaud	55b512c968	add delete_devices endpoint ... fix #1041	6 years ago
Valentin Deniaud	34140a785d	fix typo in delete device	6 years ago
Will Hunt	ffc8ee298a	a upload > an upload	6 years ago
Will Hunt	de6fe1b76e	Add note about auth	6 years ago
Will Hunt	c9abf36097	size > upload_size	6 years ago
Will Hunt	2783820f98	Initial draft of GET media/limits	6 years ago
Jason Volk	048de9803e	Fix typo.	6 years ago
Konstantinos Sideris	7448ef0db0	Use the correct event_id format on examples ... Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>	6 years ago
Andrew Morgan	cd26c170de	Specify token used in /login is not an Access Token (#1155) ... * Specify token used in /login is not an Access Token While working through the implementation of /login in Dendrite, it was confusing what the contents of the token attribute in the login request body referred to. Initially, I thought it was an access token, which led to further confusion. This commit explicitly states that the token is a login token, which is separate from an access token, hopefully reducing confusion for future readers. Signed-off-by: Andrew Morgan (https://amorgan.xyz) <andrew@amorgan.xyz>	6 years ago
Richard van der Hoff	2644e5657d	Merge pull request #1152 from turt2live/travis/clarify-whoami ... Improve documentation around /account/whoami	6 years ago
Travis Ralston	159ab7313f	Fix typos in whoami.yaml ... Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Travis Ralston	b7f8f20de9	Reword the appservice portion of /account/whoami ... Credit goes to richvdh - suggestions taken with edits. Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Travis Ralston	6ba5d7ca92	Reword appservice requirements for /account/whoami ... Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Richard van der Hoff	a549baa01d	registration.yaml: fix typo ... it's -> its	6 years ago
Travis Ralston	2e4e5e25e8	Improve documentation around /account/whoami ... Clarifies: https://github.com/matrix-org/matrix-doc/issues/1135 Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Travis Ralston	15cdde3f49	Add GET /register/available ... Adds https://github.com/matrix-org/matrix-doc/issues/911 Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Travis Ralston	d88a1308c2	Formatting and remove DELETE /directory/list ... Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Travis Ralston	5cbfa73fe4	Improve documentation of /directory/list ... * 404 for room not found instead of 400 * GET doesn't require an access token * PUT (and therefore DELETE) can have it's own access control checks * DELETE is implemented because of synapse Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Travis Ralston	e4f7ba70f5	Merge branch 'master' into travis/spec-directory-list	6 years ago
Travis Ralston	595667d15d	Spec /directory/list ... Adds https://github.com/matrix-org/matrix-doc/issues/417 Signed-off-by: Travis Ralston <travpc@gmail.com>	6 years ago
Maxime Dor	c8393306d1	Add IS ping endpoint	6 years ago
Jason Volk	de6d2c96fe	Minor grammar fix.	6 years ago
Richard van der Hoff	f7bbcd1678	Merge pull request #1110 from t3chguy/rooms/event ... Document new rooms/$/event/$ API for fetching a single event (no ctx)	6 years ago
Michael Telatynski	04eb6c7b65	link to both context and event in depr notice as per review	6 years ago
Michael Telatynski	c5816a80af	move /rooms/{roomId}/event/{eventId} and update depr notice	6 years ago
Michael Telatynski	06911d4fab	Merge branch 'master' of https://github.com/matrix-org/matrix-doc into t3chguy/search_defaults	7 years ago
Michael Telatynski	a9c3d94f24	Merge branch 'master' of https://github.com/matrix-org/matrix-doc into rooms/event	7 years ago