From cc2aa41faeafa497ff509020595ccbf0e83de7c8 Mon Sep 17 00:00:00 2001
From: Suyash Vardhan Mathur <suyash.mathur@research.iiit.ac.in>
Date: Tue, 22 Jun 2021 00:50:51 +0530
Subject: [PATCH] openapi: Auto render parameter descriptions.

This commit modifies the templates to
auto-generate general descriptions of
parameters directly from the newly
added field of x-parameter-description
as a part of the goal of a common template.
---
 templates/zerver/api/add-code-playground.md           | 2 ++
 templates/zerver/api/add-linkifier.md                 | 2 ++
 templates/zerver/api/add-reaction.md                  | 2 ++
 templates/zerver/api/archive-stream.md                | 2 ++
 templates/zerver/api/check-messages-match-narrow.md   | 2 ++
 templates/zerver/api/create-custom-profile-field.md   | 2 ++
 templates/zerver/api/create-user-group.md             | 2 ++
 templates/zerver/api/create-user.md                   | 2 ++
 templates/zerver/api/deactivate-own-user.md           | 2 ++
 templates/zerver/api/deactivate-user.md               | 2 ++
 templates/zerver/api/delete-message.md                | 2 ++
 templates/zerver/api/delete-queue.md                  | 2 ++
 templates/zerver/api/dev-fetch-api-key.md             | 2 ++
 templates/zerver/api/fetch-api-key.md                 | 2 ++
 templates/zerver/api/get-attachments.md               | 2 ++
 templates/zerver/api/get-custom-emoji.md              | 2 ++
 templates/zerver/api/get-custom-profile-fields.md     | 2 ++
 templates/zerver/api/get-events.md                    | 1 +
 templates/zerver/api/get-linkifiers.md                | 2 ++
 templates/zerver/api/get-message-history.md           | 2 ++
 templates/zerver/api/get-messages.md                  | 2 ++
 templates/zerver/api/get-own-user.md                  | 2 ++
 templates/zerver/api/get-raw-message.md               | 2 ++
 templates/zerver/api/get-server-settings.md           | 2 ++
 templates/zerver/api/get-stream-id.md                 | 2 ++
 templates/zerver/api/get-stream-topics.md             | 2 ++
 templates/zerver/api/get-streams.md                   | 2 ++
 templates/zerver/api/get-subscription-status.md       | 2 ++
 templates/zerver/api/get-subscriptions.md             | 2 ++
 templates/zerver/api/get-user-by-email.md             | 2 ++
 templates/zerver/api/get-user-groups.md               | 2 ++
 templates/zerver/api/get-user-presence.md             | 2 ++
 templates/zerver/api/get-user.md                      | 2 ++
 templates/zerver/api/get-users.md                     | 2 ++
 templates/zerver/api/mark-all-as-read.md              | 6 ++++++
 templates/zerver/api/mute-topic.md                    | 2 ++
 templates/zerver/api/mute-user.md                     | 2 ++
 templates/zerver/api/reactivate-user.md               | 2 ++
 templates/zerver/api/remove-code-playground.md        | 2 ++
 templates/zerver/api/remove-linkifier.md              | 2 ++
 templates/zerver/api/remove-reaction.md               | 2 ++
 templates/zerver/api/remove-user-group.md             | 2 ++
 templates/zerver/api/render-message.md                | 2 ++
 templates/zerver/api/reorder-custom-profile-fields.md | 2 ++
 templates/zerver/api/send-message.md                  | 2 ++
 templates/zerver/api/set-typing-status.md             | 2 ++
 templates/zerver/api/subscribe.md                     | 2 ++
 templates/zerver/api/unmute-user.md                   | 2 ++
 templates/zerver/api/update-display-settings.md       | 2 ++
 templates/zerver/api/update-linkifier.md              | 2 ++
 templates/zerver/api/update-message-flags.md          | 1 +
 templates/zerver/api/update-message.md                | 2 ++
 templates/zerver/api/update-notification-settings.md  | 2 ++
 templates/zerver/api/update-stream.md                 | 2 ++
 templates/zerver/api/update-subscription-settings.md  | 2 ++
 templates/zerver/api/update-user-group-members.md     | 2 ++
 templates/zerver/api/update-user-group.md             | 2 ++
 templates/zerver/api/update-user.md                   | 2 ++
 templates/zerver/api/upload-custom-emoji.md           | 1 +
 templates/zerver/api/upload-file.md                   | 1 +
 60 files changed, 120 insertions(+)

