mirror of
https://github.com/LukeHagar/connexion.git
synced 2025-12-06 04:19:26 +00:00
1211d1b655
This PR is a proposal to enforce defaults in json bodies. The standard JsonRequestBodyValidator does not adapt the body. Instead, I added a DefaultsJsonRequestBodyValidator which does. The user can easily activate enforcing default by passing this Validator in a validator_map. I would have liked connexion to have an enforce_defaults flag, but it would be hard to make this compatible with the validator_map argument.
========================
Custom Validator Example
========================
.. warning::
This example is outdated. Currently validation no longer adapts the body.
TODO: decide if validation should adapt body or how we want to enable defaults otherwise.
In this example we fill-in non-provided properties with their defaults.
Validator code is based on example from `python-jsonschema docs`_.
Running:
.. code-block:: bash
$ python app.py
Now open your browser and go to http://localhost:8080/v1/ui/ to see the Swagger
UI. If you send a ``POST`` request with empty body ``{}``, you should receive
echo with defaults filled-in.
.. _python-jsonschema docs: https://python-jsonschema.readthedocs.io/en/latest/faq/#why-doesn-t-my-schema-that-has-a-default-property-actually-set-the-default-on-my-instance