You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
matrix-spec/api/client-server
Travis Ralston 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)
* Power level content overrides:
  * 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
6 years ago
..
definitions document new login identifier object (#1390) 6 years ago
account-data.yaml Add operationId to all endpoints of all APIs 7 years ago
admin.yaml Add operationId to all endpoints of all APIs 7 years ago
administrative_contact.yaml Give all errors a schema reference 6 years ago
banning.yaml Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 6 years ago
cas_login_redirect.yaml Add operationId to all endpoints of all APIs 7 years ago
cas_login_ticket.yaml operationid -> operationId 7 years ago
content-repo.yaml Fix error reference in media repo 6 years ago
create_room.yaml Add general clarity to the /createRoom endpoint 6 years ago
device_management.yaml add delete_devices endpoint 7 years ago
directory.yaml Give all errors a schema reference 6 years ago
event_context.yaml Add operationId to all endpoints of all APIs 7 years ago
filter.yaml Merge remote-tracking branch 'remotes/origin/master' 7 years ago
inviting.yaml Give all errors a schema reference 6 years ago
joining.yaml Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 6 years ago
keys.yaml Update keys.yaml 6 years ago
kicking.yaml Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 6 years ago
leaving.yaml Fix reference to error.yaml in forget room API 6 years ago
list_joined_rooms.yaml Added/updated operationIds according to today's updates in the spec 7 years ago
list_public_rooms.yaml Document the /publicRooms endpoint for federation 6 years ago
login.yaml document new login identifier object (#1390) 6 years ago
logout.yaml Document /logout/all 7 years ago
message_pagination.yaml Add a missing $ref 6 years ago
notifications.yaml Add operationId to all endpoints of all APIs 7 years ago
old_sync.yaml link to both context and event in depr notice as per review 7 years ago
peeking_events.yaml Add operationId to all endpoints of all APIs 7 years ago
presence.yaml Convert errors in presence.yaml 6 years ago
profile.yaml Describe the rate limit error everywhere 6 years ago
pusher.yaml Give all errors a schema reference 6 years ago
pushrules.yaml Give all errors a schema reference 6 years ago
receipts.yaml Describe the rate limit error everywhere 6 years ago
redaction.yaml Use the correct event_id format on examples 7 years ago
registration.yaml Give all errors a schema reference 6 years ago
report_content.yaml Document how to report content 7 years ago
room_initial_sync.yaml Add operationId to all endpoints of all APIs 7 years ago
room_send.yaml Use the correct event_id format on examples 7 years ago
room_state.yaml Use the correct event_id format on examples 7 years ago
rooms.yaml /rooms/{roomId}/members: specify access_token requirement 7 years ago
search.yaml Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 6 years ago
sync.yaml move /rooms/{roomId}/event/{eventId} and update depr notice 7 years ago
tags.yaml Missing comma 6 years ago
third_party_lookup.yaml Move TODO. field1, field2... -> fields... 6 years ago
third_party_membership.yaml Give all errors a schema reference 6 years ago
to_device.yaml Add operationId to all endpoints of all APIs 7 years ago
typing.yaml Describe the rate limit error everywhere 6 years ago
users.yaml Describe the rate limit error everywhere 6 years ago
versions.yaml Add operationId to all endpoints of all APIs 7 years ago
voip.yaml Describe the rate limit error everywhere 6 years ago
whoami.yaml Give all errors a schema reference 6 years ago