diff --git a/templates/zerver/api/add-code-playground.md b/templates/zerver/api/add-code-playground.md
index 3fadf83410..c76564191f 100644
--- a/templates/zerver/api/add-code-playground.md
+++ b/templates/zerver/api/add-code-playground.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/realm/playgrounds:post}
 
+{generate_parameter_description(/realm/playgrounds:post)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/realm/playgrounds:post}
diff --git a/templates/zerver/api/add-linkifier.md b/templates/zerver/api/add-linkifier.md
index 2ce5243129..bca0d895c2 100644
--- a/templates/zerver/api/add-linkifier.md
+++ b/templates/zerver/api/add-linkifier.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/realm/filters:post}
 
+{generate_parameter_description(/realm/filters:post)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/realm/filters:post}
diff --git a/templates/zerver/api/add-reaction.md b/templates/zerver/api/add-reaction.md
index 0b503dcc5c..12c3be9444 100644
--- a/templates/zerver/api/add-reaction.md
+++ b/templates/zerver/api/add-reaction.md
@@ -22,6 +22,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/messages/{message_id}/reactions:post}
 
+{generate_parameter_description(/messages/{message_id}/reactions:post)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/archive-stream.md b/templates/zerver/api/archive-stream.md
index 9a523de7ee..ecf87d0c5c 100644
--- a/templates/zerver/api/archive-stream.md
+++ b/templates/zerver/api/archive-stream.md
@@ -23,6 +23,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/streams/{stream_id}:delete}
 
+{generate_parameter_description(/streams/{stream_id}:delete)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/check-messages-match-narrow.md b/templates/zerver/api/check-messages-match-narrow.md
index ab836aab86..c6a43f635d 100644
--- a/templates/zerver/api/check-messages-match-narrow.md
+++ b/templates/zerver/api/check-messages-match-narrow.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/messages/matches_narrow:get}
 
+{generate_parameter_description(/messages/matches_narrow:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/messages/matches_narrow:get}
diff --git a/templates/zerver/api/create-custom-profile-field.md b/templates/zerver/api/create-custom-profile-field.md
index 3d7b2cf3a5..2d63312a87 100644
--- a/templates/zerver/api/create-custom-profile-field.md
+++ b/templates/zerver/api/create-custom-profile-field.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/realm/profile_fields:post}
 
+{generate_parameter_description(/realm/profile_fields:post)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/realm/profile_fields:post}
diff --git a/templates/zerver/api/create-user-group.md b/templates/zerver/api/create-user-group.md
index 0a8f399157..4624136cdb 100644
--- a/templates/zerver/api/create-user-group.md
+++ b/templates/zerver/api/create-user-group.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/user_groups/create:post}
 
+{generate_parameter_description(/user_groups/create:post)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/create-user.md b/templates/zerver/api/create-user.md
index efc43e0f15..8bcb56bd73 100644
--- a/templates/zerver/api/create-user.md
+++ b/templates/zerver/api/create-user.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users:post}
 
+{generate_parameter_description(/users:post)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/users:post}
diff --git a/templates/zerver/api/deactivate-own-user.md b/templates/zerver/api/deactivate-own-user.md
index 5e1b006c69..00fd213b7a 100644
--- a/templates/zerver/api/deactivate-own-user.md
+++ b/templates/zerver/api/deactivate-own-user.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users/me:delete}
 
+{generate_parameter_description(/users/me:delete)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/deactivate-user.md b/templates/zerver/api/deactivate-user.md
index 97715ee4ce..4211a730e6 100644
--- a/templates/zerver/api/deactivate-user.md
+++ b/templates/zerver/api/deactivate-user.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users/{user_id}:delete}
 
