Commit Graph

32 Commits (0e64c4de72613f4d88cd142267b8796d18561338)

Author SHA1 Message Date
Kitsune Ral f299f60e17 Use public_rooms_response.yaml instead of replicating the same definition
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
5 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 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 017d6db737 Document third party network/protocol directories (for appservices)
Fixes https://github.com/matrix-org/matrix-doc/issues/869
6 years ago
Travis Ralston 2ac80d38d7 Document the /publicRooms endpoint for federation
This intentionally doesn't document the third party network aspect of the endpoint. This is scheduled for a later area for dealing with third party network/IDs and is reported as https://github.com/matrix-org/matrix-doc/issues/1476

The client-server response has been broken out to a shared file: both the client-server and server-server /publicRoom endpoints return the same thing, with slightly different inputs.

The inputs (and behaviour) are based upon the docstring here: 43ecfe0b10/synapse/federation/transport/server.py (L583-L612)
6 years ago
Travis Ralston caa6d4d9ad Give all errors a schema reference
This just helps keep an overall structure
6 years ago
Travis Ralston d88a1308c2 Formatting and remove DELETE /directory/list
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 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>
7 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>
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 c175039a08 Final public_rooms clarifications
* order by *joined* members
 * clarify pagination direction behaviour
8 years ago
Erik Johnston d66792d5ca Mention order of returned results 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
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 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 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 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
Daniel Wagner-Hall 48aab7bad9 Return room avatar URLs in /publicRooms 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 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