573d470fd6
docs: Make server-settings use curl example system.
2019-10-15 15:53:03 -07:00
6a5fdcabbd
docs: Make delete-user-group use curl example system.
2019-10-15 15:53:03 -07:00
d1540f7e10
docs: Make update-user-group use curl example system.
2019-10-15 15:53:03 -07:00
c5d6be4df7
docs: Make create-user-group use curl example system.
2019-10-15 15:53:03 -07:00
70e8f5ce8a
docs: Make get-user-groups use curl example system.
2019-10-15 15:53:03 -07:00
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
503e65079a
docs: Make get-presence use curl example system.
2019-10-15 15:53:03 -07:00
6f59a17bfe
docs: Make typing use curl example system.
2019-10-15 15:53:03 -07:00
af83884f6f
docs: Make create-user use curl example system.
2019-10-15 15:53:02 -07:00
2a8065963e
docs: Make get-profile use curl example system.
2019-10-15 15:40:44 -07:00
b68b566711
docs: Make get-all-users use curl example system.
2019-10-15 15:40:44 -07:00
ea06dc6ab3
docs: Make delete-stream use curl example system.
2019-10-15 15:40:44 -07:00
8b29f52d09
docs: Make get-stream-id use curl example system.
2019-10-15 15:40:44 -07:00
04cc121b77
docs: Make mute-topics.md use curl example system.
2019-10-15 15:40:44 -07:00
13bdfc0ef8
docs: Make get-stream-topics use curl example system.
2019-10-15 15:40:44 -07:00
ad16c55c77
docs: Make remove-subscriptions use curl example system.
2019-10-15 15:40:44 -07:00
4364e31d69
docs: Make update-subscription-properties use curl example system.
2019-10-15 15:40:44 -07:00
06883dc4b2
docs: Make add-subscriptions use curl example system.
2019-10-15 15:40:44 -07:00
94d31e9d4f
docs: Make get-subscribed-streams use curl example system.
2019-10-15 15:40:44 -07:00
9442422da1
docs: Make get-all-streams use curl example system.
2019-10-15 15:40:44 -07:00
3f9835ed07
docs: Make mark-as-read-bulk use curl example system.
2019-10-15 15:40:44 -07:00
f0b099dbc0
docs: Make update-message-flags use curl example system.
2019-10-15 15:40:44 -07:00
19ee518f2e
docs: Make get-message-history use curl example system.
2019-10-15 15:40:44 -07:00
ed2e89f167
docs: Make delete-message use curl example system.
2019-10-15 15:40:44 -07:00
0dccebbe39
docs: Make update-message use curl example system.
2019-10-15 15:40:44 -07:00
9bc3594f75
docs: Make get-raw-message use curl example system.
2019-10-15 15:40:44 -07:00
718b70ec8b
Rename `not_subscribed key` to `not_removed` in users/me/subscriptions.
...
Rename `not_subscibed_key` to `not_removed` in
`users/me/subscriptions` DELETE response.
Fixes #13277 .
2019-10-13 10:30:34 +07:00
bf088519a7
api: Add avatar URL to the GET /profile endpoint.
...
This endpoint is legacy in a lot of ways, but it seems reasonable that
it should have these data.
2019-09-27 12:07:03 -07:00
6f6c761d80
docs: Further expand documentation on using IDs in narrows.
...
These docs had a number of typos, and also didn't fully clarify how to
handle lists of integers for `pm-with`.
Also makes some tweaks to the user docs to make this clearer as well.
Fixes #13167 .
2019-09-16 17:17:03 -07:00
b3df3f2e22
docs/botserver: Document running custom bot modules.
...
This documents the feature added in
https://github.com/zulip/python-zulip-api/pull/523 .
2019-09-03 13:28:01 -07:00
73c9450d8a
docs: Expand documentation on using IDs in narrows.
2019-08-29 16:17:09 -07:00
6fe99171c3
docs/botserver: Add basic troubleshooting help.
...
It could be a non trivial task ensuring that the Zulip server can
access the Botserver. These steps examine some of those cases.
2019-08-28 16:08:34 -07:00
7f3ee1b6b1
docs: Fix typo: Heroko -> Heroku.
2019-08-28 15:59:03 -07:00
16227ed23a
docs/botserver: Explain how the botserver works.
...
Understanding the basic model can help people troubleshoot any
errors easily.
2019-08-28 15:59:03 -07:00
3999a2db4d
api: Document using `pip3 install` for zulip_bots(erver).
...
We dropped Python 2 support for these a while ago.
2019-08-23 15:51:06 -07:00
ea670f3d61
docs: remove duplicate "make" in "Writing Bots".
2019-08-21 14:36:08 -07:00
d73a37726d
bots: Allow incoming webhook bots to be configured via /bots.
...
Without disturbing the flow of the existing code for configuring
embedded bots too much, we now use the config_options feature to
allow incoming webhook type bot to be configured via. the "/bots"
endpoint of the API.
2019-08-20 17:00:48 -07:00
26f7dd09ce
display_recipient: Eliminate raw_display_recipient from message dicts.
...
This was used as a helper to construct the final display_recipient when
fetching messages. With the new mechanism of constructing
display_recipient by fetching appropriate users/streams from the
database and cache, this shouldn't be needed anymore.
2019-08-20 12:22:52 -07:00
1af72a2745
subscriptions: Avoid sending unneeded subscriber information.
...
The `users/me/subscriptions` endpoint accidentally started returning
subscriber information for each stream. This is convenient, but
unnecessarily costly for those clients which either don't need it
(most API apps) or already acquire this information via /register
(including Zulip's apps).
This change removes that data set from the default response. Clients
which had come to rely on it, or would like to rely on it in future,
may still access it via an additional documented API parameter.
Fixes #12917 .
2019-08-09 16:03:21 -07:00
0db9afe605
api docs: Update link to a currently running requestbin site.
2019-08-08 11:04:16 -07:00
ac69717604
openapi: Migrate /messages to use the new cURL example system.
...
Now that we can create cURL examples based on the OpenAPI
documentation. We can begin using simple one line tags in
the documentation instead of manually creating cURL examples.
Fixes part of #12878 .
2019-08-05 21:27:24 -07:00
748192d58c
openapi: Replace add-subscriptions from TEST_FUNCTIONS.
...
Migrate the add-subscriptions line to the OpenAPI equivalent.
2019-08-05 21:06:19 -07:00
14c0a387cf
openapi: Remove /users/me from pending endpoints.
...
This commit progress our efforts to reduce pending_endpoints
as well as to migrate away from templates/zerver/api/fixtures
and towards our OpenAPI documentation.
Similar to commit d62b75fc
2019-08-05 21:06:19 -07:00
8c9dd6198f
api docs: Use Help Center syntax for restricted endpoints.
2019-07-29 16:17:54 -07:00
c85640d6b1
docs: Fix cURL example in get-user-groups.md.
...
The issue here was that the endpoint was documented as being
contactable by bots when in reality we have a require_member_or_admin
decorator on the endpoint. So bots and guests cannot contact it.
2019-07-29 16:09:11 -07:00
b2a3d289b0
docs: Fix cURL example in get-stream-id.md by adding a missing '\'.
2019-07-29 16:07:58 -07:00
e9cc69297f
docs: Fix cURL example in get-stream-id.md by using the -G argument.
2019-07-29 16:07:58 -07:00
12dce4b940
api_docs/get-messages: Fix the cURL example.
...
The issue with the previous example was that it sent the data as
POST variables. This corrected example appropriately encodes data
(with URL encoding) and sends it as GET variables.
2019-07-29 16:07:01 -07:00
202e2cabc3
api: Fix typo in URL for remove-subscriptions.
2019-07-21 18:41:29 -07:00
d62b75fc4c
openapi: Remove /users/me/subscriptions from pending_endpoints.
...
In commit 7c71e98
2019-07-21 18:39:53 -07:00
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
3cc790420a
docs: Update docs to reflect the use of Ubuntu bionic in development.
2019-07-08 13:25:54 -07:00
4dcc1b744f
api_docs: Add documentation for remove_user_group.
2019-06-28 16:34:39 -07:00
d351564798
api_docs: Add documentation for update_user_group.
2019-06-28 16:33:54 -07:00
1b2f67f1bf
api_docs: Add documentation for create_user_group.
2019-06-28 16:28:56 -07:00
f84e84d6c7
api_docs: Add documentation for update_stream.
2019-06-28 16:26:06 -07:00
0ceea2713c
api_docs: Add documentation for delete_stream.
2019-06-28 16:18:22 -07:00
297c79eaa9
api docs: Fix typo in name of has_alert_word message flag.
2019-06-27 11:55:15 -07:00
ef52aa0fc1
webhooks: Eliminate the usage of a headers.py file.
...
For storing HTTP headers as a function of fixture name, previously
we required that the fixture_to_headers method should reside in a
separate module called headers.py.
However, as in many cases, this method will only take a few lines,
we decided to move this function into the view.py file of the
integration instead of requiring a whole new file called headers.py
This commit introduces the small change in the system architecture,
migrates the GitHub integration, and updates the docs accordingly.
2019-06-26 10:35:14 -07:00
4691028097
webhooks: Extract the '__' method of mapping to headers.
...
In the GitHub integration we established that for many integrations,
we can directly map the fixture filename to the set of required
headers and by following a simple naming convention we can greatly
ease the logic involved in fixture_to_headers method required .
So to prevent the need for duplicating the logic used by the GitHub
integration, we created a method called `get_http_headers_from_filename`
which will take the name of the HTTP header (key) and then return a
corresponding method (in a decorator-like fashion) which could then be
equated to fixture_to_headers in headers.py.
The GitHub integration was modified to use this method and the docs
were updated to suggest using this when possible.
2019-06-26 10:32:34 -07:00
a37fa74dce
templates: Fix new low-hanging HTML validation problems.
...
"http://localhost:9981/api/update-message-flags ":318.16-319.34: error: “th” start tag in table body.
"http://localhost:9981/api/update-message-flags ":344.35-344.38: error: Stray end tag “a”.
"http://localhost:9981/api/incoming-webhooks-walkthrough ":412.4-412.77: error: An “img” element must have an “alt” attribute, except under certain conditions. For details, consult guidance on providing text alternatives for images.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-06-24 23:20:17 -07:00
6763e77ee2
api docs: Fix syntax for get-user-groups.
...
This apparently had some sort of rebase conflict issue with the
migration to the nicer syntax for tabs.
2019-06-24 22:24:46 -07:00
4dc206ad2e
api docs: Document PATCH /settings/notifications.
...
With significant tweaks by tabbott after rebasing.
2019-06-24 18:42:44 -07:00
7c145c3f68
webhooks: Add a system for storing http headers for integrations.
...
Using this system, we can now associate any fixture of any integration
with a particular set of HTTP headers. A helper method called
determine_http_headers was introduced, and the test suite was upgraded
to use determine_http_headers.
Comments and documentation significantly edited by tabbott.
2019-06-20 16:36:38 -07:00
51793f70cf
docs: Provide link to available message flags from get-messages.
2019-06-19 11:44:48 -07:00
d7b4de2348
messages: Add support for passing user IDs for pm-with clause.
...
We also document support for user IDs in the pm-with narrow operator.
Edited by tabbott to document on /api rather than in the /help page.
Fixes part of #9474 .
2019-06-17 17:38:51 -07:00
33e798168a
docs: Declare the markdown code block to be json.
...
This just adds json syntax highlighting to api documentation page
at /api/construct-narrow.
2019-06-17 17:38:18 -07:00
58c11fd249
api: Update documentation of subscription properties endpoint.
...
This covers the recent field rename as well as the addition of
email_notifications.
2019-06-06 12:05:49 -07:00
c6b03432bc
docs: modify update-message-flag to contain information about flags.
...
This makes it a lot more useful for understanding how our flag update
endpoints work.
With significant edits by tabbott to explain what these are.
Fixes #12092 .
2019-06-04 00:40:47 -07:00
b67d263b1a
api docs: Avoid using \" in curl examples.
...
It's much cleaner to encode the JSON without quote-escaping.
closes #12196 .
2019-05-30 11:05:41 -07:00
fa37c5cee1
docs: Extract a Writing Documentation top-level section.
...
This should make this easier to find, and also makes "Subsystems" a
bit smaller of a catch-all.
2019-05-29 15:52:11 -07:00
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
4cbe489576
docs: Highlight send messages API in incoming webhooks page.
...
While we already talk about this in the "overview" section, it appears
some folks skipped that and were confused.
2019-05-20 19:18:30 -07:00
1a12e112d9
devtools: Completely overhaul the frontend for the integrations devtool.
...
This commit also adds a small functionality change where the results of
each webhook fixture message sent is now displayed to the user.
With a small tweak by tabbott to fix a styling bug.
Fixes #12122 .
2019-05-20 12:36:15 -07:00
2bd9c8cb42
devtools: Add custom HTTP headers support to the integrations dev panel.
...
This commit introduces a simple field where the user can now specify custom
HTTP headers. This commit does not introduce an improved system for storing
HTTP headers as fixtures - such a change would modify both the existing unit
tests as well as this devtool.
2019-05-17 11:50:53 -07:00
bae8295c52
devtools: Add integrations dev panel.
...
This commit adds a new developer tool: The "integrations dev panel"
which will serve as a replacement for the send_webhook_fixture_message
management command as a way to test integrations with much greater ease.
2019-05-15 13:07:44 -07:00
64ad031d5c
writing-bots: Use a fenced code block to fix rendering.
...
Type annotation for the function is not rendered correctly: `-> None` is
rendered as `-> None`.
2019-05-14 15:35:12 -07:00
098e5ad3de
templates: Fix more low-hanging HTML validation problems.
...
"http://localhost:9981/help/enable-emoticon-translations ":323.13-324.31: error: The “align” attribute on the “th” element is obsolete. Use CSS instead.
"http://localhost:9981/help/enable-emoticon-translations ":324.45-325.31: error: The “align” attribute on the “th” element is obsolete. Use CSS instead.
"http://localhost:9981/help/enable-emoticon-translations ":329.13-330.23: error: The “align” attribute on the “td” element is obsolete. Use CSS instead.
"http://localhost:9981/help/enable-emoticon-translations ":330.44-331.23: error: The “align” attribute on the “td” element is obsolete. Use CSS instead.
"http://localhost:9981/help/enable-emoticon-translations ":337.6-337.9: error: Stray end tag “p”.
"http://localhost:9981/help/enable-emoticon-translations ":337.6-337.9: error: Cannot recover after last error. Any further errors will be ignored.
"http://localhost:9981/api/incoming-webhooks-walkthrough ":381.4-381.77: error: An “img” element must have an “alt” attribute, except under certain conditions. For details, consult guidance on providing text alternatives for images.
"http://localhost:9981/apps/ ":192.21-192.34: error: Bad value “” for attribute “src” on element “img”: Must be non-empty.
"http://localhost:9981/apps/ ":192.21-192.34: error: An “img” element must have an “alt” attribute, except under certain conditions. For details, consult guidance on providing text alternatives for images.
"http://localhost:9981/features/ ":225.9-225.82: error: An “img” element must have an “alt” attribute, except under certain conditions. For details, consult guidance on providing text alternatives for images.
"http://localhost:9981/features/ ":230.72-232.8: error: Text not allowed in element “svg” in this context.
"http://localhost:9981/features/ ":259.9-259.91: error: An “img” element must have an “alt” attribute, except under certain conditions. For details, consult guidance on providing text alternatives for images.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-04-23 13:00:59 -07:00
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
b12f494031
documentation: Update the API documentation for Get all users.
2019-04-04 13:29:16 -07:00
19b96b4e0b
api_docs/send-message: Specify request command in curl example.
...
This commit is related to #11927 .
2019-03-27 20:58:44 -02:30
99c3e2ecdc
management: Support sending custom headers when testing a webhook.
...
this commit adds an option to specify custom headers when using the
`./manage.py send_webhook_fixture_message` tool.
2019-03-13 12:40:47 -07:00
7157edf4af
settings: Add support for uploading logo for night mode.
...
This adds a new field named realm_night_logo which is used for
displaying the organization logo when the user is in night mode.
Fixes #11176 .
2019-02-18 15:15:57 -08:00
382d3085c4
api_docs: Document is_guest field in the get_members API.
2019-01-23 16:04:16 -08:00
ac86074869
api_docs: Suggest using call_endpoint for undocumented endpoints.
2019-01-22 07:37:56 -08:00
5050b595a0
api docs: Fix showing correct link to install Python bindings.
...
We just make the Python tab the default first tab, which is clearer anyway.
Fixes #9575 .
2019-01-16 10:05:25 -08:00
2ad1a27b28
create-production-venv: Remove Python 2 support.
...
We still create a Python 2 virtualenv for thumbor but that’s
separate (/srv/zulip-thumbor-venv from
scripts/lib/create-thumbor-venv).
Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2019-01-09 17:32:05 -08:00
9c589ac7d9
api docs: Stop mentioning "dev servers" in JS code examples.
...
Since the Zulip API runs on both developement and production
servers, it is misleading to mention "dev servers" when discussing
zuliprc files.
Also, note that it is better to manually edit all of our JS
examples than to implement macro-like functionality that we use
for our Python examples. For our current purposes, it would be
too much work to build a full-blown testing framework for our
JS code examples just so that we can fix a minor wording issue.
Fixes #10672 .
2019-01-07 09:14:25 -08:00
ad1df0ebeb
settings: Add support for customizing the top-left logo.
...
This adds a new realm_logo field, which is a horizontal-format logo to
be displayed in the top-left corner of the webapp, and any other
places where we might want a wide-format branding of the organization.
Tweaked significantly by tabbott to rebase, fix styling, etc.
Fixing the styling of this feature's loading indicator caused me to
notice the loading indicator for the realm_icon feature was also ugly,
so I fixed that too.
Fixes #7995 .
2018-12-18 12:44:52 -08:00
3003517430
docs: Move mypy documentation from contributing to testing.
...
The testing section is more appropriate, since it's fundamentally part
of our CI system.
While we're at it, fix the fact that we were linking to GitHub, not
ReadTheDocs, in the run-mypy output.
2018-12-16 21:52:53 -08:00
69da22d998
api docs: Document the custom emoji upload endpoint.
...
Tweaked by tabbott to fix some English phrasing and make the file
pointer thing require less Python knowledge.
Fixes : #10746 .
2018-12-14 14:19:28 -08:00
ced4d81856
Sweep tests for expected_subject -> expected_topic.
...
This is all in the webhooks tests, including some
docs for how to write those tests.
2018-11-12 15:47:11 -08:00
aa3682f9fc
api: Add GET /user_groups documentation.
...
This documents our GET endpoint for interacting with Zulip's user
groups feature.
Fixes #10298 .
2018-11-08 22:19:30 -08:00
8c8cb725bf
api: Clarify slack-format outgoing webhook docs.
...
The previous discussion was confused about the fact that Slack sends
the outgoing webhook requests, not receives them.
2018-11-08 22:13:15 -08:00
5c8b774628
outgoing-webhooks.md: Document example endpoint responses.
2018-11-08 22:07:56 -08:00
c6dd801525
docs: Fix a couple of broken links.
...
For the PHP link, I just found an equivalent link that detailed
some well-known PHP security vulnerabilities.
As for the now defunct RequestBin, another instance is hosted
by another domain, so we can recommend using that for now.
2018-11-06 12:54:36 -08:00
1c264dedc5
api docs: Change Shakespeare quote.
...
The previous quote doesn't come off well if you don't know the reference
(which the majority of our users will not).
2018-10-22 15:44:36 -07:00
c37384f63d
api docs: Update writing-bots.
...
Removes the intro material since there are better places for it.
2018-10-20 13:31:19 -07:00
6b8de50c50
api docs: Update running-bots.
...
This page still has some work needed, but will probably require coordination
with the product work as well.
2018-10-20 13:31:19 -07:00
796a1a6582
api docs: Update non-webhook-integrations.md.
...
Addresses comments on a8e1225
2018-10-20 13:31:19 -07:00
b31bbbe649
api_docs: Use tabbed_sections extension in new API docs.
2018-10-17 15:32:35 -07:00
5275d49f05
api_docs: Properly escape arguments passed to curl.
...
Fixes #8484 .
2018-10-17 15:32:35 -07:00
d76f728dda
api docs: Rename webhook-walkthrough to incoming-webhooks-walkthrough.
2018-10-16 21:07:00 -07:00
6a352ab249
api docs: Add script and plugin integrations to integrations-overview.
2018-10-16 21:07:00 -07:00
df20f1a47f
api docs: Rename integration-guide.md to non-webhook-integrations.md.
2018-10-16 21:07:00 -07:00
cd81b0766a
api docs: Move references to integration-guide to integrations-overview.
2018-10-16 21:06:59 -07:00
a8e1225a6b
api docs: Update integration-guide.
2018-10-16 21:06:59 -07:00
c3eb922559
api docs: Move general advice to incoming webhooks guide.
...
One of the bullets does reference APIs, which aren't relevant to incoming
webhooks, but decided to leave it as is.
2018-10-16 21:06:59 -07:00
decc5352aa
api docs: Update webhook-walkthrough.
2018-10-16 21:06:59 -07:00
47cddf4acf
api docs: Update incoming-webhooks-overview.md.
2018-10-16 21:06:59 -07:00
4abce1783f
api docs: Restructure integrations section and add an overview.
2018-10-16 21:06:59 -07:00
6487d956fe
api docs: Fix typo in URL for bulk-mark-as-read.
2018-10-16 13:03:59 -07:00
029d815be7
api docs: Document the /dev_fetch_api_key endpoint.
2018-10-16 12:47:12 -07:00
3eeec94d03
api docs: Document the POST /users/me/subscriptions/properties endpoint.
2018-10-16 12:38:27 -07:00
3d2b3f8fa4
api docs: Document the POST /messages/flags endpoint.
2018-10-16 12:19:24 -07:00
7a4103eee6
api docs: Document POST /mark_(all|stream|topic)_as_read.
2018-10-16 12:12:05 -07:00
5272ac8c39
api docs: Fix a broken linkification filters link.
2018-10-16 12:03:38 -07:00
d13bd6e8d3
linkifiers: Rename articles to current feature name.
...
These were previously called "linkification filters", but we now want
to consistently refer to them as "linkifiers" in the UI and API docs.
2018-10-16 12:01:17 -07:00
3bdc8f9946
api: Document the GET /realm/emoji endpoint.
2018-10-16 11:51:48 -07:00
7a7b507e86
api docs: Document DELETE /realm/filters/<filter_id>.
2018-10-16 11:51:48 -07:00
a7c48acc8e
api docs: Document GET /realm/filters.
2018-10-16 11:51:48 -07:00
395d74c08a
api docs: Clean up outgoing webhooks section.
...
I rewrote the section explaining what the
endpoint sends back to the server. This fixes
a few typos, emphasizes the normal case, and
starts to favor "content" as the key for
content.
2018-10-11 16:12:07 -07:00
83bcea3917
api: Fix docs to point to /latest/ for integration docs.
...
Pointing to /stable/ doesn't work, since that article doesn't exist in
the 1.8.0 release series.
2018-10-10 12:19:14 -07:00
bf22eefede
api docs: Move integration-docs-guide to docs/.
2018-10-09 20:28:44 -07:00
383f1633e6
api: Add limit of total messages available per request of 5000.
...
Tweaked by tabbott to use a declared constant rather than just use
5000 in multiple places; this also means we can change the count
without updating translations.
Fixes #10446 .
2018-10-09 15:43:21 -07:00
a943e55863
docs: Move LDAP documentation out of plug-and-play section.
...
Also update the links to this section.
2018-09-27 13:38:14 -07:00
7f16d27015
api docs: Update api-keys.
2018-09-25 21:02:58 -07:00
78f8fac106
api docs: Make minor copyediting changes.
2018-09-25 20:48:12 -07:00
0817905480
api docs: Use Markdown extension for tabbed sections.
2018-09-18 13:49:34 -07:00
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
78f85ef960
api docs: Document the GET /messages/<message_id>/history endpoint.
2018-08-28 17:33:02 -07:00
5c6f381f32
api docs: Document the DELETE /messages/<message_id> endpoint.
2018-08-28 17:26:49 -07:00
9575f1b51f
api docs: Document the GET /messages/<message_id> endpoint.
2018-08-28 17:22:28 -07:00
ab164ba740
api docs: Document the GET /messages endpoint.
2018-08-28 17:17:46 -07:00
c36cf95dc8
api docs: Document GET /server_settings.
2018-08-27 17:45:50 -07:00
0af7a12197
api: Fix typos in doc on constructing narrows.
2018-08-27 17:37:37 -07:00
1efcdfdb5c
templates: Merge Help and API doc main into documentation_main.
...
With minor fixes by eeshangarg.
2018-08-27 20:19:24 -02:30
54464feda7
api docs: Document the PATCH /users/me/subscriptions/muted_topics endpoint.
2018-08-26 23:10:21 -07:00
e7c7b19507
api docs: Document POST /realm/filters.
2018-08-22 17:42:14 -07:00
fcf1e3cd88
api docs: Add guide for creating narrows.
...
Dramatically edited by tabbott to simplify the discussion and
duplication of content in our main search documentation.
2018-08-22 17:16:27 -07:00
aa5185fdf8
api docs: Document POST /typing.
2018-08-17 12:57:40 -07:00
e7374a0852
api docs: Link to our zapier and ifttt /integrations pages.
2018-08-10 10:37:49 -07:00
90e3b8d808
api docs: Remove unnecessary argument entry.
2018-08-08 09:29:27 -07:00
8d0cf3ebe5
api docs: Migrate POST /user_uploads to OpenAPI.
2018-08-08 09:29:27 -07:00
119b3c0bc4
api docs: Migrate DELETE /users/me/subscriptions to OpenAPI.
2018-08-08 09:29:27 -07:00
14c9277095
api docs: Migrate POST /users to OpenAPI.
2018-08-08 09:29:27 -07:00
2b8bb2ffc6
api docs: Migrate DELETE /events to OpenAPI.
2018-08-02 15:54:41 -07:00
5f3268cc48
api docs: Migrate GET /events to OpenAPI.
2018-08-02 15:54:41 -07:00
c28db51da2
api docs: Improve phrasing for /events.
2018-08-02 15:54:41 -07:00
5631645d9f
api docs: Migrate /register to OpenAPI.
2018-08-02 15:54:41 -07:00
40a21f6077
api docs: Migrate GET /users to OpenAPI.
2018-07-26 15:34:31 -07:00
7c50f6cdd4
api docs: Migrate POST /messages/render to OpenAPI.
2018-07-26 15:34:31 -07:00
57c2d8c72a
api docs: Migrate GET /get_stream_id to OpenAPI.
2018-07-26 15:34:31 -07:00
679319a735
api docs: Migrate GET /streams to OpenAPI.
2018-07-26 15:34:31 -07:00
7ddc6e8d10
api docs: Migrate POST /messages to OpenAPI.
2018-07-26 10:24:01 -07:00
cb24756edc
api docs: Merge docs for sending stream and private messages.
2018-07-26 10:24:01 -07:00
d50faa4d81
user docs: Add reference to support email in docs footer.
2018-07-24 11:10:23 -07:00
b6ce93e029
outgoing webhooks: Fix sample values for slack outgoing webhooks.
...
This switches us to use the correct timestamp, service_id and token
formats. The 'service_id' should be the ID of the bot user. The token
should be a sample token generated from 'random_api_key()'.
2018-07-23 08:07:56 -07:00
37e7cb4b96
outgoing-webhooks.md: Use HTML tables to document payload fields.
2018-07-14 09:44:54 +05:30
2e78a56796
outgoing-webhooks.md: Add example payloads/fixtures.
2018-07-14 09:44:54 +05:30
ab9f167053
help: Refactor help page CSS to eliminate padding on content containers.
...
This is essential for using simplebar, since simplebar doesn't account
for parent <div> paddings, which might cause scrollbars to be mispositioned
if not considered.
2018-07-13 18:03:32 +05:30
d60037c91b
deploying_bots.md: Fix a couple of minor formatting issues.
2018-07-10 10:01:16 +05:30
026493f791
api_docs: Split integration-guide.md into separate docs.
...
This commit carves out the overview for incoming webhooks and
moves it to its own file. This is a much better way to structure
these docs.
This is a quick follow-up to Tim Abbott's comment on #9592 .
2018-07-09 14:59:17 -02:30
b618c644a3
HTML validation: Quote <my-bot> and <api_key> placeholders in api docs.
...
They were being sent to the browser as non-renderable HTML tags.
Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2018-07-09 10:00:56 +05:30
3806c092c6
HTML validation: Fix problems with tag nesting.
...
Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2018-07-09 10:00:56 +05:30
fa2daf0044
api docs: Migrate POST /users/me/subscriptions to OpenAPI.
2018-07-03 20:15:34 +02:00
bba8b88707
api docs: Explain clearly how to create new streams.
...
Tweaked significantly by tabbott to cover this more clearly.
2018-07-01 08:41:37 -07:00
9a2036b52a
api docs: Make the Home page more straightforward.
...
Fixes #9854 .
2018-07-01 04:33:04 -07:00
89a59422cc
api docs: Fix link to IFTTT.
...
Old link is 404'ing.
2018-06-29 22:40:16 -07:00
8e50564717
api docs: Document the /users/me/<stream_id>/topics endpoint.
2018-06-23 12:42:11 +02:00
3ccae20566
docs: Remove the footer, which directed people to help with docs.
2018-06-12 13:42:30 -04:00
0a43e5e257
Replace all user-facing references to "invite-only" with "private".
...
Fixes #9611 .
2018-06-12 13:37:45 -04:00
620b473cc8
botserver: Rename zulip-bot-server to zulip-botserver.
2018-06-04 08:39:25 -07:00
f0284c84d6
bot docs: Update botserverrc examples.
...
THe botserverrc sections now include
a token for each bot.
2018-06-04 08:39:25 -07:00
0e354a4a23
api: Document BAD_EVENT_QUEUE_ID errors more completely.
2018-06-01 12:41:50 -07:00
ba835e3511
api: Fix response fixtures for create-user.
2018-06-01 12:36:12 -07:00
9cbf6ad03b
api: Fix response fixtures for delete_queue.
...
These were malformed.
2018-06-01 12:34:51 -07:00
f68fedd808
api docs: Make minor phrasing improvement.
2018-06-01 12:03:31 -07:00
f5bfa4e793
css: Fix code block formatting issues in our Markdown docs.
2018-06-01 09:19:42 -07:00
4f98a45507
docs: Rename "webhooks" to "incoming webhooks".
...
I only renamed references that I thought were absolutely necessary
and only if the resulting sentence structure wasn't awkward.
If the renaming resulted in awkward structure, I replaced the term
"webhook" with "integration" (but only in some very obvious cases).
Fixes #9500 .
2018-05-30 18:21:13 -07:00
fe6b46dfa6
docs: Consistently use Botserver instead of botserver or bot server.
2018-05-29 07:27:33 -07:00
04d68d2570
code: Rename flaskbotrc to botserverrc.
2018-05-29 10:19:17 +02:00
c25855f703
api docs: Fix broken link.
2018-05-28 10:39:25 -07:00
f84c9b919b
api docs: Read parameters and response fixtures from OpenAPI files.
2018-05-26 22:49:55 +02:00
d87f0ccb4e
api docs: Show Yes/No in the "Required" field of the args table.
2018-05-25 23:31:30 +02:00
34354ca62b
docs: Split zulip_botserver discussion of deploying bots.
...
Now we have explicit documentation for the processing of deploying a
single bot, which can be cleaner and simpler.
2018-05-25 11:01:57 -07:00
53891a9bed
bots: Don't name section headers in flaskbotrc.
...
The Botserver uses section headers in the flaskbotrc to
determine which bot to run. Silently setting the section
headers to a bot's username is confusing and makes it
harder for Botserver users to figure out how to get the
Botserver to run the bots they want. This commit empties
all flaskbotrc section headers and thus makes the assignment
of bots explicit and mandatory.
2018-05-25 10:33:40 -07:00
bdf79f271d
Implement and document new Botserver setup routine.
...
Previously, the Botserver determined which bot to run for an
outgoing webhook by dispatching on a different URL endpoint
for each bot. Now, instead, the Botserver determines which bot
to run by the section header of the bot in the flaskbotrc.
This commit makes the frontend provide the new flaskbotrc
and updates the setup steps for the Botserver in the docs.
2018-05-25 10:33:40 -07:00
cc0d0b55f1
docs: Add documentation for outgoing webhooks.
...
Rewritten by some combination of @rheaparekh and @timabbott to more
clearly discuss what's actually important to users.
2018-05-25 10:30:53 -07:00
3ed20589f2
webhooks: Add generic exception for unexpected webhook events.
...
UnexpectedWebhookEventType is a generic exception that we may
now raise when we encounter a webhook event that is new or one
that we simply aren't aware of.
2018-05-22 08:30:19 -07:00
9de80990ea
api: Update links for new /deploying-bots page.
...
Also caught by test-help-documentation.
2018-05-18 16:31:52 -07:00
847fc69c79
api: Fix a badly line-wrapped link.
...
Caught by test-help-documentation.
2018-05-18 16:31:36 -07:00
dd7507c88a
docs: Add a page on deploying bots in production.
2018-05-18 16:13:17 -07:00
f0fa550001
docs: Rename rest_endpoints with dashes.
2018-05-15 09:06:56 -07:00
3a68f998a7
integration-docs-guide: Add a more detailed writing style guide.
...
Most of the recommendations in this guide were written by Rishi
Gupta (rishig), with a few contributions from Eeshan Garg.
2018-05-15 10:06:08 -04:00
fa28ccb952
integration-docs-guide: Trim text documenting Markdown macros.
...
We were devoting too much space/text to documenting our Markdown
macro. It is much more concise to just have a description and a
link to an example doc for each major macro.
2018-05-14 20:14:08 -02:30
1f837340d1
api: Fix confusing documentation about services for botserver.
...
This fixes several super-confusing things in these docs. Bot services
aren't a user-facing concept, and also, you need the URL before
creating the bot users.
2018-05-14 09:21:45 -07:00
485d5b6335
api: Fix incorrectly coded bullet for zulip_botserver config.
2018-05-14 09:21:45 -07:00
e591668d60
bot-docs: Rewrite last section of "Running bots".
2018-05-14 04:27:36 -07:00
3952f94157
minor: Add missing period to bot-docs.
2018-05-14 04:27:36 -07:00
Vishnu Ks
Rafid Aslam
Tim Abbott
Rohitt Vashishtha
Alex Dehnert
Hemanth V. Alluri
Mateusz Mandera
meiomorphism
Vinit Singh
sameerchoubey
Anders Kaseorg
Yago González
Priyank Patel
Eeshan Garg
Puneeth Chaganti
aswanthkoleri
sahil839
Adarsh Patel
Anders Kaseorg
Joshua Pan
Roger Souza
Steve Howell
Roman Godov
Rishi Gupta
Callum Fraser
Lyla Fischer
Rhea Parekh
Cynthia Lin
Robert Hönig
vaibhav