1881a255c2
Clarify that id_access_token is optional for r0.5
2019-09-05 13:53:58 -06:00
0408373cf9
Litter the client-server API with id_access_token
2019-08-28 15:47:08 -06:00
baf8948eb5
Describe M_UNSUPPORTED_ROOM_VERSION on invite and createRoom endpoints
...
Spec for MSC1866: https://github.com/matrix-org/matrix-doc/pull/1866
2019-02-24 21:55:04 -07:00
7d34995ece
It's actually an "identity server implementing the Identity Service API"
...
Also add a note about appservices being special.
2018-08-31 15:35:32 -06:00
7ac76fa27c
Actually we're going with "identity server" afterall
2018-08-31 15:04:00 -06:00
cc0badaaa1
Fix all naming cases of "identity service"
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1396
Includes some "homeserver" fixes too. This commit does not include historical documentation or notes.
2018-08-31 15:04:00 -06:00
3869f68a5c
Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions
2018-08-21 12:22:35 -06:00
8dc6f092ef
Define the type of the power_level_content_override field
2018-08-20 12:27:29 -06:00
7e6ca5fef8
Take out the room_alias response field
...
The argument is that this isn't really needed at this time.
2018-08-20 12:23:17 -06:00
1fd7c99461
Clarify that the creation event can have other keys in it
2018-08-20 12:21:55 -06:00
6c7a93d2f5
Move description about which preset to use when none is specified
2018-08-20 12:21:43 -06:00
7d14309b63
Move the power level event schema to where it was
2018-08-20 12:21:19 -06:00
45c68e323a
Add general clarity to the /createRoom endpoint
...
This commit does a number of things:
* Minor formatting/alignment changes
* Document the room_alias response key. This could be deprecated now, or forfeited, if needed.
* Remove the guest_can_join parameter - it is not actually supported
* Document the previously undocumented power_level_content_override parameter
* Clarify that the room_id is required on the response
* More clearly spell out which events are created as part of the request
* Clarify how the room alias becomes the canonical alias
* Clarify how the `visibility` may be used to determine a default preset to apply
* Document the `m.federate` creation content parameter, adding an option for the homeserver to define a default value
References:
* Preset being inferred by the visibility: cd32c19a60/synapse/handlers/room.py (L172-L177)https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L198
* https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L335-L359
* Aliases becoming canonical: https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L366-L370
* `m.federate` landing in the create event: https://github.com/matrix-org/synapse/blob/master/synapse/handlers/room.py#L311-L315
Fixes https://github.com/matrix-org/matrix-doc/issues/1243
Fixes https://github.com/matrix-org/matrix-doc/issues/1471
Inspired by https://github.com/matrix-org/matrix-doc/issues/1213
2018-08-15 17:25:30 -06:00
fde48e7ee8
Specify how room versioning works
...
This is the spec PR for https://github.com/matrix-org/matrix-doc/issues/1425
Room version upgrades are not part of MSC1425.
Documented aspects:
* room_version on the create event
* creating a room with a specific version (useful for testing)
* make_join behaviour
* error code documentation
* grammar of room versions
Based upon https://docs.google.com/document/d/1urKgReoHqxX8R_XtySB17dPi-DZcKhqTEL2_s895Wz0/edit
2018-08-15 15:12:36 -06:00
05fb94e195
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
2018-07-18 08:28:16 -06:00
9b1f3a1f47
Document guest_access in /createRoom presets; Make presets a table
...
Previously the presets ended up being rendered as one long string (the indentation was not respected). This was hard to read and wasn't very clear.
Now that there's a larger amount of information, it makes some sense to put it into a table. Tables don't work nicely when nested in another table, so the preset definitions have been moved into the general route description.
This commit also updates the documentation to reference `preset`, not `presets` given the param is singular.
Fixes https://github.com/matrix-org/matrix-doc/issues/881
2018-07-04 18:16:24 -06:00
caa6d4d9ad
Give all errors a schema reference
...
This just helps keep an overall structure
2018-07-04 13:54:52 -06:00
1140c0c05b
Document StateEvent for /createRoom ( #1329 )
2018-06-22 16:23:05 +01:00
59e4c625b3
Merge pull request #1093 from CromFr/guest_can_join
...
Add createRoom guest_can_join parameter
2018-01-24 20:42:08 +00:00
b270233549
Add createRoom guest_can_join parameter
2017-12-13 14:12:27 +01:00
5e2a48f709
createRoom StateEvent.content should be an object
2017-12-13 00:01:26 +01:00
66268260c7
Merge remote-tracking branch 'remotes/origin/master'
2017-11-13 07:46:29 +09:00
b4e24d443a
Clarify what happens when there is no power_levels event
2017-10-17 16:34:50 +01:00
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
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
b789251f70
More PR feedback
2016-10-05 12:59:49 +01:00
d39f662df5
PR feedback
2016-10-04 11:57:24 +01:00
8fe8bd6a81
Add is_direct to member event spec.
2016-10-03 17:33:45 +01:00
5fedc64230
double space
2016-10-03 15:52:08 +01:00
b121feebce
Comment what the is_direct flag actually does
2016-09-30 11:24:51 +01:00
3a5cbd14c3
Add /createRoom is_direct flag
2016-09-29 11:25:12 +01:00
2370a4c970
Spell out the state algorithm for createRoom
...
Fixes https://matrix.org/jira/browse/SPEC-429 .
Synapse currently follows the specified ordering, but does *not* give the
specified error when the state is invalid (instead it creates the room anyway
but gives a 403 M_FORBIDDEN). Still, I don't think that should be a real
problem for any real clients, and nothing would break if we changed this in
synapse, so it might as well go in the spec anyway.
2016-07-18 13:01:45 +01:00
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
23c4ffbc1b
Add securityDefintions to generated swagger JSON
...
Also factor out to a common file
2016-05-03 13:57:16 +01:00
11c572267e
Add titles where they're missing
2016-03-02 15:23:48 +00:00
48f56bfbfb
Support 3pid invites in /createRoom
2016-01-05 10:52:47 +00:00
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
873b0dcecf
Replace version numbers with release numbers
2015-12-04 11:09:35 +00:00
2f3a00fe34
Consistently spell homeserver as homeserver
2015-12-02 19:23:33 +00:00
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
Travis Ralston