zulip/zerver/openapi
Lauryn Menard e9bfdd1bf2 response: Implement ignored parameters with MutableJsonResponse class.
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.
2023-03-06 10:33:13 -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 upload: Rename upload_message_file to use word "attachment". 2023-03-02 16:36:19 -08: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 black: Reformat with Black 23. 2023-02-02 10:40:13 -08:00
openapi.py black: Reformat with Black 23. 2023-02-02 10:40:13 -08:00
python_examples.py black: Reformat with Black 23. 2023-02-02 10:40:13 -08:00
test_curl_examples.py api-docs: Move markdown files to top level directory. 2023-02-02 17:25:40 -08:00
testing.yaml test_openapi: Make testing.yml a full conformant specification. 2022-01-13 14:34:11 -08:00
zulip.yaml response: Implement ignored parameters with MutableJsonResponse class. 2023-03-06 10:33:13 -08:00