+{generate_parameter_description(/users/{user_id}:delete)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/delete-message.md b/templates/zerver/api/delete-message.md
index ee1efea467..2c1c3ca61f 100644
--- a/templates/zerver/api/delete-message.md
+++ b/templates/zerver/api/delete-message.md
@@ -23,6 +23,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/messages/{message_id}:delete}
 
+{generate_parameter_description(/messages/{message_id}:delete)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/delete-queue.md b/templates/zerver/api/delete-queue.md
index 68e84afb9f..6bce394df3 100644
--- a/templates/zerver/api/delete-queue.md
+++ b/templates/zerver/api/delete-queue.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/events:delete}
 
+{generate_parameter_description(/events:delete)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/dev-fetch-api-key.md b/templates/zerver/api/dev-fetch-api-key.md
index 7db60bc85f..eed5eecc85 100644
--- a/templates/zerver/api/dev-fetch-api-key.md
+++ b/templates/zerver/api/dev-fetch-api-key.md
@@ -15,6 +15,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/dev_fetch_api_key:post}
 
+{generate_parameter_description(/dev_fetch_api_key:post)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/dev_fetch_api_key:post}
diff --git a/templates/zerver/api/fetch-api-key.md b/templates/zerver/api/fetch-api-key.md
index 5bde3800af..04bbef5d5a 100644
--- a/templates/zerver/api/fetch-api-key.md
+++ b/templates/zerver/api/fetch-api-key.md
@@ -15,6 +15,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/fetch_api_key:post}
 
+{generate_parameter_description(/fetch_api_key:post)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/fetch_api_key:post}
diff --git a/templates/zerver/api/get-attachments.md b/templates/zerver/api/get-attachments.md
index 57258de83e..0d9906bac4 100644
--- a/templates/zerver/api/get-attachments.md
+++ b/templates/zerver/api/get-attachments.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/attachments:get}
 
+{generate_parameter_description(/attachments:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/attachments:get}
diff --git a/templates/zerver/api/get-custom-emoji.md b/templates/zerver/api/get-custom-emoji.md
index f7ab7106d1..dbaef26cd4 100644
--- a/templates/zerver/api/get-custom-emoji.md
+++ b/templates/zerver/api/get-custom-emoji.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/realm/emoji:get}
 
+{generate_parameter_description(/realm/emoji:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/realm/emoji:get}
diff --git a/templates/zerver/api/get-custom-profile-fields.md b/templates/zerver/api/get-custom-profile-fields.md
index c3833c2132..836166a9e1 100644
--- a/templates/zerver/api/get-custom-profile-fields.md
+++ b/templates/zerver/api/get-custom-profile-fields.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/realm/profile_fields:get}
 
+{generate_parameter_description(/realm/profile_fields:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/realm/profile_fields:get}
diff --git a/templates/zerver/api/get-events.md b/templates/zerver/api/get-events.md
index 56bcdb7287..2eabe0bdba 100644
--- a/templates/zerver/api/get-events.md
+++ b/templates/zerver/api/get-events.md
@@ -45,6 +45,7 @@ even if you haven't registered a queue by explicitly requesting the
 `{{ api_url}}/v1/register` endpoint, you could pass the parameters for
 [the `{{ api_url}}/v1/register` endpoint](/api/register-queue) to this
 endpoint and a queue would be registered in the absence of a `queue_id`.
+{generate_parameter_description(/events:get)}
 
 ## Response
 
diff --git a/templates/zerver/api/get-linkifiers.md b/templates/zerver/api/get-linkifiers.md
index 2283376ca6..5ffae9be52 100644
--- a/templates/zerver/api/get-linkifiers.md
+++ b/templates/zerver/api/get-linkifiers.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/realm/linkifiers:get}
 
+{generate_parameter_description(/realm/linkifiers:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/realm/linkifiers:get}
diff --git a/templates/zerver/api/get-message-history.md b/templates/zerver/api/get-message-history.md
index 3e763c9eef..9efeb2be0d 100644
--- a/templates/zerver/api/get-message-history.md
+++ b/templates/zerver/api/get-message-history.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/messages/{message_id}/history:get}
 
