From 2dd3f29c3213739a63c2e92bb918c13c162c4c84 Mon Sep 17 00:00:00 2001 From: Lauryn Menard Date: Mon, 7 Nov 2022 20:35:08 +0100 Subject: [PATCH] api-docs: Update example response header for potential plural. The documentation for various API endpoints gives multiple response examples. Update the headers to reflect this fact. --- templates/zerver/api/api-doc-template.md | 2 +- templates/zerver/api/mark-all-as-read.md | 6 +++--- templates/zerver/api/send-message.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/templates/zerver/api/api-doc-template.md b/templates/zerver/api/api-doc-template.md index 0e2fe94869..89dc38f6d5 100644 --- a/templates/zerver/api/api-doc-template.md +++ b/templates/zerver/api/api-doc-template.md @@ -26,6 +26,6 @@ {generate_response_description(API_ENDPOINT_NAME)} -#### Example response +#### Example response(s) {generate_code_example|API_ENDPOINT_NAME|fixture} diff --git a/templates/zerver/api/mark-all-as-read.md b/templates/zerver/api/mark-all-as-read.md index 987f5269fc..d21849e117 100644 --- a/templates/zerver/api/mark-all-as-read.md +++ b/templates/zerver/api/mark-all-as-read.md @@ -24,7 +24,7 @@ {generate_response_description(/mark_all_as_read:post)} -#### Example response +#### Example response(s) {generate_code_example|/mark_all_as_read:post|fixture} @@ -54,7 +54,7 @@ {generate_response_description(/mark_all_as_read:post)} -#### Example response +#### Example response(s) {generate_code_example|/mark_stream_as_read:post|fixture} @@ -84,6 +84,6 @@ {generate_response_description(/mark_all_as_read:post)} -#### Example response +#### Example response(s) {generate_code_example|/mark_topic_as_read:post|fixture} diff --git a/templates/zerver/api/send-message.md b/templates/zerver/api/send-message.md index 0c3b90bc47..c71e6211f3 100644 --- a/templates/zerver/api/send-message.md +++ b/templates/zerver/api/send-message.md @@ -72,6 +72,6 @@ file. {generate_response_description(/messages:post)} -#### Example response +#### Example response(s) {generate_code_example|/messages:post|fixture}