mirror of
https://github.com/zulip/zulip.git
synced 2025-10-23 04:52:12 +00:00
c2bcfb52aa
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.
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.