Commit Graph

16 Commits

Author SHA1 Message Date
Nick Dickey 6ac13a0f0d docs: Document /messages API endpoint. 2017-05-24 11:41:49 -07:00
Brian Tenazas 9d485a0415 docs: Document /streams API endpoint. 2017-05-23 20:37:51 -07:00
Yago González 9f329f6597 docs: Fix JsonSuccess and JsonError models. 2017-05-23 20:37:51 -07:00
Yago González b668b869c1 docs: Improve /messages/{message_id} PATCH. 2017-05-23 20:32:46 -07:00
Yago González 90301a4d93 docs: Fix indentation in lines started with a hyphen. 2017-05-23 20:30:21 -07:00
Yago González 1fc1cafd6f docs: Make Swagger "require" fields uniform.
As the Swagger specification indicates, whether the properties inside a
model are required or not must be defined inside a separate "required"
field at the root of the model.

For fields like "parameters", that has to be specified inside each
parameter's key.
2017-05-23 20:30:21 -07:00
Yago González fa081146d1 docs: Remove unnecessary "produces" keys. 2017-05-23 20:30:21 -07:00
Yago González 735fc5e0cd docs: Remove unnecessary ErrorModel definition. 2017-05-23 20:30:21 -07:00
Yago González 4bb1c566a9 docs: Remove "optional" notes in descriptions. 2017-05-23 20:30:21 -07:00
Yago González d56ec79dd9 docs: Create JsonSuccess and JsonError definitions. 2017-05-23 20:30:21 -07:00
Ryan Backman 973b18bf2f docs: Document messages/{message_id}. 2017-05-23 15:01:26 -07:00
Yago González 15da8d19e7 docs: Update API authentication definitions. 2017-05-23 12:35:41 -07:00
Ryan Backman 3d54607788 docs: Document user_upload. 2017-05-22 18:24:26 -07:00
Josiah Philipsen df7eaa8868 docs: Document user presence endpoint. 2017-05-22 18:18:20 -07:00
Josiah Philipsen d72c961ab2 zulip.yaml: Change unexpected error with proper results.
The error message under "Unexpected errors" was not the format we
received for any errors. We changed it to be msg and result to fit
with the results we got when for standard Zulip JSON errors.
2017-05-22 14:42:48 -07:00
Yago González f9f00374d6 api: Add Swagger YAML file.
Authored-By: Andrea Longo
2017-05-22 10:29:24 -07:00