+{generate_parameter_description(/messages/{message_id}/history:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/messages/{message_id}/history:get}
diff --git a/templates/zerver/api/get-messages.md b/templates/zerver/api/get-messages.md
index 32dc159183..ae1ce36127 100644
--- a/templates/zerver/api/get-messages.md
+++ b/templates/zerver/api/get-messages.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/messages:get}
 
+{generate_parameter_description(/messages:get)}
+
 ## Response
 
 When a request is successful, this endpoint returns a dictionary
diff --git a/templates/zerver/api/get-own-user.md b/templates/zerver/api/get-own-user.md
index 3a7ae3ab79..542cbba9ec 100644
--- a/templates/zerver/api/get-own-user.md
+++ b/templates/zerver/api/get-own-user.md
@@ -21,6 +21,8 @@
 
 This endpoint takes no parameters.
 
+{generate_parameter_description(/users/me:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/users/me:get}
diff --git a/templates/zerver/api/get-raw-message.md b/templates/zerver/api/get-raw-message.md
index 088d78b56e..e86119bc9f 100644
--- a/templates/zerver/api/get-raw-message.md
+++ b/templates/zerver/api/get-raw-message.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/messages/{message_id}:get}
 
+{generate_parameter_description(/messages/{message_id}:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/messages/{message_id}:get}
diff --git a/templates/zerver/api/get-server-settings.md b/templates/zerver/api/get-server-settings.md
index 608543b272..7ae4510c80 100644
--- a/templates/zerver/api/get-server-settings.md
+++ b/templates/zerver/api/get-server-settings.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/server_settings:get}
 
+{generate_parameter_description(/server_settings:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/server_settings:get}
diff --git a/templates/zerver/api/get-stream-id.md b/templates/zerver/api/get-stream-id.md
index dc659f96f5..deb9d99678 100644
--- a/templates/zerver/api/get-stream-id.md
+++ b/templates/zerver/api/get-stream-id.md
@@ -23,6 +23,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/get_stream_id:get}
 
+{generate_parameter_description(/get_stream_id:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/get_stream_id:get}
diff --git a/templates/zerver/api/get-stream-topics.md b/templates/zerver/api/get-stream-topics.md
index df299adcbe..1f666660c1 100644
--- a/templates/zerver/api/get-stream-topics.md
+++ b/templates/zerver/api/get-stream-topics.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users/me/{stream_id}/topics:get}
 
+{generate_parameter_description(/users/me/{stream_id}/topics:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/users/me/{stream_id}/topics:get}
diff --git a/templates/zerver/api/get-streams.md b/templates/zerver/api/get-streams.md
index ee93681998..a30a04b08e 100644
--- a/templates/zerver/api/get-streams.md
+++ b/templates/zerver/api/get-streams.md
@@ -23,6 +23,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/streams:get}
 
+{generate_parameter_description(/streams:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/streams:get}
diff --git a/templates/zerver/api/get-subscription-status.md b/templates/zerver/api/get-subscription-status.md
index 03421b504d..2484d4b2c6 100644
--- a/templates/zerver/api/get-subscription-status.md
+++ b/templates/zerver/api/get-subscription-status.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users/{user_id}/subscriptions/{stream_id}:get}
 
+{generate_parameter_description(/users/{user_id}/subscriptions/{stream_id}:get)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/get-subscriptions.md b/templates/zerver/api/get-subscriptions.md
index dd155ed4a1..7fa5322a00 100644
--- a/templates/zerver/api/get-subscriptions.md
+++ b/templates/zerver/api/get-subscriptions.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users/me/subscriptions:get}
 
+{generate_parameter_description(/users/me/subscriptions:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/users/me/subscriptions:get}
diff --git a/templates/zerver/api/get-user-by-email.md b/templates/zerver/api/get-user-by-email.md
index 1377e82eec..cc765579ec 100644
--- a/templates/zerver/api/get-user-by-email.md
+++ b/templates/zerver/api/get-user-by-email.md
@@ -23,6 +23,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users/{email}:get}
 
+{generate_parameter_description(/users/{email}:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml}|/users/{email}:get}
diff --git a/templates/zerver/api/get-user-groups.md b/templates/zerver/api/get-user-groups.md
index 03de66c1ee..581f9dccad 100644
--- a/templates/zerver/api/get-user-groups.md
+++ b/templates/zerver/api/get-user-groups.md
@@ -23,6 +23,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/user_groups:get}
 
