1651 Commits

Author SHA1 Message Date
Alex Vandiver
326c7d6383 openapi: Link server_thumbnail_formats to image formatting docs. 2025-10-20 10:10:24 -07:00
Alex Vandiver
24437963e2 openapi: Fix typo. 2025-10-20 10:09:55 -07:00
Anders Kaseorg
b742ab18f9 emoji: Remove setting for deprecated Google blobs emoji set.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-10-01 13:35:06 -07:00
Alex Vandiver
d17851a3ed openapi: Remove a debugging statement. 2025-10-01 11:21:34 -07:00
Lauryn Menard
06daab7174 api-docs: Add realm_can_delete_any_message_group content access note.
Users in this user group must also have content access to the message
in order to permanently delete it.
2025-09-29 11:06:40 -07:00
Lauryn Menard
b7815d9e2a api-docs: Update delete-messages description for current permissions.
Prior to feature level 281, the only users who had permissions to
permanently delete any message in the organization were organization
administrators.

Currently, various realm and channel permission settings, which use
the user group model, determine if a user is able to permanently
delete a specific message.

Updates the main description of the endpoint to note these settings
and removes the note that the endpoint is limited to organization
administrators.
2025-09-29 11:06:40 -07:00
Sahil Batra
1e21f7b224 register: Rename stream_creator_or_nobody to channel_creator.
This commit renames `stream_creator_or_nobody` value for
`default_group_name` field in `server_supported_permission_settings`
object to `channel_creator`.
2025-09-23 12:12:23 -07:00
Sahil Batra
8c7628fbc4 openapi: Improve description for default_group_name field.
This commit updates the description for `default_group_name`
field in `server_supported_permission_settings` object to
clearly mention that `stream_creator_or_nobody` is one of
the possible values and explain its meaning.
2025-09-23 12:04:07 -07:00
Sahil Batra
a9afe1becf openapi: Improve description for channel creator.
This commit updates description for channel creator field
`creator_id` to mention that it can be null for channels
created during realm creation.
2025-09-23 12:04:07 -07:00
Shubham Padia
468a7a82dd help: Do not treat Help Center as a proper noun.
Fixes https://chat.zulip.org/#narrow/channel/101-design/topic/help.20center.20capitalization
2025-09-17 13:20:25 -07:00
Anders Kaseorg
8a35871217 events: Remove realm_is_zephyr_mirror_realm from API.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-09-16 11:23:10 -07:00
Anders Kaseorg
40a022dcc3 zephyr: Remove Zephyr mirroring support.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2025-09-16 11:18:18 -07:00
Alex Vandiver
74b07740b0 openapi: Make example UUID be a UUID. 2025-09-08 11:47:03 -07:00
Prakhar Pratyush
e64be0c48b api_docs: Deprecate 'remove-fcm-token' & 'remove-apns-token'.
Endpoints marked deprecated:
* `DELETE /users/me/apns_device_token`
* `DELETE /users/me/android_gcm_reg_id`

These endpoints were for non-E2EE push notification case.

Fixes #35213.
2025-09-04 09:20:02 -07:00
Karl Stolley
41e8d79e00 api_docs: Update get-file-temporary-url endpoint and add to sidebar.
Co-authored-by: Lauryn Menard <lauryn@zulip.com>
2025-08-29 10:21:42 -07:00
Sahil Batra
6e17b05156 openapi: Mark server_supported_permission_settings field as stable.
We have mostly decided on the structure of the group permission
setting object in server_supported_permission_settings field of
register response, so this commit removes the comment mentioning
it as unstable and adds the corresponding "Changes" entry.
2025-08-29 10:20:28 -07:00
Lauryn Menard
f5587e9ffe api-docs: Revise update_message changes notes for feature level 114. 2025-08-29 10:00:44 -07:00
Prakhar Pratyush
e8c9f4a811 api_docs: Deprecate the non-E2EE register push device endpoints.
Endpoints marked deprecated:
* /users/me/apns_device_token
* /users/me/android_gcm_reg_id

The older endpoints were for non-E2EE push notification case.

