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

77 Commits

Author SHA1 Message Date
Eeshan Garg 96362e8e60 api docs: Move code examples farther up. 2018-01-22 18:10:29 -05:00
Eeshan Garg 668ac28b85 api/sidebar.md: Move "REST API" to the bottom. 2018-01-22 18:10:29 -05:00
Balaji2198 41685105db api/update-message: Make it render correctly in Github. 2018-01-22 15:35:49 -05:00
Balaji2198 992b416802 api/delete-queue: Add Python syntax highlighting. 2018-01-22 15:35:49 -05:00
Steve Howell a5e55cee9b bot docs: Clean up "Testing a bot's output". 
The main cleanup here is to move the examples out of the bulleted
list, which was getting rendered in an ugly/confusing way.

I also removed some redundant text, fixed some typos, and changed
the wording a bit.
 2018-01-18 16:09:24 -05:00
Eeshan Garg a0526206f9 api/delete-queue: Add JavaScript example. 2018-01-17 09:27:35 -05:00
Eeshan Garg af1290fde7 api/get-events-from-queue: Recommend using zuliprc. 
Recommend using a zuliprc file instead of hardcoding the API
credentials in a config object.
 2018-01-17 09:27:35 -05:00
Eeshan Garg 8ed0a0950e api/register-queue: Recommend using zuliprc. 
Recommend using a zuliprc file instead of hardcoding the API
credentials in a config object.
 2018-01-17 09:27:35 -05:00
Eeshan Garg df00e6a45f api/create-user: Add JavaScript example. 2018-01-17 09:27:35 -05:00
Eeshan Garg 0e778e152d api/get-profile: Add JavaScript example. 2018-01-17 09:27:35 -05:00
Eeshan Garg dd88cfac16 api/get-all-users: Recommend using zuliprc. 
Recommend using a zuliprc file instead of hardcoding the API
credentials in a config object.
 2018-01-17 09:27:35 -05:00
Eeshan Garg e18b9ae1c1 api/remove-subscriptions: Add JavaScript example. 2018-01-17 09:27:35 -05:00
Eeshan Garg 6d92c88997 api/add-subscriptions: Add JavaScript example. 2018-01-17 09:27:35 -05:00
Eeshan Garg 4d8c20b773 api/get-subscribed-streams: Recommend using zuliprc. 
Recommend using a zuliprc file instead of hardcoding the API
credentials in a config object.
 2018-01-17 09:27:35 -05:00
Eeshan Garg b32bb7d5f4 api/get-stream-id: Add JavaScript example. 2018-01-17 09:27:35 -05:00
Eeshan Garg 370d2c6bab api/get-all-streams: Recommend using zuliprc. 
Recommend using a zuliprc file instead of hardcoding the API
credentials in a config object.
 2018-01-17 09:27:35 -05:00
Eeshan Garg e781a57ca2 api/private-message: Recommend using zuliprc. 
Recommend using a zuliprc file instead of hardcoding the API
credentials in a config object.
 2018-01-17 09:27:35 -05:00
Eeshan Garg e36d61f216 api/update-message: Add JavaScript example. 2018-01-17 09:27:35 -05:00
Eeshan Garg ba98451928 api/stream-message: Recommend using zuliprc. 
Recommend using a zuliprc file instead of hardcoding the API
credentials in a config object.
 2018-01-17 09:27:35 -05:00
Eeshan Garg 360885fb12 api/render-message: Add JavaScript example. 2018-01-17 09:27:35 -05:00
Robert Hönig 93f47fa700 outgoing webhooks: Rename "Base URL" to "Endpoint URL". 
Based on user feedback. "Endpoint URL" gives a clearer
idea of the field's purpose.
 2018-01-16 08:11:51 -05:00
Eeshan Garg 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
Eeshan Garg 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
Eeshan Garg 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
Eeshan Garg 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
Eeshan Garg ae59b08316 api docs: Document the GET /api/v1/users/me endpoint. 
Note that there is no JavaScript equivalent for requesting this
endpoint in zulip-js yet.
 2018-01-07 15:19:51 -05:00
