zulip/api_docs
Mateusz Mandera a36f906d1a presence: Add history_limit_days param to the API.
This param allows clients to specify how much presence history they want
to fetch. Previously, the server always returned 14 days of history.
With the recent migration of the presence API to the much more efficient
system relying on incremental fetches via the last_update_id param added
in #29999, we can now afford to provide much more history to clients
that request it - as all that historical data will only be fetched once.

There are three endpoints involved:
- `/register` - this is the main useful endpoint for this, used by API
clients to fetch initial data and register an events queue. Clients can
pass the `presence_history_limit_days` param here.
- `/users/me/presence` - this endpoint is currently used by clients to
update their presence status and fetch incremental data, making the new
functionality not particularly useful here. However, we still add the
new `history_limit_days` param here, in case in the future clients
transition to using this also for the initial presence data fetch.
- `/` - used when opening the webapp. Naturally, params aren't passed
here, so the server just assumes a value from
`settings.PRESENCE_HISTORY_LIMIT_DAYS_FOR_WEB_APP` and returns
information about this default value in page_params.
2024-09-10 13:15:35 -07:00
..
include api_docs: Document "/export/realm" endpoints. 2024-08-12 10:12:08 -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: Use start_tabs formatting and add "Related articles". 2024-02-24 08:14:32 -08:00
changelog.md presence: Add history_limit_days param to the API. 2024-09-10 13:15:35 -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 api_docs: List all Python bindings configuration options. 2024-02-23 09:43:57 -08:00
construct-narrow.md api-docs: Clarify the behavior of the near operator. 2024-08-20 09:56:00 -07:00
create-scheduled-message.md api-docs: Update descriptive uses of "stream" for channel rename. 2024-05-20 09:31:56 -07:00
create-stream.md api-docs: Update descriptive uses of "stream" for channel rename. 2024-05-20 09:31:56 -07:00
deploying-bots.md api-docs: Add comma to all uses of "e.g." in API docs. 2024-07-05 15:36:24 -07:00
group-setting-values.md user_groups: Add server level setting disallow anonymous groups for settings. 2024-06-03 09:45:26 -07:00
http-headers.md web: Fix links which were missing trailing slashes. 2024-01-11 13:52:12 -08:00
incoming-webhooks-overview.md api-docs: Add comma to all uses of "e.g." in API docs. 2024-07-05 15:36:24 -07:00
incoming-webhooks-walkthrough.md docs: Remove has_request_variables and REQ. 2024-09-05 16:02:12 -07:00
index.md web: Save a needless 301 redirect from /integrations to /integrations/. 2023-03-24 14:51:01 -07:00
installation-instructions.md api-docs: Use start_tabs formatting and add "Related articles". 2024-02-24 08:14:32 -08:00
integrations-overview.md api-docs: Update descriptive uses of "stream" for channel rename. 2024-05-20 09:31:56 -07:00
message-formatting.md thumbnail: Put the original dimensions on spinner images. 2024-09-09 15:59:02 -07:00
missing.md api-docs: Move markdown files to top level directory. 2023-02-02 17:25:40 -08:00
non-webhook-integrations.md api-docs: Use start_tabs formatting and add "Related articles". 2024-02-24 08:14:32 -08:00
outgoing-webhooks.md typos: Fix typos caught by mwic. 2024-05-20 13:55:00 -07: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 api-docs: Update descriptive uses of "stream" for channel rename. 2024-05-20 09:31:56 -07:00
running-bots.md api-docs: Add comma to all uses of "e.g." in API docs. 2024-07-05 15:36:24 -07:00
send-message.md api-docs: Update descriptive uses of "stream" for channel rename. 2024-05-20 09:31:56 -07:00
sidebar_index.md groups: Pass old setting value for can_mention_group. 2024-05-14 12:17:15 -07:00
writing-bots.md documentation: Modify cases of "[a-zA-Z] e\.g\.," for readability. 2024-07-09 13:41:44 -07:00