Skip to content

Deprecate several fields on /createRoom #1326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

Deprecate several fields on /createRoom #1326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ef6d312
Include the option of an avatar when creating rooms
turt2live Jun 20, 2018
8476b38
Add "create room with avatar" to the changelog
turt2live Jun 20, 2018
b09b941
Include the avatar in what gets overridden in initial_state
turt2live Jun 21, 2018
c4f4fec
Deprecate name and topic on /createRoom
turt2live Jun 21, 2018
2d5af85
Deprecate guest_can_join on /createRoom
turt2live Jun 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion api/client-server/create_room.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,13 +92,19 @@ paths:
description: |-
If this is included, an ``m.room.name`` event will be sent
into the room to indicate the name of the room. See Room
Events for more information on ``m.room.name``.
Events for more information on ``m.room.name``.

**Deprecated**. Clients should use ``initial_state`` instead
to set the room's name.
topic:
type: string
description: |-
If this is included, an ``m.room.topic`` event will be sent
into the room to indicate the topic for the room. See Room
Events for more information on ``m.room.topic``.

**Deprecated**. Clients should use ``initial_state`` instead
to set the room's topic.
invite:
type: array
description: |-
Expand Down Expand Up @@ -183,6 +189,9 @@ paths:
type: boolean
description: |-
Allows guests to join the room. See `Guest Access`_ for more information.

**Deprecated**. Clients should use ``initial_state`` instead
to set the room's guest access policy.
responses:
200:
description: Information about the newly created room.
Expand Down
2 changes: 2 additions & 0 deletions changelogs/client_server.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ Unreleased changes
(`#1263 <https://github.com/matrix-org/matrix-doc/pull/1263>`_).
- Document `highlights` field in /search response
(`#1274 <https://github.com/matrix-org/matrix-doc/pull/1274>`_).
- Deprecate several fields on ``/createRoom``
(`#1326 <https://github.com/matrix-org/matrix-doc/pull/1326>`_).

r0.3.0
======
Expand Down