Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/templates/zerver/api/get-messages.md

47 lines
1.1 KiB
Markdown
Raw Normal View History

api docs: Document the GET /messages endpoint.
2018-06-23 17:31:12 +02:00
# Get messages
openapi: Use description markdown for rendering endpoint descriptions. Firstly, change endpoint descriptions in zulip.yaml so that they match their counterpart in the api docs. Then edit the api docs so that they use api description markdown extension for displaying endpoint description.
2020-04-28 20:00:46 +02:00
{generate_api_description(/messages:get)}
api docs: Document the GET /messages endpoint.
2018-06-23 17:31:12 +02:00
## Usage examples
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{start_tabs}
{tab|python}
api docs: Document the GET /messages endpoint.
2018-06-23 17:31:12 +02:00
{generate_code_example(python)|/messages:get|example}
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{tab|js}
api docs: Document the GET /messages endpoint.
2018-06-23 17:31:12 +02:00
More examples and documentation can be found [here](https://github.com/zulip/zulip-js).
js_examples: Migrate and test get_messages example.
2020-06-21 21:46:53 +02:00
{generate_code_example(javascript)|/messages:get|example}
api docs: Document the GET /messages endpoint.
2018-06-23 17:31:12 +02:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{tab|curl}
api: Document new get_messages oldest/newest API feature. While we're at it, we make the examples more sensible.
2020-01-29 02:58:17 +01:00
{generate_code_example(curl, exclude=["client_gravatar", "apply_markdown", "use_first_unread_anchor"])|/messages:get|example}
api docs: Document the GET /messages endpoint.
2018-06-23 17:31:12 +02:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{end_tabs}
api docs: Document the GET /messages endpoint.
2018-06-23 17:31:12 +02:00
openapi_docs: Replace `argument` with `parameter`. The term `parameter` is a better word than `argument` for data passed to an API endpoint; this is why OpenAPI uses in their terminology. Replace `argument` with `parameter` in the API docs to improve their readability. Fixes #15435.
2020-06-18 15:35:25 +02:00
## Parameters
api docs: Document the GET /messages endpoint.
2018-06-23 17:31:12 +02:00
{generate_api_arguments_table|zulip.yaml|/messages:get}
## Response
#### Return values
When a request is successful, this endpoint returns a dictionary
containing the following (in addition to the `msg` and `result` keys
present in all Zulip API responses).
openapi: Add markdown extension for rendering return values in API docs. Currently response return values have to be written twice, once in the docs and once in zulip.yaml. Create a markdown extension so that the return values in api docs are rendered using content from zulip.yaml
2020-05-20 11:57:57 +02:00
{generate_return_values_table|zulip.yaml|/messages:get}
api docs: Document the GET /messages endpoint.
2018-06-23 17:31:12 +02:00
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/messages:get|fixture(200)}
[status-messages]: /help/format-your-message-using-markdown#status-messages
refactor: Rename filter to linkifier in frontend code and docs. This only leaves `page_params.realm_filters`, which will be changed in further commits along with the API change.
2021-03-13 18:15:14 +01:00
[linkifiers]: /help/add-a-custom-linkifier
docs: Provide link to available message flags from get-messages.
2019-06-04 13:02:35 +02:00
[message-flags]: /api/update-message-flags#available-flags