Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/api_docs/include/rest-endpoints.md

120 lines
4.8 KiB
Markdown
Raw Normal View History

/api: Move list of REST endpoints to a template.
2018-04-17 00:49:37 +02:00
#### Messages
api docs: Merge docs for sending stream and private messages.
2018-06-18 17:44:48 +02:00
* [Send a message](/api/send-message)
API: Reorganize message section of endpoints index a bit.
2018-08-08 18:42:26 +02:00
* [Upload a file](/api/upload-file)
api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
* [Edit a message](/api/update-message)
api docs: Document the DELETE /messages/<message_id> endpoint.
2018-06-26 16:30:46 +02:00
* [Delete a message](/api/delete-message)
api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
* [Get messages](/api/get-messages)
api docs: Add guide for creating narrows. Dramatically edited by tabbott to simplify the discussion and duplication of content in our main search documentation.
2018-06-23 16:28:00 +02:00
* [Construct a narrow](/api/construct-narrow)
api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
* [Add an emoji reaction](/api/add-reaction)
* [Remove an emoji reaction](/api/remove-reaction)
* [Render a message](/api/render-message)
api: Send full message in GET /messages/{message_id} response. Previously, this URL just returned the `raw_content` field. It seems cleanest to just make it a single-message variant of GET /messages, deprecating the only format.
2022-03-02 05:33:20 +01:00
* [Fetch a single message](/api/get-message)
apidocs: Fix messages match narrow URL. The operationId was clearly a better label.
2021-05-27 02:30:29 +02:00
* [Check if messages match narrow](/api/check-messages-match-narrow)
api docs: Document the GET /messages/<message_id>/history endpoint.
2018-06-27 22:54:08 +02:00
* [Get a message's edit history](/api/get-message-history)
api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
* [Update personal message flags](/api/update-message-flags)
message_flags: Allow updating flags by narrows and anchors. Fixes #22893. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-11-10 01:06:37 +01:00
* [Update personal message flags for narrow](/api/update-message-flags-for-narrow)
api_docs: Split bulk mark read documentation to individual pages. There was no particular reason for this to be the single page that documented multiple API endpoints, and splitting it fixes a duplicate ID parameter-stream_id. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-08-21 23:52:16 +02:00
* [Mark all messages as read](/api/mark-all-as-read)
* [Mark messages in a stream as read](/api/mark-stream-as-read)
* [Mark messages in a topic as read](/api/mark-topic-as-read)
read_receipts: Add support for displaying read receipts. Adds an API endpoint for accessing read receipts for other users, as well as a modal UI for displaying that information. Enables the previously merged privacy settings UI for managing whether a user makes read receipts data available to other users. Documentation is pending, and we'll likely want to link to the documentation with help_settings_link once it is complete. Fixes #3618. Co-authored-by: Tim Abbott <tabbott@zulip.com>
2021-06-16 21:15:47 +02:00
* [Get a message's read receipts](/api/get-read-receipts)
/api: Move list of REST endpoints to a template.
2018-04-17 00:49:37 +02:00
api-docs: Document create/edit scheduled message endpoint and events. Adds API changelog update for the new endpoint added for creating or editing scheduled messages, for the events sent for scheduled messages (add, update, delete), and for the `scheduled_messages` field in the register response. Adds a specific API markdown documentation file for the create or update scheduled messages endpoint, so that the parameters in the cURL examples are accurate for the type of message (direct or stream) and action (create or edit). Bumps the API feature level, adds Changes notes to API documentation and adds the scheduled message endpoints to the API documentation sidebar.
2023-04-28 13:39:48 +02:00
#### Scheduled messages
* [Get scheduled messages](/api/get-scheduled-messages)
scheduled-messages: Add API documentation for new endpoint. Part of splitting creating and editing scheduled messages. Final commit. Should be merged with previous commits in series. Updates the API documentation for the new endpoint for editing scheduled messages.
2023-05-16 21:20:49 +02:00
* [Create a scheduled message](/api/create-scheduled-message)
* [Edit a scheduled message](/api/update-scheduled-message)
api-docs: Document create/edit scheduled message endpoint and events. Adds API changelog update for the new endpoint added for creating or editing scheduled messages, for the events sent for scheduled messages (add, update, delete), and for the `scheduled_messages` field in the register response. Adds a specific API markdown documentation file for the create or update scheduled messages endpoint, so that the parameters in the cURL examples are accurate for the type of message (direct or stream) and action (create or edit). Bumps the API feature level, adds Changes notes to API documentation and adds the scheduled message endpoints to the API documentation sidebar.
2023-04-28 13:39:48 +02:00
* [Delete a scheduled message](/api/delete-scheduled-message)
drafts: Add API documentation for the core drafts endpoints. These were added at some point in the past, but were not complete, and it makes sense to document the current feature level as and when they become available, since clients should not use the drafts endpoints on older feature levels.
2021-02-14 12:56:14 +01:00
#### Drafts
* [Get drafts](/api/get-drafts)
* [Create drafts](/api/create-drafts)
* [Edit a draft](/api/edit-draft)
* [Delete a draft](/api/delete-draft)
/api: Move list of REST endpoints to a template.
2018-04-17 00:49:37 +02:00
#### Streams
openapi: Make api-docs filename match with operationIds. api docs filenames are basically the operationId of their endpoint in zulip.yaml with `_` replaced by `-`. But some operationIds have changed, so change the affected filenames. Make changes in other files accordingly.
2020-06-11 14:44:00 +02:00
* [Get subscribed streams](/api/get-subscriptions)
api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
* [Subscribe to a stream](/api/subscribe)
* [Unsubscribe from a stream](/api/unsubscribe)
api: Add GET /users/{user_id}/subscription/{stream_id} endpoint. This new endpoint returns a 'user' dictionary which, as of now, contains a single key 'is_subscribed' with a boolean value that represents whether the user with the given 'user_id' is subscribed to the stream with the given 'stream_id'. Fixes #14966.
2020-05-31 19:10:41 +02:00
* [Get subscription status](/api/get-subscription-status)
openapi: Document get-subscribers endpoint.
2021-07-25 20:28:54 +02:00
* [Get all subscribers](/api/get-subscribers)
api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
* [Update subscription settings](/api/update-subscription-settings)
* [Get all streams](/api/get-streams)
streams: Add endpoint "GET /streams/{stream_id}" to get stream by id. Fixes #22082.
2022-05-18 13:54:35 +02:00
* [Get a stream by ID](/api/get-stream-by-id)
api docs: Move "Get stream ID" to end of the streams endpoint section. This seemed overally emphasized in the previous order.
2018-07-27 00:42:58 +02:00
* [Get stream ID](/api/get-stream-id)
api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
* [Create a stream](/api/create-stream)
api_docs: Add documentation for update_stream.
2019-06-23 14:38:28 +02:00
* [Update a stream](/api/update-stream)
streams: Use "archive stream" phrasing instead of "delete stream". The previous phrasing was misleading in relation to what the action actually does.
2021-03-31 16:15:24 +02:00
* [Archive a stream](/api/archive-stream)
rest-endpoints: Add new /api/get-stream-email-address endpoint.
2023-11-16 20:34:59 +01:00
* [Get stream's email address](/api/get-stream-email-address)
api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
* [Get topics in a stream](/api/get-stream-topics)
* [Topic muting](/api/mute-topic)
user_topics: Add a new endpoint to update visibility_policy. This commit adds a new endpoint, 'POST /user_topics' which is used to update the personal preferences for a topic. Currently, it is used to update the visibility policy of a user-topic row.
2023-03-31 21:18:12 +02:00
* [Update personal preferences for a topic](/api/update-user-topic)
openapi: Document delete-topic endpoint.
2021-07-25 22:20:15 +02:00
* [Delete a topic](/api/delete-topic)
api: Document /default_streams API endpoint.
2022-08-01 15:33:11 +02:00
* [Add a default stream](/api/add-default-stream)
* [Remove a default stream](/api/remove-default-stream)
/api: Move list of REST endpoints to a template.
2018-04-17 00:49:37 +02:00
#### Users
openapi: Make api-docs filename match with operationIds. api docs filenames are basically the operationId of their endpoint in zulip.yaml with `_` replaced by `-`. But some operationIds have changed, so change the affected filenames. Make changes in other files accordingly.
2020-06-11 14:44:00 +02:00
* [Get all users](/api/get-users)
api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
* [Get own user](/api/get-own-user)
api: Document GET ../users/{user_id} endpoint. This adds get_single_user to python_examples.py in zerver/openapi. This also adds get-single-user.md to templates/zerver/api and adds get-single-user to rest-endpoints.md (templates/zerver/help/include).
2020-02-14 21:39:12 +01:00
* [Get a user](/api/get-user)
api: Add REST API endpoint for looking up a user by email address. Add new rest api endpoint GET users/{email} for looking up a user by email, which is useful especially for corporate API applications that might already have a user's email address. Fixes #14302.
2021-01-02 15:05:29 +01:00
* [Get a user by email](/api/get-user-by-email)
api: Document PATCH ../users/{user_id} endpoint. This adds update_user to python_examples.py in zerver/openapi. This also adds update-user.md to templates/zerver/api and adds update-user to rest-endpoints.md (templates/zerver/help/include).
2020-02-14 22:13:01 +01:00
* [Update a user](/api/update-user)
openapi: Document update-status endpoint.
2021-07-26 17:34:02 +02:00
* [Update your status](/api/update-status)
/api: Move list of REST endpoints to a template.
2018-04-17 00:49:37 +02:00
* [Create a user](/api/create-user)
api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
* [Deactivate a user](/api/deactivate-user)
* [Reactivate a user](/api/reactivate-user)
api docs: Add documentation of deactivate-own-user endpoint. Currently, there was no markdown page for deactivate-own-user API endpoint. Created deactivate-own-user.md for the API page and created a new owner client in test-api to reactivate the client deactivated during testing. Also changed endpoint name from deactivate-my-account to deactivate-own-user, for better consistency with other endpoints. Fixes #16163.
2021-01-05 18:09:03 +01:00
* [Deactivate own user](/api/deactivate-own-user)
openapi: Make api-docs filename match with operationIds. api docs filenames are basically the operationId of their endpoint in zulip.yaml with `_` replaced by `-`. But some operationIds have changed, so change the affected filenames. Make changes in other files accordingly.
2020-06-11 14:44:00 +02:00
* [Set "typing" status](/api/set-typing-status)
* [Get user presence](/api/get-user-presence)
api-docs: Revise areas of documentation re: user presence objects. Updates documentation to include information about user presence objects with `aggregated` key (instead of the user's email) where appropriate. Also, cleans up spelling, grammar and formatting errors in the descriptive text for these objects / endpoints.
2022-08-01 13:29:58 +02:00
* [Get presence of all users](/api/get-presence)
api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
* [Get attachments](/api/get-attachments)
openapi: Document remove-attachment endpoint.
2021-07-30 11:58:11 +02:00
* [Delete an attachment](/api/remove-attachment)
settings: Merge settings API endpoints. This API change removes unnecessary complexity from a client that wants to change a user's personal settings, and also saves developers from needing to make decisions about what sort of setting something is at the API level. We preserve the old settings endpoints as mapping to the same function as the new one for backwards-compatibility. We delete the documentation for the old endpoints, though the documentation for the merged /settings endpoint mentions how to use the old endpoints when needed. We migrate all backend tests to the new endpoints, except for individual tests for each legacy endpoint to verify they still work. Co-authored-by: sahil839 <sahilbatra839@gmail.com>
2021-07-07 22:08:11 +02:00
* [Update settings](/api/update-settings)
api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
* [Get user groups](/api/get-user-groups)
api_docs: Add documentation for create_user_group.
2019-06-24 22:27:06 +02:00
* [Create a user group](/api/create-user-group)
api_docs: Add documentation for update_user_group.
2019-06-25 21:43:53 +02:00
* [Update a user group](/api/update-user-group)
openapi: Make api-docs filename match with operationIds. api docs filenames are basically the operationId of their endpoint in zulip.yaml with `_` replaced by `-`. But some operationIds have changed, so change the affected filenames. Make changes in other files accordingly.
2020-06-11 14:44:00 +02:00
* [Delete a user group](/api/remove-user-group)
api docs: Document POST /user_groups/{group_id}/members endpoint.
2020-07-15 14:50:48 +02:00
* [Update user group members](/api/update-user-group-members)
user_groups: Add API endpoint for updating subgroups of a user group.
2022-03-02 11:58:37 +01:00
* [Update user group subgroups](/api/update-user-group-subgroups)
user_groups: Add endpoint to check whether a user is member of a group. This commit adds 'GET /user_groups/{id}/members/{id}' endpoint to check whether a user is member of a group. This commit also adds for_read parameter to access_user_group_by_id, which if passed as True will provide access to read user group even if it a system group or if non-admin acting user is not part of the group.
2022-03-18 14:38:11 +01:00
* [Get user group membership status](/api/get-is-user-group-member)
user_groups: Add API endpoint to get members of a user group. This commit adds 'GET /user_groups/{user_group_id}/members' endpoint to get members of a user group. "direct_member_only" parameter can be passed as True to the endpoint to get only direct members of the user group and not the members of subgroup.
2022-03-24 11:39:57 +01:00
* [Get user group members](/api/get-user-group-members)
user_groups: Add API endpoint to get subgroups of a user group.
2022-04-04 13:59:25 +02:00
* [Get subgroups of user group](/api/get-user-group-subgroups)
mute user: Add backend infrastructure code. Adds backend code for the mute users feature. This is just infrastructure work (database interactions, helpers, tests, events, API docs etc) and does not involve any behavioral/semantic aspects of muted users. Adds POST and DELETE endpoints, to keep the URL scheme mostly consistent in terms of `users/me`. TODOs: 1. Add tests for exporting `zulip_muteduser` database table. 2. Add dedicated methods to python-zulip-api to be used in place of the current `client.call_endpoint` implementation.
2021-03-27 12:23:32 +01:00
* [Mute a user](/api/mute-user)
* [Unmute a user](/api/unmute-user)
api: Document /users/me/alert_words API endpoint.
2022-07-27 19:30:03 +02:00
* [Get all alert words](/api/get-alert-words)
* [Add alert words](/api/add-alert-words)
* [Remove alert words](/api/remove-alert-words)
/api: Move list of REST endpoints to a template.
2018-04-17 00:49:37 +02:00
api docs: Document POST /realm/filters.
2018-08-14 02:54:36 +02:00
#### Server & organizations
openapi: Make api-docs filename match with operationIds. api docs filenames are basically the operationId of their endpoint in zulip.yaml with `_` replaced by `-`. But some operationIds have changed, so change the affected filenames. Make changes in other files accordingly.
2020-06-11 14:44:00 +02:00
* [Get server settings](/api/get-server-settings)
api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
* [Get linkifiers](/api/get-linkifiers)
* [Add a linkifier](/api/add-linkifier)
linkifiers: Add an API to support the editing of linkifier. This commit adds an API to `zproject/urls.py` to edit/update the realm linkifier. Its helper function to update the database is added in `zerver/lib/actions.py`. `zulip.yaml` is documented accordingly as well, clearly stating that this API updates one linkifier at a time. The tests are added for the API and helper function which updates the realm linkifier. Fixes #10830.
2021-04-15 19:51:36 +02:00
* [Update a linkifier](/api/update-linkifier)
api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
* [Remove a linkifier](/api/remove-linkifier)
linkifier: Support reordering linkifiers. This adds API support to reorder linkifiers and makes sure that the returned lists of linkifiers from `GET /events`, `POST /register`, and `GET /realm/linkifiers` are always sorted with the order that they should processed when rendering linkifiers. We set the new `order` field to the ID with the migration. This preserves the order of the existing linkifiers. New linkifiers added will always be ordered the last. When reordering, the `order` field of all linkifiers in the same realm is updated, in a manner similar to how we implement ordering for `custom_profile_fields`.
2023-08-10 04:09:25 +02:00
* [Reorder linkifiers](/api/reorder-linkifiers)
apidocs: Fix playground URLs and operationIDs. We standardized on "Code playground" for this feature, so use that in the URLs and API documentation.
2021-05-23 10:04:50 +02:00
* [Add a code playground](/api/add-code-playground)
* [Remove a code playground](/api/remove-code-playground)
openapi: Make api-docs filename match with operationIds. api docs filenames are basically the operationId of their endpoint in zulip.yaml with `_` replaced by `-`. But some operationIds have changed, so change the affected filenames. Make changes in other files accordingly.
2020-06-11 14:44:00 +02:00
* [Get all custom emoji](/api/get-custom-emoji)
api docs: Document the custom emoji upload endpoint. Tweaked by tabbott to fix some English phrasing and make the file pointer thing require less Python knowledge. Fixes: #10746.
2018-12-12 19:49:14 +01:00
* [Upload custom emoji](/api/upload-custom-emoji)
docs: Add documentation for delete emoji endpoint. This endpoint was previously marked as `intentionally_undocumented` but that was mistake. Removed `intentionally_undocumented` and added proper documentation with valid `python_example` for this Endpoint. Fixes: #24084
2023-01-25 08:29:51 +01:00
* [Deactivate custom emoji](/api/deactivate-custom-emoji)
api docs: Document GET /realm/profile_fields endpoint.
2020-07-03 17:57:22 +02:00
* [Get all custom profile fields](/api/get-custom-profile-fields)
api docs: Document PATCH /realm/profile_fields endpoint.
2020-07-04 13:09:52 +02:00
* [Reorder custom profile fields](/api/reorder-custom-profile-fields)
api docs: Document POST /realm/profile_fields api endpoint.
2020-07-04 18:43:57 +02:00
* [Create a custom profile field](/api/create-custom-profile-field)
documentation_api: Deduplicate ignored_parameters_unsupported. Created a schema for the ignored_parameters_unsupported that is returned by the /settings and /realm/user_settings_defaults endpoints and removed the duplicated text in the api documentation. Also cleaned up some small errors in the /realm/user_settings_default definition and sidebar link /api/update-realm-user-settings-defaults. Fixes #19674
2021-10-20 14:51:12 +02:00
* [Update realm-level defaults of user settings](/api/update-realm-user-settings-defaults)
api docs: Document GET /server_settings.
2018-08-11 15:50:56 +02:00
api: Improve documentation for real-time-events API.
2018-04-28 00:29:47 +02:00
#### Real-time events
api docs: Document the /dev_fetch_api_key endpoint.
2018-06-21 15:23:10 +02:00
api: Improve documentation for real-time-events API.
2018-04-28 00:29:47 +02:00
* [Real time events API](/api/real-time-events)
api: Document the /register API with a lot more detail.
2018-04-28 02:01:41 +02:00
* [Register an event queue](/api/register-queue)
openapi: Make api-docs filename match with operationIds. api docs filenames are basically the operationId of their endpoint in zulip.yaml with `_` replaced by `-`. But some operationIds have changed, so change the affected filenames. Make changes in other files accordingly.
2020-06-11 14:44:00 +02:00
* [Get events from an event queue](/api/get-events)
api: Document the /register API with a lot more detail.
2018-04-28 02:01:41 +02:00
* [Delete an event queue](/api/delete-queue)
api docs: Document the /dev_fetch_api_key endpoint.
2018-06-21 15:23:10 +02:00
#### Specialty endpoints
api_docs: Document the /fetch-api-key endpoint. With tweaks by tabbott to document addition details. Fixes: #16408.
2020-10-03 02:40:10 +02:00
* [Fetch an API key (production)](/api/fetch-api-key)
* [Fetch an API key (development only)](/api/dev-fetch-api-key)