Fixes part of #35213.
2025-08-28 16:45:51 -07:00
Prakhar Pratyush
b157b14d76 api_docs: Mark /mobile_push/test_notification as deprecated.
The older endpoint was for non-E2EE push notification case.

Fixes part of #35213.
2025-08-28 16:45:51 -07:00
Prakhar Pratyush
f52533795b api_docs: Document /remotes/push/e2ee/register endpoint.
This commit documents the `/remotes/push/e2ee/register` endpoint.

We use auth_email="ZULIP_ORG_ID" and auth_api_key="ZULIP_ORG_KEY"
instead of "BOT_EMAIL_ADDRESS" and "BOT_API_KEY".
2025-08-28 11:46:09 -07:00
Prakhar Pratyush
9785cb4a09 render_curl_example: Remove unused 'auth_email' & 'auth_api_key'.
The 'function' variable in 'APICodeExamplesPreprocessor.generate_text'
matches the pattern of API_ENDPOINT_NAME = r"/[a-z_\-/-{}]+:[a-z]+"

It is always of the form 'endpoint_path:endpoint_method'.

There's no possibility of multiple ':'.

This commit removes the unused code block in `render_curl_example`,
which was trying to get 'auth_email' & 'auth_api_key' from 'function'.
2025-08-28 11:46:09 -07:00
Lauryn Menard
8ee59e9277 api-docs: Revise create channel endpoint documentation. 2025-08-28 10:13:02 -07:00
Lauryn Menard
910ca975ab api-docs: Improve rendering of create channel python example. 2025-08-28 10:13:02 -07:00
Lauryn Menard
224499b58f api-docs: Revise folder_id parameter for adding/updating channels.
Revises the description of the `folder_id` parameters in the
api/create-channel, api/subscribe and api/update-stream endpoints.
2025-08-28 10:13:02 -07:00
Kislay Verma
396f4d004a api_docs: Clarify description for send_new_subscription_messages.
The same subscription request can contain both existing channels
and newly created channels, so we clarify here that direct message
notifications are only sent when users are subscribed to existing
channels.

Also, updates this text to use "direct message" instead of "DM".

Co-authored-by: Lauryn Menard <lauryn@zulip.com>
2025-08-27 17:06:31 -07:00
Lauryn Menard
699c0c6200 create-channel: Remove send_new_subscription_messages parameter.
Removes send_new_subscription_messages parameter from
`POST channel/create` endpoint as Notification Bot DMs
are never sent when users are subscribed as part of
creating a new channel.

Not considered a documentable API change, since the previous parameter
never had any effect, so this is effectively just a documentation and
error-handling bug fix, not an API change relevant to implementors.
2025-08-27 11:12:05 -07:00
Lauryn Menard
6847c5bfdb api-docs: Revise "description" parameter of new channel folder.
This parameter should be marked as required, but allowing an empty
string value. Updates the description of the parameter to be more
explicit of that fact.
2025-08-14 16:51:35 -07:00
Lauryn Menard
a497571be6 api-docs: Use a more realistic example for a new channel folder ID. 2025-08-14 16:51:35 -07:00
Lauryn Menard
1d99e55bb4 api-docs: Revise descriptive text in channel folders endpoints.
Adds links to relevant help center documentation on channel
folders.
2025-08-14 16:51:35 -07:00
Lauryn Menard
4f4923ef2b channel-folders: Create two channel folders in the dev database.
Adds a visible example to the PATCH /channel_folders endpoint for
reordering an organization's channel folders. So that the example
works in a normal dev environment, we also add a second channel
folder when populating the dev database.
2025-08-14 16:51:35 -07:00
Lauryn Menard
451e64b3e6 api-docs: Mark "name" required for new channel folder.
Also, note that an empty string for the "name" parameter, when
creating or updating a channel folder, is not a valid value.
2025-08-14 16:51:35 -07:00
Lauryn Menard
4b0a9e484a api-docs: Mark "order" as required for reodering channel folders. 2025-08-14 16:51:35 -07:00
Lauryn Menard
4b7e0be1ab api-docs: Add admin only notes for channel folder endpoints. 2025-08-14 16:51:35 -07:00
Tim Abbott
25319590d0 api_docs: Fix missing changes entry for status endpoint.
715d07c231 was missing an API feature
level change.
2025-08-13 16:07:27 -07:00
Prakhar Pratyush
3cbf0e70a2 push_notification: Add support to send E2EE test push notification.
This commit adds an endpoint `/mobile_push/e2ee/test_notification`
to send an end-to-end encrypted test push notification to the user's
selected mobile device or all of their mobile devices.
2025-08-13 00:13:50 -07:00
opmkumar
aa9aa2160b help: Clean up search by location documentation. 2025-08-12 15:26:12 -07:00
Vector73
f1d1d5f1a4 events: Add support for sending presence events in modern format.
If the client has passed `simplified_presence_events` as true
in the `client_capabilities` parameter of the `POST /register`
request, then the server will send `presence` events with the
`presences` field, which has the user presence data in the
modern API format. When that client capability is false, the
`presence` event will be unchanged and sent with the user
presence data in the legacy format.
2025-08-12 12:37:54 -07:00
Sahil Batra
5675860707 channel-folders: Send event when reordering channel folders. 2025-08-12 11:17:17 -07:00
Sahil Batra
bcdfcf909d welcome-bot: Only send message with custom text when testing.
We now only send the custom message when using
"Send me a test message" button and not send the
standard welcome bot message.
2025-08-12 00:12:52 -07:00
apoorvapendse
8f14b717ff zerver: Drop support for Zulip API emails in channel creation.
Also write the description a bit better.

