zulip/docs
Steve Howell b26f2dcd4b typing: Deprecate emails in typing endpoint.
The only clients that should use the typing
indicators endpoint are our internal clients,
and they should send a JSON-formatted list
of user_ids.

Unfortunately, we still have some older versions
of mobile that still send emails.

In this commit we fix non-user-facing things
like docs and tests to promote the user_ids
interface that has existed since about version
2.0 of the server.

One annoyance is that we documented the
typing endpoint with emails, instead of the
more modern user_ids, which may have delayed
mobile converting to user_ids (and which
certainly caused confusion).  It's trivial
to update the docs, but we need to short
circuit one assertion in the openapi tests.

We also clean up the test structure for the
typing tests:

    TypingHappyPathTest.test_start_to_another_user
    TypingHappyPathTest.test_start_to_multiple_recipients
    TypingHappyPathTest.test_start_to_self
    TypingHappyPathTest.test_start_to_single_recipient
    TypingHappyPathTest.test_stop_to_another_user
    TypingHappyPathTest.test_stop_to_self

    TypingValidateOperatorTest.test_invalid_parameter
    TypingValidateOperatorTest.test_missing_parameter

    TypingValidateUsersTest.test_argument_to_is_not_valid_json
    TypingValidateUsersTest.test_bogus_user_id
    TypingValidateUsersTest.test_empty_array
    TypingValidateUsersTest.test_missing_recipient

    TypingValidationHelpersTest.test_recipient_for_user_ids
    TypingValidationHelpersTest.test_recipient_for_user_ids_non_existent_id

    TypingLegacyMobileSupportTest.test_legacy_email_interface
2020-02-28 12:39:36 -08:00
..
_static install docs: Tighten "create organization" step. 2018-03-06 19:43:02 -08:00
_templates docs: Split maintain-secure-upgrade into dedicated docs. 2019-11-22 10:21:20 -08:00
contributing docs: Tweak commit message guidelines. 2020-02-24 17:56:36 -08:00
development auth: Add support for GitLab authentication. 2020-02-11 13:54:17 -08:00
documentation docs: Update swagger example to suit V3.0.1. 2020-01-28 14:48:09 -08:00
git docs: link to more-currently-maintained fork of GitX 2020-01-09 16:06:37 -08:00
images docs: Update docs/git/ directory to reflect CI changes. 2018-12-11 12:46:18 -08:00
overview docs: Fix changelog typo. 2020-02-27 12:21:30 -08:00
production docs: Change our security contact to security@. 2020-02-26 16:35:29 -08:00
subsystems typing: Deprecate emails in typing endpoint. 2020-02-28 12:39:36 -08:00
testing docs: Replace casperjs.org links. 2020-02-27 11:03:31 -08:00
translating docs: Update link to Handlebars Block Helpers. 2020-02-25 11:48:43 -08:00
tutorials docs: Replace links to Django 1.11 docs with 2.2 links. 2020-02-19 11:51:18 -08:00
.gitignore gitignore: Anchor patterns that should be anchored. 2017-07-19 14:03:49 -07:00
code-of-conduct.md repository: Add CODE_OF_CONDUCT.md. 2017-06-14 18:43:08 -07:00
conf.py docs: Remove build warning. 2019-12-02 17:29:55 -08:00
index.rst docs: Add missing index.rst for documentation/. 2019-05-29 17:54:02 -07:00
Makefile docs: Replace Makefile based on output of newer sphinx-quickstart. 2019-12-02 18:39:33 -08:00
README.md docs: Add README.md to zulip/docs to prevent reading on GitHub. 2018-04-24 10:50:39 -07:00
requirements.readthedocs.txt requirements: Rename requirements files. 2017-11-21 02:38:26 +05:30
THIRDPARTY upload: Replace jQuery filedrop with Uppy. 2020-02-13 16:43:19 -08:00

Zulip markdown documentation hosted elsewhere

The markdown files in this directory ( /zulip/docs ) are not intended to be read on GitHub. Instead, visit our ReadTheDocs to read the Zulip documentation.