wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

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

Browse source
This commit is contained in:
Kim Brose 2024-12-20 11:59:42 +00:00 • 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
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/2038.clarification Normal file
View file

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

8
data/api/client-server/joining.yaml
View file

@ -18,12 +18,12 @@ info:
paths:
"/rooms/{roomId}/join":
post:
summary: Start the requesting user participating in a particular room.
summary: Join the requesting user to a particular room.
description: |-
*Note that this API requires a room ID, not 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
allowed to see all current state events in the room, and all subsequent
events associated with the room until the user leaves the room.
@ -113,11 +113,11 @@ paths:
- Room membership
"/join/{roomIdOrAlias}":
post:
summary: Start the requesting user participating in a particular room.
summary: Join the requesting user to a particular room.
description: |-
*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
allowed to see all current state events in the room, and all subsequent
events associated with the room until the user leaves the room.