archive
/
matrix-spec
mirror of https://github.com/matrix-org/matrix-spec
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify wording in the /join endpoints summaries and descriptions (#2038)

Browse Source
pull/2042/head
Kim Brose 12 months ago committed by GitHub
parent 1d98e96300
commit 2df3f7a7bf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File

1
changelogs/client_server/newsfragments/2038.clarification
Unescape Escape View File

@ -0,0 +1 @@
Clarify wording in the `/join` endpoints' summaries and descriptions. Contributed by @HarHarLinks.

8
data/api/client-server/joining.yaml
Unescape Escape View File

@ -18,12 +18,12 @@ info:
paths: paths:
"/rooms/{roomId}/join": "/rooms/{roomId}/join":
post: post:
summary: Start the requesting user participating in a particular room. summary: Join the requesting user to a particular room.
description: |- description: |-
*Note that this API requires a room ID, not alias.* *Note that this API requires a room ID, not alias.*
`/join/{roomIdOrAlias}` *exists if you have a room alias.* `/join/{roomIdOrAlias}` *exists if you have a room alias.*
This API starts a user participating in a particular room, if that user This API starts a user's participation in a particular room, if that user
is allowed to participate in that room. After this call, the client is is allowed to participate in that room. After this call, the client is
allowed to see all current state events in the room, and all subsequent allowed to see all current state events in the room, and all subsequent
events associated with the room until the user leaves the room. events associated with the room until the user leaves the room.
@ -113,11 +113,11 @@ paths:
- Room membership - Room membership
"/join/{roomIdOrAlias}": "/join/{roomIdOrAlias}":
post: post:
summary: Start the requesting user participating in a particular room. summary: Join the requesting user to a particular room.
description: |- description: |-
*Note that this API takes either a room ID or alias, unlike* `/rooms/{roomId}/join`. *Note that this API takes either a room ID or alias, unlike* `/rooms/{roomId}/join`.
This API starts a user participating in a particular room, if that user This API starts a user's participation in a particular room, if that user
is allowed to participate in that room. After this call, the client is is allowed to participate in that room. After this call, the client is
allowed to see all current state events in the room, and all subsequent allowed to see all current state events in the room, and all subsequent
events associated with the room until the user leaves the room. events associated with the room until the user leaves the room.

Write Preview
Loading…
Cancel
Save