Merge pull request #1364 from turt2live/travis/server-name-join

Document the server_name query parameter on /join/{roomIdOrAlias}
pull/977/head
Travis Ralston 6 years ago committed by GitHub
commit 1722734a51
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -143,6 +143,15 @@ paths:
description: The room identifier or alias to join. description: The room identifier or alias to join.
required: true required: true
x-example: "#monkeys:matrix.org" x-example: "#monkeys:matrix.org"
- in: query
type: array
items:
type: string
name: server_name
description: |-
The servers to attempt to join the room through. One of the servers
must be participating in the room.
x-example: ["matrix.org", "elsewhere.ca"]
- in: body - in: body
name: third_party_signed name: third_party_signed
schema: schema:

@ -15,6 +15,8 @@ Unreleased changes
- Sticker messages: - Sticker messages:
- Add sticker message event definition. - Add sticker message event definition.
(`#1158 <https://github.com/matrix-org/matrix-doc/pull/1158>`_). (`#1158 <https://github.com/matrix-org/matrix-doc/pull/1158>`_).
- Document the ``server_name`` parameter on ``/join/{roomIdOrAlias}``
(`#1364 <https://github.com/matrix-org/matrix-doc/pull/1364>`_).
- Add 'token' parameter to /keys/query endpoint - Add 'token' parameter to /keys/query endpoint
(`#1104 <https://github.com/matrix-org/matrix-doc/pull/1104>`_). (`#1104 <https://github.com/matrix-org/matrix-doc/pull/1104>`_).
- Add the room visibility options for the room directory - Add the room visibility options for the room directory

@ -502,6 +502,11 @@ class MatrixUnits(Units):
# assign value expected for this param # assign value expected for this param
val_type = param.get("type") # integer/string val_type = param.get("type") # integer/string
if val_type == "array":
items = param.get("items")
if items:
val_type = "[%s]" % items.get("type")
if param.get("enum"): if param.get("enum"):
val_type = "enum" val_type = "enum"
desc += ( desc += (

Loading…
Cancel
Save