Discussion:
https://chat.zulip.org/#narrow/channel/378-api-design/topic/Channel.20creation.20should.20return.20the.20channel.20ID/near/2240040.

Signed-off-by: apoorvapendse <apoorvavpendse@gmail.com>
2025-08-11 23:40:12 -07:00
apoorvapendse
6203861529 zerver: API to create channel.
Fixes #16206.

Co-authored-by: Sahil Batra <sahil@zulip.com>
Co-authored-by: Steve Howell <showell@zulip.com>
Signed-off-by: apoorvapendse <apoorvavpendse@gmail.com>
2025-08-08 19:29:17 -07:00
Saubhagya Patel
bb5c87e306 bots: Add a setting to customize the Welcome Bot message.
This commit includes the following changes:
- Add an administrator setting to customize the Welcome Bot
message when sending an invitation.
- Add an API endpoint to test the customized Welcome Bot message
by sending a copy of the message to the administrator.

Fixes #27663.

Co-authored-by: Akarsh Jain <akarsh.jain.790@gmail.com>
2025-08-08 18:59:37 -07:00
Sahil Batra
f7e9f37edc settings: Fix re-ordering folders when there is an archived folder.
This commit updates webapp code to include archived folder IDs as
well in the "order" list passed when re-ordering folders.

Also, updated API documentation to mention that archived folder IDs
should also be included.
2025-08-08 16:29:00 -07:00
Kislay Verma
f0a88d51cc message_reminders: Add support for notes.
This commit adds the ability for users to include notes
with their message reminders.

Fixes #35070.

Co-Authored-By: Aman Agrawal <amanagr@zulip.com>
2025-08-07 17:13:12 -07:00
Tim Abbott
f177598ecf api: Increment API feature level to 414. 2025-08-06 16:34:40 -07:00
Shubham Padia
c4cb75979a channel-folders: Order by order field in GET method. 2025-08-06 16:34:40 -07:00
Shubham Padia
22b231ab6f channel-folders: Add PATCH method to reorder channel folders.
The test cases are copied from ReorderCustomProfileFieldTest since we
are imitating the reordering mechanism from custom profile fields to
channel folders.
2025-08-06 16:34:40 -07:00
Shubham Padia
40132e200b channel-folders: Add order field and backfill it alphabetically. 2025-08-06 16:34:40 -07:00
Vector73
0ac24bd437 api: Add support for passing partial to include_subscribers parameter.
Fixes #35318.
2025-08-04 18:43:14 -07:00
Lauryn Menard
7a9b78f1f5 settings: Add user setting to ignore channel folders in left sidebar.
Fixes #35573.
2025-08-01 09:18:19 -07:00