mirror of https://github.com/zulip/zulip.git
e9bfdd1bf2
Creates `MutableJsonResponse` as a subclass of Django's `HttpResponse` that we can modify for ignored parameters in the response content. Updates responses to include `ignored_parameters_unsupported` in the response data through `has_request_variables`. Creates unit test for this implementation in `test_decorators.py`. The `method` parameter processed in `rest_dispatch` is not in the `REQ` framework, so for any tests that pass that parameter, assert for the ignored parameter with a comment. Updates OpenAPI documentation for `ignored_parameters_unsupported` being returned in the JSON success response for all endpoints. Adds detailed documentation in the error handling article, and links to that page in relevant locations throughout the API docs. For the majority of endpoints, the documentation does not include the array in any examples of return values, and instead links to the error handling page. The exceptions are the three endpoints that had previously supported this return value. The changes note and example for these endpoints is also used in the error handling page. |
||
|---|---|---|
| .. | ||
| include | ||
| api-doc-template.md | ||
| api-keys.md | ||
| changelog.md | ||
| client-libraries.md | ||
| configuring-python-bindings.md | ||
| construct-narrow.md | ||
| create-stream.md | ||
| deploying-bots.md | ||
| incoming-webhooks-overview.md | ||
| incoming-webhooks-walkthrough.md | ||
| index.md | ||
| installation-instructions.md | ||
| integrations-overview.md | ||
| mark-all-as-read.md | ||
| missing.md | ||
| non-webhook-integrations.md | ||
| outgoing-webhooks.md | ||
| real-time-events.md | ||
| rest-error-handling.md | ||
| rest.md | ||
| roles-and-permissions.md | ||
| running-bots.md | ||
| send-message.md | ||
| sidebar_index.md | ||
| writing-bots.md | ||