zulip/zerver/lib/markdown
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 requirements: Upgrade Python requirements. 2023-03-05 14:46:28 -08:00
api_arguments_table_generator.py black: Reformat with Black 23. 2023-02-02 10:40:13 -08:00
api_return_values_table_generator.py response: Implement ignored parameters with MutableJsonResponse class. 2023-03-06 10:33:13 -08:00
fenced_code.py ruff: Fix RSE102 Unnecessary parentheses on raised exception. 2023-02-04 16:34:55 -08:00
help_emoticon_translations_table.py markdown: Rename preprocessor_priorities module to priorities. 2022-06-26 17:36:31 -07:00
help_relative_links.py help center: Update relative gear menu macro for organization settings. 2023-01-26 10:17:45 -08:00
help_settings_links.py help: Improve relative settings links for documentation on bots. 2023-02-06 15:06:15 -08:00
include.py ruff: Fix N818 exception name should be named with an Error suffix. 2022-11-17 16:52:00 -08:00
nested_code_blocks.py ruff: Fix SIM102 nested `if` statements. 2023-01-23 11:18:36 -08:00
priorities.py markdown: Rewrite /static/ images to use staticfiles_storage.url. 2023-02-14 17:17:06 -05:00
static.py markdown: Rewrite /static/ images to use staticfiles_storage.url. 2023-02-14 17:17:06 -05:00
tabbed_sections.py help: Document modifying email visibility on sign-up. 2023-02-24 09:30:32 -08:00
testing_mocks.py python: Reformat with Black, except quotes. 2021-02-12 13:11:19 -08:00