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.	6 years ago
Travis Ralston	c25afa663e	Use consistent event examples throughout the Client-Server API Fixes https://github.com/matrix-org/matrix-doc/issues/1968	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
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
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	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

18 Commits (3ee9a7d654050219f09487ce7b6bd9584827a6c2)