+{generate_parameter_description(/user_groups:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/user_groups:get}
diff --git a/templates/zerver/api/get-user-presence.md b/templates/zerver/api/get-user-presence.md
index 5be2f9fd91..91787adf85 100644
--- a/templates/zerver/api/get-user-presence.md
+++ b/templates/zerver/api/get-user-presence.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users/{user_id_or_email}/presence:get}
 
+{generate_parameter_description(/users/{user_id_or_email}/presence:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/users/{user_id_or_email}/presence:get}
diff --git a/templates/zerver/api/get-user.md b/templates/zerver/api/get-user.md
index 57044f4565..69046d894c 100644
--- a/templates/zerver/api/get-user.md
+++ b/templates/zerver/api/get-user.md
@@ -23,6 +23,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users/{user_id}:get}
 
+{generate_parameter_description(/users/{user_id}:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml}|/users/{user_id}:get}
diff --git a/templates/zerver/api/get-users.md b/templates/zerver/api/get-users.md
index a9f4faba55..2ec960670c 100644
--- a/templates/zerver/api/get-users.md
+++ b/templates/zerver/api/get-users.md
@@ -23,6 +23,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users:get}
 
+{generate_parameter_description(/users:get)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/users:get}
diff --git a/templates/zerver/api/mark-all-as-read.md b/templates/zerver/api/mark-all-as-read.md
index d0eebb859e..04690d22a0 100644
--- a/templates/zerver/api/mark-all-as-read.md
+++ b/templates/zerver/api/mark-all-as-read.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/mark_all_as_read:post}
 
+{generate_parameter_description(/mark_all_as_read:post)}
+
 ## Response
 
 #### Example response
@@ -54,6 +56,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/mark_stream_as_read:post}
 
+{generate_parameter_description(/mark_all_as_read:post)}
+
 ## Response
 
 #### Example response
@@ -88,6 +92,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/mark_topic_as_read:post}
 
+{generate_parameter_description(/mark_all_as_read:post)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/mute-topic.md b/templates/zerver/api/mute-topic.md
index 494c5b3938..40c4a88db9 100644
--- a/templates/zerver/api/mute-topic.md
+++ b/templates/zerver/api/mute-topic.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users/me/subscriptions/muted_topics:patch}
 
+{generate_parameter_description(/users/me/subscriptions/muted_topics:patch)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/mute-user.md b/templates/zerver/api/mute-user.md
index 11fd129d50..9e97d94a0c 100644
--- a/templates/zerver/api/mute-user.md
+++ b/templates/zerver/api/mute-user.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users/me/muted_users/{muted_user_id}:post}
 
+{generate_parameter_description(/users/me/muted_users/{muted_user_id}:post)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/reactivate-user.md b/templates/zerver/api/reactivate-user.md
index 81f556d444..d67ce34e79 100644
--- a/templates/zerver/api/reactivate-user.md
+++ b/templates/zerver/api/reactivate-user.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users/{user_id}/reactivate:post}
 
+{generate_parameter_description(/users/{user_id}/reactivate:post)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/remove-code-playground.md b/templates/zerver/api/remove-code-playground.md
index 009ddad4cb..7f5d8a9e15 100644
--- a/templates/zerver/api/remove-code-playground.md
+++ b/templates/zerver/api/remove-code-playground.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/realm/playgrounds/{playground_id}:delete}
 
+{generate_parameter_description(/realm/playgrounds/{playground_id}:delete)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/remove-linkifier.md b/templates/zerver/api/remove-linkifier.md
index b3c8bed03b..8c0cde8185 100644
--- a/templates/zerver/api/remove-linkifier.md
+++ b/templates/zerver/api/remove-linkifier.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/realm/filters/{filter_id}:delete}
 
+{generate_parameter_description(/realm/filters/{filter_id}:delete)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/remove-reaction.md b/templates/zerver/api/remove-reaction.md
index 24c3455956..960d165d1c 100644
--- a/templates/zerver/api/remove-reaction.md
+++ b/templates/zerver/api/remove-reaction.md
@@ -23,6 +23,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/messages/{message_id}/reactions:delete}
 
