ea7ce7e0da
api docs: Ensure consistent formatting for arguments.json.
...
Ideally, there should be a space after every `:`.
Note that the JSON isn't displayed as is but is formatted as an
HTML table.
2018-03-02 09:44:17 -08:00
ce56ee80e7
api_docs: Document the `POST /api/v1/user_uploads` endpoint.
...
Fixes #1353 .
2018-03-02 09:44:17 -08:00
a14b52ef1d
api docs: Document the `DELETE /users/me/subscriptions` endpoint.
...
Note that there is currently no JavaScript method in zulip-js
to call this endpoint.
2018-01-12 07:30:38 -05:00
1b3b907694
delete-queue.md: Specify queue_id as a required argument.
...
Specifying it as an optional one was a mistake.
2018-01-12 07:30:38 -05:00
8c723e8c27
api docs: Document the POST /api/v1/users endpoint.
...
Note that there is no JavaScript equivalent for requesting this
endpoint in zulip-js yet.
2018-01-12 07:30:38 -05:00
a01f8c088a
api docs: Document the POST /api/v1/users/me/subscriptions endpoint.
...
There is a JavaScript equivalent for this endpoint but the npm
package has not yet been released.
2018-01-07 15:19:51 -05:00
045aacbc67
api docs: Document the PATCH /api/v1/messages/<msg_id> endpoint.
...
Note that there is no JavaScript equivalent for requesting this
endpoint in zulip-js yet.
2018-01-07 15:19:51 -05:00
6f01b042a1
api docs: Document the DELETE /api/v1/events endpoint.
...
Note that there is no JavaScript equivalent for requesting this
endpoint in zulip-js yet.
2018-01-07 15:19:51 -05:00
1fd71287d6
api docs: Document the GET /api/v1/events endpoint.
2018-01-04 10:17:29 -05:00
f620525373
api docs: Document the POST /api/v1/register endpoint.
2018-01-03 12:23:30 -05:00
b73c60a135
api docs: Document the GET /api/v1/users endpoint.
2017-12-30 11:03:23 -05:00
b31bdf23ca
api docs: Document the POST /api/v1/messages/render endpoint.
...
Note that currently, there is no way to interface with this
endpoint using zulip-js.
2017-12-30 11:03:23 -05:00
cf8a8c8811
api docs: Document the GET /api/v1/get_stream_id endpoint.
...
This commit documents the /api/v1/get_stream_id endpoint.
Note that there is currently no way to interface with this
endpoint with zulip-js.
2017-12-30 11:03:23 -05:00
e769a7eed2
api docs: Document the get-streams endpoint.
...
This commit documents the get-streams endpoint, which can be
by making a GET request to /api/v1/streams.
Note that in the code examples, JavaScript is missing an example
for how to pass in the `include_` query parameters. That is
because zulip-js's client.streams.retrieve function doesn't take
any arguments and zulip-js does not export any function equivalent
to client.call_endpoint in python-zulip-api/zulip.
2017-12-29 17:03:36 -05:00
89f622937d
api docs: Generate Arguments table from JSON.
...
This commit does the following:
* Move the Arguments table data from stream-message.md and
private-message.md to a JSON file.
* Add a Markdown extension that allows one to include and render
a table from a JSON file like so:
{generate_arguments_table|arguments.json|private-stream.md}
* Use Bootstrap's .table class to format the table instead of
relying on custom CSS.
2017-12-29 17:03:36 -05:00
Eeshan Garg