zulip/zerver/openapi
Lauryn Menard c2bcfb52aa api-tests: Reduce error output for `/register` openapi validation.
For descriptive endpoints, such as `/register`, that might raise
Schema Validation errors via `validate_against_openapi_schema`,
omits the OpenAPI schema definition in the error output.

Also omits the error instance definition in the error output
when it is a jsonschema object with over 100 properties. This
means that the test instance for objects, like user settings,
will be printed in the error output, but the test instance for
the entire endpoint will not be printed to the console.

The omitted output can be thousands of lines long making it
difficult to find the initial console output that actually helps
the contributor with debugging.

Adds a section in "Documenting REST API endpoints" about
debugging and understanding these errors that is linked to
in the error console output.
2023-01-17 14:50:42 -08:00
..
__init__.py openapi: Add missing __init__.py; fix type errors hidden by its absence. 2021-07-05 12:20:39 -07:00
curl_param_value_generators.py realm: Create RealmAuditLog entry when adding realm linkifiers. 2022-07-31 18:32:28 -07:00
javascript_examples.js javascript_examples: Fix unicorn/no-useless-spread. 2022-12-07 09:55:05 -08:00
javascript_examples.py python: Replace universal_newlines with text. 2022-01-23 22:16:01 -08:00
markdown_extension.py ruff: Fix ISC003 Explicitly concatenated string. 2023-01-04 16:25:07 -08:00
openapi.py api-tests: Reduce error output for `/register` openapi validation. 2023-01-17 14:50:42 -08:00
python_examples.py custom_profile_field: Add "Pronouns" custom field type. 2022-10-06 17:56:26 -07:00
test_curl_examples.py api-docs: Move include markdown macro files for API documentation. 2022-12-08 12:58:11 -08:00
testing.yaml test_openapi: Make testing.yml a full conformant specification. 2022-01-13 14:34:11 -08:00
zulip.yaml docs: Link to management commands documentation in user facing docs. 2023-01-10 08:50:00 -08:00