+{generate_parameter_description(/messages/{message_id}/reactions:delete)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/remove-user-group.md b/templates/zerver/api/remove-user-group.md
index 88382eb4e5..3ef0f0f643 100644
--- a/templates/zerver/api/remove-user-group.md
+++ b/templates/zerver/api/remove-user-group.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/user_groups/{user_group_id}:delete}
 
+{generate_parameter_description(/user_groups/{user_group_id}:delete)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/render-message.md b/templates/zerver/api/render-message.md
index 3439c52c49..6e154424e8 100644
--- a/templates/zerver/api/render-message.md
+++ b/templates/zerver/api/render-message.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/messages/render:post}
 
+{generate_parameter_description(/messages/render:post)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/messages/render:post}
diff --git a/templates/zerver/api/reorder-custom-profile-fields.md b/templates/zerver/api/reorder-custom-profile-fields.md
index 5732b3abf0..7a7306a051 100644
--- a/templates/zerver/api/reorder-custom-profile-fields.md
+++ b/templates/zerver/api/reorder-custom-profile-fields.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/realm/profile_fields:patch}
 
+{generate_parameter_description(/realm/profile_fields:patch)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/realm/profile_fields:patch}
diff --git a/templates/zerver/api/send-message.md b/templates/zerver/api/send-message.md
index 35918ffc1d..2d65623bf4 100644
--- a/templates/zerver/api/send-message.md
+++ b/templates/zerver/api/send-message.md
@@ -67,6 +67,8 @@ file.
 
 {generate_api_arguments_table|zulip.yaml|/messages:post}
 
+{generate_parameter_description(/messages:post)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/messages:post}
diff --git a/templates/zerver/api/set-typing-status.md b/templates/zerver/api/set-typing-status.md
index 3c186a0693..c2e651d533 100644
--- a/templates/zerver/api/set-typing-status.md
+++ b/templates/zerver/api/set-typing-status.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/typing:post}
 
+{generate_parameter_description(/typing:post)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/subscribe.md b/templates/zerver/api/subscribe.md
index 85d0e116c5..031674a939 100644
--- a/templates/zerver/api/subscribe.md
+++ b/templates/zerver/api/subscribe.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users/me/subscriptions:post}
 
+{generate_parameter_description(/users/me/subscriptions:post)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/users/me/subscriptions:post}
diff --git a/templates/zerver/api/unmute-user.md b/templates/zerver/api/unmute-user.md
index 4d8240ca72..e86312b873 100644
--- a/templates/zerver/api/unmute-user.md
+++ b/templates/zerver/api/unmute-user.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users/me/muted_users/{muted_user_id}:delete}
 
+{generate_parameter_description(/users/me/muted_users/{muted_user_id}:delete)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/update-display-settings.md b/templates/zerver/api/update-display-settings.md
index 5ed33a724e..52fde4b179 100644
--- a/templates/zerver/api/update-display-settings.md
+++ b/templates/zerver/api/update-display-settings.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/settings/display:patch}
 
+{generate_parameter_description(/settings/display:patch)}
+
 ## Response
 
 #### Return values
diff --git a/templates/zerver/api/update-linkifier.md b/templates/zerver/api/update-linkifier.md
index 8607955ef8..d4653793fc 100644
--- a/templates/zerver/api/update-linkifier.md
+++ b/templates/zerver/api/update-linkifier.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/realm/filters/{filter_id}:patch}
 
+{generate_parameter_description(/realm/filters/{filter_id}:patch)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/realm/filters/{filter_id}:patch}
diff --git a/templates/zerver/api/update-message-flags.md b/templates/zerver/api/update-message-flags.md
index cfef53b9b4..2498a63ea6 100644
--- a/templates/zerver/api/update-message-flags.md
+++ b/templates/zerver/api/update-message-flags.md
@@ -93,6 +93,7 @@
         </tbody>
     </table>
 </div>
+{generate_parameter_description(/messages/flags:post)}
 
 ## Response
 
