zulip/templates/zerver/api
Tim Abbott 4a3ad0da06 api: Improve encoding of stream/topic max field lengths.
Previously, you had to request the `stream` event type in order to get
the stream-level parameters; this was a bad design in part because the
`subscription` event type has similar data and is preferred by most
clients.

So we move these to the `realm` object.  We also add the maximum topic
length, as an adjacent parameter.

While changing this, we also fix these to better match the names of
similar API parameters.
2021-04-10 10:07:57 -07:00
..
add-linkifier.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
add-playground.md realm/playground: Add API endpoint for creating playground entry. 2021-04-07 08:20:53 +05:30
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 api: Improve encoding of stream/topic max field lengths. 2021-04-10 10:07:57 -07:00
check-narrow-matches.md api docs: Document GET /messages/matches_narrow endpoint. 2020-06-19 15:28:10 -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 documentation(api): Fix typo in construct narrow documentation. 2021-03-14 22:05:31 -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 js_examples: Migrate and test get_events example. 2020-07-01 17:23:30 -07:00
get-linkifiers.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -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: Capitalize Markdown consistently. 2020-08-11 10:23:06 -07:00
incoming-webhooks-walkthrough.md docs: Fix more capitalization issues. 2020-10-23 11:46:55 -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 openapi: Make api-docs filename match with operationIds. 2020-06-18 22:38:05 -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: Add backend infrastructure code. 2021-04-06 18:44:08 -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 docs: Fix more capitalization issues. 2020-10-23 11:46:55 -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 js_examples: Migrate and test register_queue example. 2020-06-23 14:35:07 -07:00
remove-linkifier.md api docs: Improve headings and organization for endpoints. 2020-06-18 22:38:05 -07:00
remove-playground.md realm/playground: Add API endpoint for deleting a playground entry. 2021-04-07 08:20:53 +05:30
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 api: Add REALM_DEACTIVATED error code. 2021-03-31 08:46:13 -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 js_examples: Migrate and test set_typing_status example. 2020-06-23 14:35:08 -07:00
sidebar_index.md api docs: Add an API changelog page. 2020-04-28 22:23:25 -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: Add backend infrastructure code. 2021-04-06 18:44:08 -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-message-flags.md api-docs: Fix table in update_message_flags to use proper html. 2021-04-01 15:26:25 -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 python: Convert more variable type annotations to Python 3.6 style. 2020-05-08 16:42:43 -07:00