Skip to content

Commit

Permalink
Clarify wording in the /join endpoints summaries and descriptions (#2038
Browse files Browse the repository at this point in the history
)
  • Loading branch information
HarHarLinks authored Dec 20, 2024
1 parent 1d98e96 commit 2df3f7a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/2038.clarification
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify wording in the `/join` endpoints' summaries and descriptions. Contributed by @HarHarLinks.
8 changes: 4 additions & 4 deletions data/api/client-server/joining.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 2df3f7a

Please sign in to comment.