Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
18,957 Commits 28 Branches 143 Tags 627 MiB
Commit Graph

11 Commits

Author SHA1 Message Date
Yago González 1324596cdd docs: Document /streams/{stream_id} API endpoint. 2017-06-27 08:33:56 -04:00
Yago González b18a4e7371 docs: Remove unnecessary type declaration. 2017-06-27 08:33:56 -04:00
Yago González 33e4855306 lint: Ban non-unique operationIds in Swagger. 
The Swagger specification indicates that all operationId values should be
unique. However, SwaggerParser doesn't complain during validation if that
doesn't happen, so this commit adds our own method to identify these
cases.

Also, the violations of this rule have been fixed.
 2017-06-26 22:02:26 -04:00
Yago González 05f1992503 docs: Document /get_stream_id API endpoint. 2017-06-26 09:02:49 -04:00
Yago González 550350c27f docs: Document /dev_fetch_api_key API endpoint. 2017-06-25 12:23:10 -04:00
Yago González 1c3b0a8b03 docs: Document /fetch_api_key API endpoint. 2017-06-25 12:23:10 -04:00
Yago González 30e8a04596 docs: Amend definitions of JSON responses. 2017-06-25 12:23:10 -04:00
Yago González 29fa89273e docs: Fix formatting in the Swagger YAML file. 2017-06-25 12:23:10 -04:00
Yago González 687acf89a6 docs: Sort REST API endpoints alphabetically. 2017-06-25 12:23:10 -04:00
Feorlen 7124098a8e Explain how to add Swagger REST API doc coverage in zulip.yaml. 
Introduce Swagger UI and the Swagger/OpenAPI specification. Explain
the structure of zulip.yaml and show examples of different sections
of the file.

This is a new file in /docs not yet included in the Read the Docs
table of contents. Where it should go should be determined as we iterate
on the Swagger UI integration and expand REST API doc coverage using it.

For more on Swagger UI and how Zulip uses it, see:
https://github.com/zulip/zulip/issues/3474
https://github.com/zulip/zulip/pull/3397

With some minor tweaks to advertise this by tabbott.
 2017-06-07 22:46:20 -07:00
Yago González 7225b7bdf8 docs: Move Swagger file to static/swagger. 2017-06-03 15:45:15 -07:00