zulip/templates/zerver/api
Suyash Vardhan Mathur e15af5ae14 apidocs: Add summary field to endpoints.
As a part of effort of removing .md files for /api pages, the
title of each page can be added into the summary OpenAPI
parameter. This also adds a nice summary visible in Swagger
and enhances the documentation. Added the parameter for all endpoints.
2021-05-26 17:38:01 -07:00
..
add-code-playground.md apidocs: Fix playground URLs and operationIDs. 2021-05-26 17:38:00 -07:00
add-linkifier.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
add-reaction.md openapi: Make api-docs filename match with operationIds. 2020-06-18 22:38:05 -07:00
api-keys.md api docs: Update api-keys. 2018-09-25 21:02:58 -07:00
archive-stream.md streams: Use "archive stream" phrasing instead of "delete stream". 2021-04-02 22:06:48 -07:00
changelog.md apidocs: Fix playground URLs and operationIDs. 2021-05-26 17:38:00 -07:00
check-messages-match-narrow.md apidocs: Fix messages match narrow URL. 2021-05-26 17:38:00 -07:00
client-libraries.md docs: Add top level page for language bindings. 2019-11-22 04:33:18 -08:00
configuring-python-bindings.md docs: Fix more capitalization issues. 2020-10-23 11:46:55 -07:00
construct-narrow.md docs: Correct “webapp” to “web app”. 2021-05-14 13:15:38 -07:00
create-custom-profile-field.md api docs: Document POST /realm/profile_fields api endpoint. 2020-08-26 12:48:16 -07:00
create-stream.md api docs: Correct errors in the stream creation documentation. 2020-06-25 14:34:10 -07:00
create-user-group.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
create-user.md api: Return 'user_id' in 'POST /users' response. 2020-08-11 16:40:12 -07:00
deactivate-own-user.md api docs: Add documentation of deactivate-own-user endpoint. 2021-03-25 01:05:44 -07:00
deactivate-user.md openapi: Fix examples in response for deactivating user endpoints. 2020-08-30 17:12:57 -07:00
delete-message.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
delete-queue.md js_examples: Migrate and test delete_queue example. 2020-06-23 14:35:07 -07:00
deploying-bots.md docs: Fix more capitalization issues. 2020-10-23 11:46:55 -07:00
dev-fetch-api-key.md api_docs: Document the /fetch-api-key endpoint. 2020-11-02 16:45:42 -08:00
fetch-api-key.md api_docs: Document the /fetch-api-key endpoint. 2020-11-02 16:45:42 -08:00
get-attachments.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
get-custom-emoji.md js_examples: Migrate and test get_custom_emoji example. 2020-06-23 14:35:07 -07:00
get-custom-profile-fields.md api docs: Document GET /realm/profile_fields endpoint. 2020-08-26 12:48:16 -07:00
get-events.md docs: Correct “webapp” to “web app”. 2021-05-14 13:15:38 -07:00
get-linkifiers.md linkifiers: Update API to send data using dictionaries. 2021-04-13 12:16:07 -07:00
get-message-history.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
get-messages.md refactor: Rename filter to linkifier in frontend code and docs. 2021-03-15 11:19:59 -07:00
get-own-user.md js_examples: Migrate and test get_own_user example. 2020-06-23 14:35:07 -07:00
get-raw-message.md docs: Capitalize Markdown consistently. 2020-08-11 10:23:06 -07:00
get-server-settings.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
get-stream-id.md js_examples: Migrate and test get_stream_id example. 2020-06-23 14:35:07 -07:00
get-stream-topics.md js_examples: Migrate and test get_stream_topics example. 2020-06-23 14:35:07 -07:00
get-streams.md api docs: Fix JavaScript example for /streams api endpoint. 2020-10-11 23:12:33 -07:00
get-subscription-status.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
get-subscriptions.md js_examples: Migrate and test get_subscriptions example. 2020-06-23 14:35:07 -07:00
get-user-by-email.md api: Add REST API endpoint for looking up a user by email address. 2021-02-15 17:38:33 -08:00
get-user-groups.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
get-user-presence.md api: Support user_id in get_user_presence_endpoint. 2021-03-11 20:14:04 -08:00
get-user.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
get-users.md api: Add REST API endpoint for looking up a user by email address. 2021-02-15 17:38:33 -08:00
incoming-webhooks-overview.md docs: Update how to build an incoming webhook docs. 2021-05-08 07:46:26 -07:00
incoming-webhooks-walkthrough.md docs: Fix capitalization mistakes. 2021-05-10 09:57:26 -07:00
index.md openapi: Make api-docs filename match with operationIds. 2020-06-18 22:38:05 -07:00
installation-instructions.md api docs: Fix link to client libraries. 2019-11-22 11:08:44 -08:00
integrations-overview.md docs test: Verify zulip/zulip file and directory links locally. 2020-11-05 10:07:43 -08:00
mark-all-as-read.md apidocs: Add summary field to endpoints. 2021-05-26 17:38:01 -07:00
missing.md
mute-topic.md openapi: Make api-docs filename match with operationIds. 2020-06-18 22:38:05 -07:00
mute-user.md mute user: Fix incomplete API error responses in docs. 2021-04-13 09:08:47 -07:00
non-webhook-integrations.md docs: Extract a Writing Documentation top-level section. 2019-05-29 15:52:11 -07:00
outgoing-webhooks.md outgoing_webhook: Set a default timeout of 10s. 2021-05-07 08:39:36 -07:00
reactivate-user.md openapi: Parse {!api-admin-only.md!} in OpenAPI markdown extension. 2020-06-19 11:04:46 -07:00
real-time-events.md docs: Allow passing additional params to `call_on_each_event`. 2021-04-06 08:40:32 -07:00
register-queue.md docs: Correct “webapp” to “web app”. 2021-05-14 13:15:38 -07:00
remove-code-playground.md apidocs: Fix playground URLs and operationIDs. 2021-05-26 17:38:00 -07:00
remove-linkifier.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
remove-reaction.md openapi: Make api-docs filename match with operationIds. 2020-06-18 22:38:05 -07:00
remove-user-group.md api docs: Rename 'group_id' to 'user_group_id'. 2020-08-26 15:40:19 -07:00
render-message.md js_examples: Migrate and test render_message example. 2020-06-23 14:35:07 -07:00
reorder-custom-profile-fields.md api docs: Document PATCH /realm/profile_fields endpoint. 2020-08-26 12:48:16 -07:00
rest-error-handling.md docs: Fix capitalization mistakes. 2021-05-10 09:57:26 -07:00
rest.md docs: Fix more capitalization issues. 2020-10-23 11:46:55 -07:00
running-bots.md api: Document using `pip3 install` for zulip_bots(erver). 2019-08-23 15:51:06 -07:00
send-message.md api docs: Use --data-urlencode in send-message curl example. 2020-12-07 17:00:05 -08:00
set-typing-status.md typing: Support sending stream/topic typing status. 2021-04-27 20:52:21 -07:00
sidebar_index.md api docs: Avoid confusing the API changelog with the changelog. 2021-05-11 22:00:05 -07:00
subscribe.md js_examples: Migrate and test add_subscriptions example. 2020-06-23 14:35:08 -07:00
unmute-user.md mute user: Fix incomplete API error responses in docs. 2021-04-13 09:08:47 -07:00
unsubscribe.md js_examples: Migrate and test remove_subscriptions example. 2020-06-23 14:35:08 -07:00
update-display-settings.md api docs: Document display settings endpoint. 2021-04-07 12:10:25 -07:00
update-linkifier.md linkifiers: Add an API to support the editing of linkifier. 2021-04-19 18:01:45 -07:00
update-message-flags.md api docs: Clarify how mention flags can change. 2021-05-26 11:59:40 -07:00
update-message.md docs/update-message: Add missing editing permission condition. 2020-07-27 16:33:36 -07:00
update-notification-settings.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
update-stream.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
update-subscription-settings.md api docs: Fix documentation of update-subscription-settings. 2021-02-24 13:28:58 -08:00
update-user-group-members.md api docs: Document POST /user_groups/{group_id}/members endpoint. 2020-08-26 15:40:19 -07:00
update-user-group.md api docs: Rename 'group_id' to 'user_group_id'. 2020-08-26 15:40:19 -07:00
update-user.md openapi: Parse {!api-admin-only.md!} in OpenAPI markdown extension. 2020-06-19 11:04:46 -07:00
upload-custom-emoji.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
upload-file.md openapi_docs: Replace `argument` with `parameter`. 2020-06-18 09:18:27 -07:00
writing-bots.md docs: Correct “webapp” to “web app”. 2021-05-14 13:15:38 -07:00