Eeshan Garg 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
Eeshan Garg 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
Eeshan Garg 479bc41ca5 api docs: Remove old and outdated endpoint docs. 2018-01-04 10:17:29 -05:00
Eeshan Garg 1fd71287d6 api docs: Document the GET /api/v1/events endpoint. 2018-01-04 10:17:29 -05:00
Eeshan Garg d235a6c0c4 api docs: Remove superfluous sys imports in Python examples. 
These are remnants from old code examples that I forgot to
remove.
 2018-01-04 10:17:29 -05:00
Eeshan Garg c616d7869b api docs: Recommend using zuliprc file for configuration. 
In our code examples, we now recommend using a zuliprc file
instead of passing in the config info directly.
 2018-01-04 10:17:29 -05:00
Eeshan Garg f620525373 api docs: Document the POST /api/v1/register endpoint. 2018-01-03 12:23:30 -05:00
Cynthia Lin c31e148ea8 user docs: Add links back to homepage to the bottom of the sidebars. 2017-12-31 08:08:25 -05:00
Eeshan Garg b73c60a135 api docs: Document the GET /api/v1/users endpoint. 2017-12-30 11:03:23 -05:00
Eeshan Garg 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
Eeshan Garg 0458faf2f9 api docs: Document the GET /users/me/subscriptions endpoint. 2017-12-30 11:03:23 -05:00
Eeshan Garg 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
Eeshan Garg 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
Eeshan Garg 3003d3d927 api examples: Change required JS module from `zulip` to `zulip-js`. 
The JS module we ask our users to install in the installation
instructions is zulip-js, not zulip. These examples would fail
with the latter. This commit updates the examples to use the
name zulip-js.
 2017-12-29 17:03:36 -05:00
Eeshan Garg 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 229cdfce90 markdown: Add a macro for invalid API key JSON response. 
The JSON response for when an invalid API key is used to initiate
an API call seems to be identical in every case, so this macro
can be reused all the time.
 2017-12-29 17:03:36 -05:00
Eeshan Garg 3a90a6be5e markdown: Add macro for successful send message JSON response. 
The JSON response for when an API call to send a message is
successful is the same for both private and stream messages, so
these macros may be used again.
 2017-12-29 17:03:36 -05:00
Eeshan Garg b093a861e0 api/private-message: Document arguments and examples responses. 
This commit adds the following:

* A table specifying the arguments that are required for this API
  call.
* Examples of JSON responses.

This will help us in obsoleting api_endpoints.html.
 2017-12-29 17:03:36 -05:00
Eeshan Garg cdcaf1374e api/stream-message: Document arguments and examples responses. 
This commit adds the following:

* A table specifying the arguments that are required for this API
  call.
* Examples of JSON responses.

This will help us in obsoleting api_endpoints.html.
 2017-12-29 17:03:36 -05:00
Eeshan Garg 94bc9d52d1 api docs: Split usage.md into two separate docs. 
This commit splits usage.md into two separate docs,
stream-message.md and private-message.md. The arguments and return
values for sending a stream message are somewhat different from
those of sending a private message, so it made sense to split the
two up for clarity.
 2017-12-29 17:03:36 -05:00
akashnimare db7943478e api: Align code blocks properly in /api page. 
Fixes #7395.
 2017-12-29 08:45:37 -05:00
Steve Howell 7b8cc396b5 bot docs: Simplify docs on writing bot tests. 
These changes catch up to some recent improvements in the
test system, plus I eliminate some unnecessary sections.
 2017-12-14 07:07:18 -05:00
YJDave e4bf3d6907 api: Fix typo in interactive bots doc. 2017-12-14 00:53:23 -08:00
Greg Price ca09c1e0fd templates: Revert change to Python 3 typing syntax in examples. 
This reverts commit 5a1869901.  I reviewed this change and decided not
to merge it yet, but then I did anyway <_< >_>, along with some others
in the same PR.
 2017-12-12 17:45:43 -08:00