matrix-spec-proposals

Commit Graph

Author	SHA1	Message	Date
Travis Ralston	d6d74c4cbe	Switch to using $ instead of # for sub-types # is reserved by the swagger validator as a way to include partial content from a JSON object (eg: "#/path" would include {"test": true} from the object {"path":{"test":true}}). Instead of trying to convince the validator that it is wrong, we'll just use a different character. Note that our rendering tools do not care about #-style references to objects. It's still somewhat worth changing the character though.	5 years ago
Travis Ralston	c25afa663e	Use consistent event examples throughout the Client-Server API Fixes https://github.com/matrix-org/matrix-doc/issues/1968	5 years ago
Travis Ralston	e9579a7840	The `rank` in search results is actually a floating point number This was accidentally changed in https://github.com/matrix-org/matrix-doc/pull/1571 and appears to be the only instance.	6 years ago
Travis Ralston	6cdb463829	Merge pull request #1571 from turt2live/travis/general/number-to-int Replace applicable types of 'number' to 'integer'	6 years ago
Travis Ralston	5fa6b49365	Specify the type of filter the search API expects Note: This is badly named until https://github.com/matrix-org/matrix-doc/pull/1570 lands Fixes https://github.com/matrix-org/matrix-doc/issues/598	6 years ago
Travis Ralston	667fa082af	Replace applicable types of 'number' to 'integer' `number` implies/represents a float where `integer` does not. The only remaining `type: number` in the project appear on power levels: those have been left untouched pending clarification. Fixes https://github.com/matrix-org/matrix-doc/issues/746	6 years ago
Travis Ralston	197c36c520	Merge remote-tracking branch 'matrix-org/master' into travis/better-errors	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	55c27d6212	Merge branch 'master' into travis/better-errors	6 years ago
Travis Ralston	16860ddd22	De-quote	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	7cd22f5690	Describe the rate limit error everywhere Fixes https://github.com/matrix-org/matrix-doc/issues/1153	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
Michael Telatynski	dc27323d8b	Document the defaults for the /search API	6 years ago
Kitsune Ral	66268260c7	Merge remote-tracking branch 'remotes/origin/master'	7 years ago
Richard van der Hoff	a8afbfd27d	Avoid external link in search swagger	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
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	49cd65dd58	Add a license to the spec We're licensing hte spec under ASLv2. Add the LICENSE file, and add the short-form to as much of the source as is practical right now (adding it to json source is a massive pita).	8 years ago
Richard van der Hoff	432c78f3b5	Fix the swagger for /search so that it works without preprocessing Makes the /search swagger work when it is imported directly into the swagger-UI without preprocessing by dump_swagger	8 years ago
Richard van der Hoff	5383754a40	Access event-schemas via a symlink Swagger gets a bit confused about $refs via '../..', so use a symlink to make everything nicely relative.	8 years ago
Richard van der Hoff	23c4ffbc1b	Add securityDefintions to generated swagger JSON Also factor out to a common file	8 years ago
Richard van der Hoff	b7c255a887	Tweaks/clarifications to search spec Fixes https://matrix.org/jira/browse/SPEC-305	9 years ago
Erik Johnston	88b350ca8b	Better wording	9 years ago
Erik Johnston	a2082e4b38	Note that count is approximate	9 years ago
Erik Johnston	95255bcdf5	Use rst not html	9 years ago
Erik Johnston	e1fda6b6b6	Remove double the	9 years ago
Erik Johnston	9c98c80bde	Fix up filter description	9 years ago
Erik Johnston	4967b092aa	Add description of state response key	9 years ago
Erik Johnston	856dd9100e	Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian	9 years ago
Erik Johnston	118a6aa040	Reword groupings descriptions	9 years ago
Erik Johnston	1ef9cc37e3	Typo	9 years ago
Erik Johnston	fca8e5abe7	Add top level next_batch key to example	9 years ago
Daniel Wagner-Hall	f81b967e2d	Make all the schema files yaml	9 years ago
Daniel Wagner-Hall	1f5b6271f2	Generate swagger-ui output for client-server API Depends on: https://github.com/matrix-org/matrix-doc/pull/212 https://github.com/matrix-org/matrix-doc/pull/208 https://github.com/matrix-org/matrix-doc/pull/207 for the actual rendered output to not throw javascript errors at runtime.	9 years ago
Daniel Wagner-Hall	873b0dcecf	Replace version numbers with release numbers	9 years ago
Daniel Wagner-Hall	aa4ed10821	Unify v1 and v2 event schemas	9 years ago
Erik Johnston	ca7ef1b536	Update Results description	9 years ago
Erik Johnston	5e8bb34f36	Change the results dict to a list	9 years ago
Erik Johnston	46fd0b252c	Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian	9 years ago
Daniel Wagner-Hall	6c66bfc755	Flatten out v1 and v2_alpha directories As a side effect, I got rid of all of the horrible symlinks and just put in all of the proper relative paths. Because the horrible symlinks were horrible.	9 years ago

43 Commits (40e6f82cbdf736841ab45d4e7e7fd9da1159c76e)