Commit graph

19 commits

Author SHA1 Message Date
Kitsune Ral 77783b8fc3 Remove extraneous quotes, fix a typo
filter.yaml: quotes under |- were taken literally.
notifications.yaml: it's a number in the example, not a string
2020-05-08 07:48:28 +02:00
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.
2019-05-29 15:28:48 -06:00
Travis Ralston c25afa663e Use consistent event examples throughout the Client-Server API
Fixes https://github.com/matrix-org/matrix-doc/issues/1968
2019-05-29 14:57:56 -06:00
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
2018-08-26 21:32:44 -06:00
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>
2017-10-11 01:58:31 +09:00
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.
2017-09-27 08:04:24 +01:00
David Baker e0a434b248 Aaha, found a syntax that swagger will accept! 2016-10-06 11:20:05 +01:00
David Baker bd753d4bf4 Re-add required flags the correct way 2016-10-05 18:53:08 +01:00
David Baker af2c74c186 Revert requireds
They're not boolean flags for object fields
2016-10-05 18:50:14 +01:00
David Baker 14944fe237 More PR feedback 2016-10-05 18:26:42 +01:00
David Baker fd8c1a43c7 ms, not s. Also add required flags 2016-10-05 18:22:03 +01:00
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.
2016-10-05 11:51:48 +01:00
David Baker b4c89accb2 Params in query, not path 2016-10-05 11:48:14 +01:00
David Baker a463820d83 Typo 2016-10-05 11:21:56 +01:00
David Baker c1fa342b90 Swagger is failing on type 'any' 2016-10-05 11:21:06 +01:00
David Baker 136d5dc9ad Almost valid... 2016-10-05 11:15:33 +01:00
David Baker 595b75f299 Try & make example closer to valid 2016-10-05 10:32:03 +01:00
David Baker 41781e95b2 Attempt valid json 2016-10-05 10:21:29 +01:00
David Baker c16ba9488f Spec notifs API 2016-10-05 10:15:49 +01:00