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
a84a34ee6c
GETting a filter requires auth ( #1003 )
2017-09-26 14:11:43 +01:00
Richard van der Hoff
1e3f5683c8
Make clear that the /sync timeout is zero by default
2017-08-31 16:56:50 +01:00
Brendan Abolivier
fee65dbacb
Fix response format and 404 example for room alias lookup
2017-07-27 17:43:49 +01:00
Brendan Abolivier
750d980bc0
Room member ( #950 )
...
* Fixed an incorrect membership on example
* Added precision on membership upon profile update
* Changed first example into a join
* Changed the state/{eventType}/{stateKey} example with an actual state key
2017-07-14 15:30:56 +01:00
Richard van der Hoff
da6938b818
Key management APIs ( #894 )
...
Spec the e2e key-management APIs.
2017-04-20 16:51:42 +01:00
Richard van der Hoff
7adf95b4ad
Merge pull request #740 from matrix-org/rav/fix_736
...
Set default account 'kind' to 'user'
2016-11-22 09:52:19 +00:00
Richard van der Hoff
c83a556097
Set default account 'kind' to 'user'
...
Fixes https://github.com/matrix-org/matrix-doc/issues/736
2016-11-21 17:54:47 +00: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
Richard van der Hoff
dca1d0c745
Merge branch 'master' into erikj/public_rooms
2016-11-21 12:22:08 +00:00
Richard van der Hoff
2bf0abcb9d
Add missing tag to PUT /devices/{deviceId}
2016-11-09 14:37:34 +00:00
Richard van der Hoff
b26c84a290
Fix schema validation fail
2016-11-09 14:33:45 +00:00
Richard van der Hoff
07dbf6fcf6
Add doc for PUT /devices/{deviceId}
...
Oops, forgot this.
2016-11-09 14:25:31 +00:00
Erik Johnston
d66792d5ca
Mention order of returned results
2016-10-14 10:31:06 +01:00
Richard van der Hoff
af515012ea
Device management API
2016-10-12 17:26:01 +01:00
Richard van der Hoff
9265b03008
Client device doc
...
Document client devices, and the mods to the login and register apis to support
them.
2016-10-12 17:26:01 +01:00
Erik Johnston
a69d6c63c6
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/public_rooms
2016-10-11 14:31:47 +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
Richard van der Hoff
42616f839c
Merge pull request #396 from matrix-org/dbkr/notifs_api
...
Spec notifs API
2016-10-06 17:21:47 +01:00
Richard van der Hoff
909aef2b18
Merge pull request #389 from matrix-org/erikj/create_room_is_direct
...
Spec /createRoom is_direct flag, is_direct in member event and m.direct
2016-10-06 17:19:48 +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
b789251f70
More PR feedback
2016-10-05 12:59:49 +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
Richard van der Hoff
37fb1ceb65
Merge pull request #395 from matrix-org/rav/kill_refresh_tokens
...
Remove references to refresh tokens and tokenrefresh
2016-10-04 17:55:38 +01:00
David Baker
1d7531e9a1
Typo
2016-10-04 17:51:35 +01:00
David Baker
d39f662df5
PR feedback
2016-10-04 11:57:24 +01:00
Richard van der Hoff
556ced36a4
Merge remote-tracking branch 'origin/master' into rav/store_and_forward
2016-10-04 11:55:05 +01:00
David Baker
8fe8bd6a81
Add is_direct to member event spec.
2016-10-03 17:33:45 +01:00
Richard van der Hoff
f4c7fdfd03
Remove references to refresh tokens and tokenrefresh
...
refresh tokens are dead.
2016-10-03 17:05:56 +01:00
David Baker
5fedc64230
double space
2016-10-03 15:52:08 +01:00
David Baker
ae1c576648
Merge remote-tracking branch 'origin/master' into erikj/create_room_is_direct
2016-10-03 15:17:55 +01:00
Erik Johnston
069aa86a10
Update wording and add example to filter param
2016-09-30 15:06:11 +01:00
Erik Johnston
7919e8e159
Update wording.
2016-09-30 15:02:27 +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