diff --git a/templates/zerver/api/update-message.md b/templates/zerver/api/update-message.md
index a1b4f4d9f0..0877202704 100644
--- a/templates/zerver/api/update-message.md
+++ b/templates/zerver/api/update-message.md
@@ -30,6 +30,8 @@ You only have permission to edit a message if:
 
 {generate_api_arguments_table|zulip.yaml|/messages/{message_id}:patch}
 
+{generate_parameter_description(/messages/{message_id}:patch)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/update-notification-settings.md b/templates/zerver/api/update-notification-settings.md
index d184b97127..c3cd1991c3 100644
--- a/templates/zerver/api/update-notification-settings.md
+++ b/templates/zerver/api/update-notification-settings.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/settings/notifications:patch}
 
+{generate_parameter_description(/settings/notifications:patch)}
+
 ## Response
 
 #### Return values
diff --git a/templates/zerver/api/update-stream.md b/templates/zerver/api/update-stream.md
index 30a1188399..cd4568c910 100644
--- a/templates/zerver/api/update-stream.md
+++ b/templates/zerver/api/update-stream.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/streams/{stream_id}:patch}
 
+{generate_parameter_description(/streams/{stream_id}:patch)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/update-subscription-settings.md b/templates/zerver/api/update-subscription-settings.md
index 5801829dcb..9061ce41ec 100644
--- a/templates/zerver/api/update-subscription-settings.md
+++ b/templates/zerver/api/update-subscription-settings.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users/me/subscriptions/properties:post}
 
+{generate_parameter_description(/users/me/subscriptions/properties:post)}
+
 ## Response
 
 {generate_return_values_table|zulip.yaml|/users/me/subscriptions/properties:post}
diff --git a/templates/zerver/api/update-user-group-members.md b/templates/zerver/api/update-user-group-members.md
index 0eec63e605..e1369fff3c 100644
--- a/templates/zerver/api/update-user-group-members.md
+++ b/templates/zerver/api/update-user-group-members.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/user_groups/{user_group_id}/members:post}
 
+{generate_parameter_description(/user_groups/{user_group_id}/members:post)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/update-user-group.md b/templates/zerver/api/update-user-group.md
index 1bf80d8037..f336fe53d8 100644
--- a/templates/zerver/api/update-user-group.md
+++ b/templates/zerver/api/update-user-group.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/user_groups/{user_group_id}:patch}
 
+{generate_parameter_description(/user_groups/{user_group_id}:patch)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/update-user.md b/templates/zerver/api/update-user.md
index ff68dff571..83e42df400 100644
--- a/templates/zerver/api/update-user.md
+++ b/templates/zerver/api/update-user.md
@@ -21,6 +21,8 @@
 
 {generate_api_arguments_table|zulip.yaml|/users/{user_id}:patch}
 
+{generate_parameter_description(/users/{user_id}:patch)}
+
 ## Response
 
 #### Example response
diff --git a/templates/zerver/api/upload-custom-emoji.md b/templates/zerver/api/upload-custom-emoji.md
index e7bf76c601..fcc3867119 100644
--- a/templates/zerver/api/upload-custom-emoji.md
+++ b/templates/zerver/api/upload-custom-emoji.md
@@ -39,6 +39,7 @@ in the [server's settings][1]. `MAX_EMOJI_FILE_SIZE_MIB` defaults
 to 5MB.
 
 [1]: https://zulip.readthedocs.io/en/latest/subsystems/settings.html#server-settings
+{generate_parameter_description(/realm/emoji/{emoji_name}:post)}
 
 ## Response
 #### Example response
diff --git a/templates/zerver/api/upload-file.md b/templates/zerver/api/upload-file.md
index b8babcac13..d2c1edb2ee 100644
--- a/templates/zerver/api/upload-file.md
+++ b/templates/zerver/api/upload-file.md
@@ -31,6 +31,7 @@ in the [server's settings][1]. `MAX_FILE_UPLOAD_SIZE` defaults
 to 25MB.
 
 [1]: https://zulip.readthedocs.io/en/latest/subsystems/settings.html#server-settings
+{generate_parameter_description(/user_uploads:post)}
 
 ## Response