From 2df3f7a7bfc53be62b8e8ac67b07239739174b9e Mon Sep 17 00:00:00 2001
From: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
Date: Fri, 20 Dec 2024 11:59:42 +0000
Subject: [PATCH] Clarify wording in the /join endpoints summaries and
 descriptions (#2038)

---
 changelogs/client_server/newsfragments/2038.clarification | 1 +
 data/api/client-server/joining.yaml                       | 8 ++++----
 2 files changed, 5 insertions(+), 4 deletions(-)
 create mode 100644 changelogs/client_server/newsfragments/2038.clarification

diff --git a/changelogs/client_server/newsfragments/2038.clarification b/changelogs/client_server/newsfragments/2038.clarification
new file mode 100644
index 00000000..169ca65c
--- /dev/null
+++ b/changelogs/client_server/newsfragments/2038.clarification
@@ -0,0 +1 @@
+Clarify wording in the `/join` endpoints' summaries and descriptions. Contributed by @HarHarLinks.
diff --git a/data/api/client-server/joining.yaml b/data/api/client-server/joining.yaml
index dda0d867..1019abbd 100644
--- a/data/api/client-server/joining.yaml
+++ b/data/api/client-server/joining.yaml
@@ -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.