zulip

Commit Graph

Author	SHA1	Message	Date
orientor	4d8c988ef2	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 12:57:19 -07:00
Vishnu KS	519b24061d	docs: Update the response schema of get-presence. The response no longer contains pushable and client keys.	2019-10-15 15:53:03 -07:00
Vishnu KS	503e65079a	docs: Make get-presence use curl example system.	2019-10-15 15:53:03 -07:00
Hemanth V. Alluri	ffd2bccd4e	openapi: Standardize URL format to use {var_name} syntax. The previous code for the validator test was fairly messy due to checking for both formats of the openapi url, one with <variable_name> and the other with {variable_name}. To eliminate this, we have standardized the format and restricted it to {variable_name} as per the official format at: https://swagger.io/docs/specification/describing-parameters.	2019-07-11 11:01:40 -07:00
Eeshan Garg	cecea75457	api_docs: Detect missing arguments in curl examples. This commit adds automated tests that make sure that every curl example command in our API docs has the '-X (POST\|GET)' argument. Fixes: #11927	2019-05-28 16:53:48 -07:00
Sameer Choubey	bde8b40473	api_docs: Add explicit '-X GET' to curl examples. When passing arguments with the `-d` syntax, which is convenient for command-line examples, one needs to specify `-X GET` for curl to work properly. Fixes #12116	2019-04-17 12:08:35 -07:00
Eeshan Garg	0817905480	api docs: Use Markdown extension for tabbed sections.	2018-09-18 13:49:34 -07:00
Yago González	ea10f5eb2c	api docs: Document GET /users/<email>/presence. Tweaked by tabbott to describe more clearly what this is for.	2018-08-31 15:15:54 -07:00

8 Commits