739 Commits (ba397793756fa462728e596c8a6aacaea2795c96)

Author	SHA1	Message	Date
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
Michael Telatynski	a5374c7df7	Document new rooms/$/event/$ API for fetching a single event (no ctx)	7 years ago
Michael Telatynski	dc27323d8b	Document the defaults for the /search API	7 years ago
Richard van der Hoff	59e4c625b3	Merge pull request #1093 from CromFr/guest_can_join ... Add createRoom guest_can_join parameter	7 years ago
David Baker	fa0eb2405f	all rooms, not any, and remove extra words	7 years ago
David Baker	ca09415e80	Fix /keys/changes response to reflect reality	7 years ago
David Baker	bb0bbedb87	indenting	7 years ago
David Baker	1674b0e3b5	Doc /keys/query 'token' param	7 years ago
Michael Telatynski	784adade9b	changes based on Pull Request feedback	7 years ago
Michael Telatynski	3d8fe6e090	merge profiles with user directory into user data, also fix typo	7 years ago
Michael Telatynski	605510e965	Merge branch 'master' into user_directory	7 years ago
Michael Telatynski	d219cbc978	apply points from review	7 years ago
Richard van der Hoff	00b28495a6	Explain how to split an mxid	7 years ago
Richard van der Hoff	d9a4ddbf65	Mark `home_server` field deprecated ... This is spelt wrong, and is redundant to user_id, so let's stop people using it.	7 years ago
Michael Telatynski	97445195f6	add user_directory	7 years ago
Gergely Polonkai	e9622bf9e4	Fix example in email based registration endpoint ... The spec says `send_attempt` should be a number, but the example shows it as a string. Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>	7 years ago
Crom (Thibaut CHARLES)	b270233549	Add createRoom guest_can_join parameter	7 years ago
Thibaut CHARLES	5e2a48f709	createRoom StateEvent.content should be an object	7 years ago
Maxime Dor	9d2e18cca1	Adapt paths as per feedback	7 years ago
Maxime Dor	d1e64daa10	Fix yaml title for directory api	7 years ago
Maxime Dor	28c09aed62	Properly mark required response keys to pass tests	7 years ago
Maxime Dor	8a6103798e	Fix for tests	7 years ago
Maxime Dor	bb50ec2e88	Document directory query endpoint	7 years ago
Richard van der Hoff	2128924933	Merge pull request #1072 from maxidor/max/ss/version ... Document federation version endpoint	7 years ago
Maxime Dor	1045bc721d	Document federation version endpoint	7 years ago
Kitsune Ral	828086a86c	Supply operationId for freshly added IS and AS operations	7 years ago
Kitsune Ral	a68b7e1bbd	Supply operationId with freshly added operations ... Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>	7 years ago
Kitsune Ral	b53083732b	Merge remote-tracking branch 'remotes/origin/master'	7 years ago
Kitsune Ral	868af0a7a1	Provide doc-comments with makeHandler(); cleanup	7 years ago
David Baker	5147a3b975	Fix broken links & grammar	7 years ago
David Baker	45af878e11	Merge remote-tracking branch 'origin/master' into dbkr/is_bulk_lookup	7 years ago
David Baker	d728e67751	Merge pull request #1068 from matrix-org/dbkr/threepid_add_msisdn ... Document threepids	7 years ago
Maxime Dor	836e6c81d1	Fix spelling	7 years ago
David Baker	e80675c9e9	Link in markdown, not swagger	7 years ago
David Baker	493b936209	Make these links more specific too	7 years ago
Maxime Dor	cdfff67878	Create spec for IS bulk lookup	7 years ago
Travis Ralston	0f5a4efce6	Spec URL previews (#1064) ... * Spec URL previews * Require authentication on /upload and /preview_url	7 years ago
David Baker	6edb90a08e	Document threepids ... Adds the /msisdn' 3pid type and generally fleshes out what a 3pid is and how they work. This merges most of the work from Max Dor in https://github.com/matrix-org/matrix-doc/pull/1039 with some tweaks and additions.	7 years ago
Kitsune Ral	33463e3907	Factor out parser.validate callback	7 years ago
Travis Ralston	2468c38482	Add required property to whoami ... Signed-off-by: Travis Ralston <travpc@gmail.com>	7 years ago
Travis Ralston	41db12713d	Update whoami endpoint ... Signed-off-by: Travis Ralston <travpc@gmail.com>	7 years ago
Travis Ralston	9cf2b59f4e	Make it less obvious where this was copy/pasted from ... Signed-off-by: Travis Ralston <travpc@gmail.com>	7 years ago
Travis Ralston	b1801ea6db	Spec /account/whoami ... Signed-off-by: Travis Ralston <travpc@gmail.com>	7 years ago
Kitsune Ral	77a9daccec	Validation that operationId is present ... Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>	7 years ago
Kitsune Ral	66268260c7	Merge remote-tracking branch 'remotes/origin/master'	7 years ago
Kitsune Ral	1d4410b638	operationid -> operationId ... Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>	7 years ago
Richard van der Hoff	88fb2e9abd	Merge pull request #1045 from maxidor/max/cs/unknow_filter_status ... Add status for unknown user's filter ID	7 years ago
Maxime Dor	099a7e90ae	Change return code following feedback	7 years ago
Maxime Dor	dcaaf84395	Be clear that event_id is not applicable everywhere	7 years ago
Maxime Dor	efa9b5a8f1	Add missing required key for sync format	7 years ago
Maxime Dor	0fea380625	Add status for unknown user's filter ID	7 years ago
Richard van der Hoff	56c3e5a627	README.rst: Add notes on how to build the spec	7 years ago
Richard van der Hoff	628e723483	Move the MXID spec to the appendices ... Also link to them from the /register API doc.	7 years ago
Richard van der Hoff	b4e24d443a	Clarify what happens when there is no power_levels event	7 years ago
Richard van der Hoff	a8afbfd27d	Avoid external link in search swagger	7 years ago
Kitsune Ral	004a4d5148	Added/updated operationIds according to today's updates in the spec ... Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>	7 years ago
Kitsune Ral	24afe7987c	Add operationId to all endpoints of all APIs ... To facilitate generation of API stubs from the spec. Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>	7 years ago
Michael Telatynski	bf3b49f13c	document joined_members and joined_rooms endpoints (#999)	7 years ago
Richard van der Hoff	820704a16a	Format examples as raw objects ... According the the openapi spec, examples for responses and schemas should be raw objects rather than being json strings. (It's unclear what non-json examples should look like...). The swagger UI used to support json strings, but no longer does. In short, let's turn the json strings into their raw formats.	7 years ago
Richard van der Hoff	a84a34ee6c	GETting a filter requires auth (#1003)	7 years ago
Richard van der Hoff	1e3f5683c8	Make clear that the /sync timeout is zero by default	7 years ago
Brendan Abolivier	fee65dbacb	Fix response format and 404 example for room alias lookup	7 years ago
Brendan Abolivier	750d980bc0	Room member (#950) ... * Fixed an incorrect membership on example * Added precision on membership upon profile update * Changed first example into a join * Changed the state/{eventType}/{stateKey} example with an actual state key	7 years ago
Richard van der Hoff	da6938b818	Key management APIs (#894) ... Spec the e2e key-management APIs.	7 years ago
Richard van der Hoff	7adf95b4ad	Merge pull request #740 from matrix-org/rav/fix_736 ... Set default account 'kind' to 'user'	8 years ago
Richard van der Hoff	c83a556097	Set default account 'kind' to 'user' ... Fixes https://github.com/matrix-org/matrix-doc/issues/736	8 years ago
Richard van der Hoff	c175039a08	Final public_rooms clarifications ... * order by *joined* members * clarify pagination direction behaviour	8 years ago
Richard van der Hoff	dca1d0c745	Merge branch 'master' into erikj/public_rooms	8 years ago
Richard van der Hoff	2bf0abcb9d	Add missing tag to PUT /devices/{deviceId}	8 years ago
Richard van der Hoff	b26c84a290	Fix schema validation fail	8 years ago
Richard van der Hoff	07dbf6fcf6	Add doc for PUT /devices/{deviceId} ... Oops, forgot this.	8 years ago
Erik Johnston	d66792d5ca	Mention order of returned results	8 years ago
Richard van der Hoff	af515012ea	Device management API	8 years ago
Richard van der Hoff	9265b03008	Client device doc ... Document client devices, and the mods to the login and register apis to support them.	8 years ago
Erik Johnston	a69d6c63c6	Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/public_rooms	8 years ago
Erik Johnston	cafa9a01fd	Move explanation of lack of direction param	8 years ago
Erik Johnston	71c1fc5ec0	Remove spurious 400 result	8 years ago
Erik Johnston	de68c167b6	Add tags for GET endpoint	8 years ago
Erik Johnston	9d0960b206	Better wording	8 years ago
David Baker	49ee00c361	Use the right path for the identity API	8 years ago
Richard van der Hoff	42616f839c	Merge pull request #396 from matrix-org/dbkr/notifs_api ... Spec notifs API	8 years ago
Richard van der Hoff	909aef2b18	Merge pull request #389 from matrix-org/erikj/create_room_is_direct ... Spec /createRoom is_direct flag, is_direct in member event and m.direct	8 years ago
David Baker	e0a434b248	Aaha, found a syntax that swagger will accept!	8 years ago
David Baker	bd753d4bf4	Re-add required flags the correct way	8 years ago
David Baker	af2c74c186	Revert `required`s ... They're not boolean flags for object fields	8 years ago
David Baker	14944fe237	More PR feedback	8 years ago
David Baker	fd8c1a43c7	ms, not s. Also add required flags	8 years ago
David Baker	b789251f70	More PR feedback	8 years ago
David Baker	4a020025bc	Make swagger happpy ... These aren't strings, but 'any' causes swagger to break and leaving it out makes the doc fail to build.	8 years ago
David Baker	b4c89accb2	Params in query, not path	8 years ago
David Baker	a463820d83	Typo	8 years ago
David Baker	c1fa342b90	Swagger is failing on type 'any'	8 years ago
David Baker	136d5dc9ad	Almost valid...	8 years ago
David Baker	595b75f299	Try & make example closer to valid	8 years ago
David Baker	41781e95b2	Attempt valid json	8 years ago
David Baker	c16ba9488f	Spec notifs API	8 years ago
Richard van der Hoff	37fb1ceb65	Merge pull request #395 from matrix-org/rav/kill_refresh_tokens ... Remove references to refresh tokens and tokenrefresh	8 years ago
David Baker	1d7531e9a1	Typo	8 years ago
David Baker	d39f662df5	PR feedback	8 years ago
Richard van der Hoff	556ced36a4	Merge remote-tracking branch 'origin/master' into rav/store_and_forward	8 years ago
David Baker	8fe8bd6a81	Add is_direct to member event spec.	8 years ago
Richard van der Hoff	f4c7fdfd03	Remove references to refresh tokens and tokenrefresh ... refresh tokens are dead.	8 years ago
David Baker	5fedc64230	double space	8 years ago
David Baker	ae1c576648	Merge remote-tracking branch 'origin/master' into erikj/create_room_is_direct	8 years ago
Erik Johnston	069aa86a10	Update wording and add example to filter param	8 years ago
Erik Johnston	7919e8e159	Update wording.	8 years ago
Erik Johnston	a5bb182c67	Explicitly mention that directio of pagination is specified by the token	8 years ago
Erik Johnston	a66a744c45	Fix typo. Change responses in both places	8 years ago
Erik Johnston	06649b652d	Mark booleans as required. Remove mention that things may be null	8 years ago
Erik Johnston	b121feebce	Comment what the is_direct flag actually does	8 years ago
Erik Johnston	e8b21f357f	Explicitlty mention total_room_count_estimate	8 years ago
Erik Johnston	e854757c98	Mark required fields as required	8 years ago
Erik Johnston	0dc94d5c14	Expand on description of pagination tokens	8 years ago
Erik Johnston	37f6769a3c	Spec filter param on /messagse	8 years ago
Erik Johnston	085131b617	Add contains_url filter option	8 years ago
Richard van der Hoff	ebaaa7e3b3	Review feedback ... * store-and-forward -> send-to-device * describe motivation * device ids are 10 capital chars * etc	8 years ago
Erik Johnston	3a5cbd14c3	Add /createRoom is_direct flag	8 years ago
Erik Johnston	c05ee18f58	Add title and update description	8 years ago
Erik Johnston	130ea85576	Spec POST /publicRooms	8 years ago
Erik Johnston	877a6cfeb4	Spec new query params for /publicRooms	8 years ago
Erik Johnston	d81d0dbd1d	Spec canonical alias key	8 years ago
Richard van der Hoff	ccd7bb32d5	Specification for direct-to-device messages	8 years ago
Benjamin Saunders	cade909e25	Fix inconsistencies regarding redacted_because ... Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>	8 years ago
Richard van der Hoff	7478e7f3cf	Add top-level account_data to /sync response	8 years ago
Benjamin Saunders	77b668a5dc	Fix some obsolete uses of user_id key in events ... Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>	8 years ago
Matthew Hodgson	978d9ea6dd	fix the descriptions of the /room/.../state APIs to not be the wrong way round	8 years ago
Richard van der Hoff	c51c4acf7f	Clarifications to authentication mechanisms ... * Make the purpose of the `auth` key in /register requests explicit, and say that it should be empty at first. * Restructure the UA-auth section a bit. * In the UA-auth section, say that clients should submit no `auth` to start with, and add 'Stage 0' representing this to the example. * s/{stage,login} type/authentication type/ in the UA-auth section. Seems clearer to me. * Try to distinguish the example responses from the example requests by giving an HTTP header.	8 years ago
Richard van der Hoff	4b0e546eeb	PR feedback ... Fix some typos, and clarify several aspects of server behaviour.	8 years ago
Richard van der Hoff	41368dc5a7	document CAS login ... Following the spirit of "document how it is, not how we wish it was", document the CAS login bits.	8 years ago
Mark Haines	d2fe2f1ff6	Fix jenkins	8 years ago
Mark Haines	618f94699b	Document the optional parameter for specifying a filename to download an attachment as	8 years ago
Richard van der Hoff	8328e485ea	Clean up the pushrules API doc ... * make it clearer which fields go in which parts of the rule * the example given appeared to be for a content rule, so use a content rule consistently through the examples.	8 years ago
Richard van der Hoff	7ac2f51e4a	/upload: fix example for filename ... The example shouldn't be encoded, else it will be double-encoded by swagger.	8 years ago
Benjamin Saunders	3e2dea4c52	Document filename query parameter for uploads ... Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>	8 years ago
Richard van der Hoff	ec20f15407	/tokenrefresh should expire the access token ... It's possible for clients to call /tokenrefresh before the access_token has expired, potentially leading to a proliferation of valid access_tokens.	8 years ago
Richard van der Hoff	2370a4c970	Spell out the state algorithm for createRoom ... Fixes https://matrix.org/jira/browse/SPEC-429. Synapse currently follows the specified ordering, but does *not* give the specified error when the state is invalid (instead it creates the room anyway but gives a 403 M_FORBIDDEN). Still, I don't think that should be a real problem for any real clients, and nothing would break if we changed this in synapse, so it might as well go in the spec anyway.	8 years ago