zulip/api_docs
Prakhar Pratyush cce75cdb10 register: Improve idle_queue_timeout and document.
Replace the undocumented integer-only idle_queue_timeout parameter
on `POST /register` with a documented parameter that accepts
either a positive integer (seconds) or the string "mobile" to use
the server's recommended timeout for mobile clients (currently
12 hours).

The parameter resolution (None → default 10 min, "mobile" → 12h,
capped at 7 days) happens in ClientDescriptor.__init__, and the
resolved value is sent back through the Tornado response as
idle_queue_timeout_secs, which is included in the `POST /register`
response so clients know the effective timeout.

Signed-off-by: Prakhar Pratyush <prakhar@zulip.com>
2026-03-26 15:55:44 -07:00
..
include api-docs: Document endpoints for allowed email address domains. 2026-03-25 11:42:56 -07:00
api-doc-template.md api-docs: Move markdown files to top level directory. 2023-02-02 17:25:40 -08:00
api-keys.md api-docs: Add notes about mobile client logout with new API key. 2026-03-22 07:57:28 -07:00
changelog.md register: Improve idle_queue_timeout and document. 2026-03-26 15:55:44 -07:00
client-libraries.md docs: Update CZO links from stream to channel in docs and comments. 2024-06-11 10:44:31 -07:00
configuring-python-bindings.md help: Move writing-bots from API docs to help center. 2026-01-12 12:27:34 -08:00
construct-narrow.md get_messages: Add mentions operator for filtering user mentions. 2026-01-05 18:15:44 -08:00
create-scheduled-message.md api-docs: Update placeholder for curl user basic auth credentials. 2026-02-26 10:18:12 -08:00
create-stream.md api-docs: Update descriptive uses of "stream" for channel rename. 2024-05-20 09:31:56 -07:00
group-setting-values.md api-docs: Fix incorrect field names for group-setting value objects. 2025-08-29 10:20:28 -07:00
http-headers.md api-docs: Update placeholder for curl user basic auth credentials. 2026-02-26 10:18:12 -08:00
index.md help: Move running-bots article from API docs to help center. 2026-01-12 12:27:34 -08:00
installation-instructions.md api-docs: Use start_tabs formatting and add "Related articles". 2024-02-24 08:14:32 -08:00
message-formatting.md api-message-formatting: Update markdown example for audio player. 2026-03-04 11:39:08 -05:00
missing.md api-docs: Move markdown files to top level directory. 2023-02-02 17:25:40 -08:00
mobile-notifications.md api_docs: Update payloads sent to the bouncer, FCM, and APNs. 2026-02-24 12:19:57 -08:00
outgoing-webhook-payload.md help: Move outgoing-webhooks from API docs to help center. 2026-01-12 12:27:34 -08:00
real-time-events.md api-docs: Update descriptive uses of "stream" for channel rename. 2024-05-20 09:31:56 -07:00
rest-error-handling.md api-docs: Add comma to all uses of "e.g." in API docs. 2024-07-05 15:36:24 -07:00
rest.md api-docs: Add comma to all uses of "e.g." in API docs. 2024-07-05 15:36:24 -07:00
roles-and-permissions.md help: Update references to removed billing administrator setting. 2026-03-25 11:39:55 -07:00
send-message.md api-docs: Update placeholder for curl user basic auth credentials. 2026-02-26 10:18:12 -08:00
sidebar_index.md help: Make help center canonical location for bots/integrations. 2026-01-12 12:27:34 -08:00
zulip-urls.md api_docs: Add initial article on Zulip URLs. 2025-12-09 09:25:56 -08:00