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

69 lines
2.5 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)
* [Get a message's raw markdown](/api/get-raw-message)
api docs: Document GET /messages/matches_narrow endpoint. With extensive tweaks from tabbott to provide clear explanations for the features.
2020-03-15 14:16:02 +01:00
* [Check messages match narrow](/api/check-narrow-matches)
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)
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
* [Mark messages as read in bulk](/api/mark-all-as-read)
/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)
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)
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)
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
* [Delete a stream](/api/delete-stream)
* [Get topics in a stream](/api/get-stream-topics)
* [Topic muting](/api/mute-topic)
/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: 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)
/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)
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: 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)
api docs: Document PATCH /settings/notifications. With significant tweaks by tabbott after rebasing.
2018-08-10 02:15:45 +02:00
* [Update notification settings](/api/update-notification-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: 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)
* [Remove a linkifier](/api/remove-linkifier)
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)
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
* [Fetch a development API key](/api/dev-fetch-api-key)