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
Richard van der Hoff
c175039a08
Final public_rooms clarifications
...
* order by *joined* members
* clarify pagination direction behaviour
2016-11-21 13:08:41 +00:00
Erik Johnston
d66792d5ca
Mention order of returned results
2016-10-14 10:31:06 +01:00
Erik Johnston
cafa9a01fd
Move explanation of lack of direction param
2016-10-11 14:29:20 +01:00
Erik Johnston
71c1fc5ec0
Remove spurious 400 result
2016-10-11 14:28:32 +01:00
Erik Johnston
de68c167b6
Add tags for GET endpoint
2016-10-11 14:27:53 +01:00
Erik Johnston
9d0960b206
Better wording
2016-10-11 14:24:46 +01:00
Erik Johnston
a5bb182c67
Explicitly mention that directio of pagination is specified by the token
2016-09-30 14:30:13 +01:00
Erik Johnston
a66a744c45
Fix typo. Change responses in both places
2016-09-30 14:28:40 +01:00
Erik Johnston
06649b652d
Mark booleans as required. Remove mention that things may be null
2016-09-30 14:18:13 +01:00
Erik Johnston
e8b21f357f
Explicitlty mention total_room_count_estimate
2016-09-29 17:18:34 +01:00
Erik Johnston
e854757c98
Mark required fields as required
2016-09-29 17:12:52 +01:00
Erik Johnston
0dc94d5c14
Expand on description of pagination tokens
2016-09-29 16:58:00 +01:00
Erik Johnston
c05ee18f58
Add title and update description
2016-09-29 11:06:57 +01:00
Erik Johnston
130ea85576
Spec POST /publicRooms
2016-09-29 11:01:36 +01:00
Erik Johnston
877a6cfeb4
Spec new query params for /publicRooms
2016-09-29 10:47:37 +01:00
Erik Johnston
d81d0dbd1d
Spec canonical alias key
2016-09-29 10:35:04 +01:00
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).
2016-07-12 17:28:30 +01:00
Daniel Wagner-Hall
48aab7bad9
Return room avatar URLs in /publicRooms
2016-01-06 18:00:21 +00:00
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.
2015-12-07 12:45:13 +00:00
Daniel Wagner-Hall
873b0dcecf
Replace version numbers with release numbers
2015-12-04 11:09:35 +00:00
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.
2015-11-30 11:22:57 +00:00