paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-09 08:26:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

api-docs: Update example response header for potential plural.

Browse Source 
The documentation for various API endpoints gives multiple response
examples. Update the headers to reflect this fact.
This commit is contained in:
Lauryn Menard
2022-11-07 20:35:08 +01:00
committed by Tim Abbott
parent fbe2ef9431
commit 2dd3f29c32
3 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
templates/zerver/api/api-doc-template.md
View File

@@ -26,6 +26,6 @@
{generate_response_description(API_ENDPOINT_NAME)} {generate_response_description(API_ENDPOINT_NAME)}
#### Example response #### Example response(s)
{generate_code_example|API_ENDPOINT_NAME|fixture} {generate_code_example|API_ENDPOINT_NAME|fixture}

6
templates/zerver/api/mark-all-as-read.md
View File

@@ -24,7 +24,7 @@
{generate_response_description(/mark_all_as_read:post)} {generate_response_description(/mark_all_as_read:post)}
#### Example response #### Example response(s)
{generate_code_example|/mark_all_as_read:post|fixture} {generate_code_example|/mark_all_as_read:post|fixture}
@@ -54,7 +54,7 @@
{generate_response_description(/mark_all_as_read:post)} {generate_response_description(/mark_all_as_read:post)}
#### Example response #### Example response(s)
{generate_code_example|/mark_stream_as_read:post|fixture} {generate_code_example|/mark_stream_as_read:post|fixture}
@@ -84,6 +84,6 @@
{generate_response_description(/mark_all_as_read:post)} {generate_response_description(/mark_all_as_read:post)}
#### Example response #### Example response(s)
{generate_code_example|/mark_topic_as_read:post|fixture} {generate_code_example|/mark_topic_as_read:post|fixture}

2
templates/zerver/api/send-message.md
View File

@@ -72,6 +72,6 @@ file.
{generate_response_description(/messages:post)} {generate_response_description(/messages:post)}
#### Example response #### Example response(s)
{generate_code_example|/messages:post|fixture} {generate_code_example|/messages:post|fixture}