scheduled-messages: Add API documentation for new endpoint.

Part of splitting creating and editing scheduled messages.
Final commit. Should be merged with previous commits in series.

Updates the API documentation for the new endpoint for editing
scheduled messages.

api_docs/changelog.md

@@ -20,6 +20,15 @@ format used by the Zulip server that they are interacting with.
 
 ## Changes in Zulip 7.0
 
+**Feature level 184**
+
+* [`PATCH /scheduled_messages/<int:scheduled_message_id>`](/api/update-scheduled-message):
+  Added new endpoint for editing an existing scheduled message.
+* [`POST /scheduled_messages`](/api/create-scheduled-message):
+  Removed optional `scheduled_message_id` parameter, which had
+  been a previous way for clients to support editing an existing
+  scheduled message.
+
 **Feature level 183**
 
 * [`POST /register`](/api/register-queue): Removed the
@@ -56,7 +65,7 @@ format used by the Zulip server that they are interacting with.
 
 **Feature level 179**
 
-* [`POST /scheduled_messages`](/api/create-or-update-scheduled-message):
+* [`POST /scheduled_messages`](/api/create-scheduled-message):
   Added new endpoint to create and edit scheduled messages.
 * [`GET /events`](/api/get-events):
   Added `scheduled_messages` events sent to clients when a user creates,

api_docs/create-scheduled-message.md

@@ -17,35 +17,17 @@ curl -X POST {{ api_url }}/v1/scheduled_messages \
     --data-urlencode type=stream \
     --data-urlencode to=9 \
     --data-urlencode topic=Hello \
-    --data-urlencode 'content=Thank you for' \
+    --data-urlencode 'content=Nice to meet everyone!' \
     --data-urlencode scheduled_delivery_timestamp=3165826990
 
-# Update a scheduled stream message
-curl -X POST {{ api_url }}/v1/scheduled_messages \
-    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
-    --data-urlencode type=stream \
-    --data-urlencode to=9 \
-    --data-urlencode 'topic=Welcome aboard' \
-    --data-urlencode 'content=Thank you for the help!' \
-    --data-urlencode scheduled_delivery_timestamp=3165856990 \
-    --data-urlencode scheduled_message_id=1
-
 # Create a scheduled direct message
 curl -X POST {{ api_url }}/v1/messages \
     -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
     --data-urlencode type=direct \
     --data-urlencode 'to=[9, 10]' \
-    --data-urlencode 'content=Can we meet tomorrow?' \
+    --data-urlencode 'content=Can we meet on Monday?' \
     --data-urlencode scheduled_delivery_timestamp=3165826990
 
-# Update a scheduled direct message
-curl -X POST {{ api_url }}/v1/messages \
-    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
-    --data-urlencode type=direct \
-    --data-urlencode 'to=[9, 10, 11]' \
-    --data-urlencode 'content=Can we meet tomorrow?' \
-    --data-urlencode scheduled_delivery_timestamp=3165856990 \
-    --data-urlencode scheduled_message_id=2
 ```
 
 {end_tabs}

api_docs/include/rest-endpoints.md

@@ -20,7 +20,8 @@
 #### Scheduled messages
 
 * [Get scheduled messages](/api/get-scheduled-messages)
-* [Create or edit a scheduled message](/api/create-or-update-scheduled-message)
+* [Create a scheduled message](/api/create-scheduled-message)
+* [Edit a scheduled message](/api/update-scheduled-message)
 * [Delete a scheduled message](/api/delete-scheduled-message)
 
 #### Drafts