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

33 lines
719 B
Markdown
Raw Normal View History

apidocs: Replace hardcoded titles with generated ones. This commit replaces the hardcoded titles of /api pages with the auto-generated ones from the openapi data using the markdown processor.
2021-05-22 13:21:18 +02:00
{generate_api_title(/messages/matches_narrow:get)}
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
{generate_api_description(/messages/matches_narrow:get)}
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/messages/matches_narrow:get|example}
apidocs: Automatically add javascript example tabs. The javascript tab in .md templates can be generated along with the line that adds js example. Further, as a part of the effort of moving towards a single template, the markdown extension for javascrit examples is modified to return empty string if javascript example doesn't exist for that endpoint. This would make it possible to cover more endpoints with a single template. The js example tabs are now automatically generated during generation of javascript code, and so need to be removed. Also, the markdown function to render js examples can be added in all templates, since it is parses and returns an empty string if the examples don't exist, and allows us to move towards a common template. The pages have been verified to be correct by using diff between old and new pages' raw HTML.
2021-06-02 18:36:25 +02:00
{generate_code_example(javascript)|/messages/matches_narrow:get|example}
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
{tab|curl}
{generate_code_example(curl)|/messages/matches_narrow:get|example}
{end_tabs}
## Arguments
{generate_api_arguments_table|zulip.yaml|/messages/matches_narrow:get}
## Response
{generate_return_values_table|zulip.yaml|/messages/matches_narrow:get}
#### Example response
{generate_code_example|/messages/matches_narrow:get|fixture(200)}
apidocs: Fix response in API templates. Now, the descriptions and all subschemas are directly returned just by `generate_code_example`, and so, these individual subschemas and descriptions can be removed from the templates. All API endpoints docs are exactly the same after the change, except few where missing 400 responses got added due to the modification
2021-06-07 22:53:29 +02:00
{generate_code_example|/messages/matches_narrow:get|fixture(400)}