2b1d8ea4a2
Enforce validation on filter parameters on list requests. If an API request contains an unknown or unsupported parameter, the server will return a 400 response instead of silently ignoring the invalid input. In resource attributes map, all filter parameters are annotated by the ``is_filter`` keyword. Attributes with is_filter set to True are candidates for validation. Enabling filter validation requires support from core plugin and all service plugins so each plugin need to indicate if it supports the validation by setting ``__filter_validation_support`` to True. If this field is not set, the default is False and validation is turned off. Right now, the ML2 plugin and all the in-tree service plugin support filter validation. Out-of-tree plugins will have filter validation disabled by default. An API extension is introduced to allow API users to discover this new API behavior. This feature can be disabled by cloud operators if they choose to do that. If it is disabled, the extension won't be presented. Depends-On: Ic3ab5b3ffdc378d570678b9c967cb42b0c7a8a9b Depends-On: I4397df1c35463a8b532afdc9c5d28b37224a37b4 Depends-On: I3f2e6e861adaeef81a1a5819a57b28f5c6281d80 Depends-On: I1189bc9a50308df5c7e18c329f3a1262c90b9e12 Depends-On: I057cd917628c77dd20c0ff7747936c3fec7b4844 Depends-On: I0b24a304cc3466a2c05426cdbb6f9d99f1797edd Change-Id: I21bf8a752813802822fd9966dda6ab3b6c4abfdc Partial-Bug: #1749820
39 lines
1.8 KiB
YAML
39 lines
1.8 KiB
YAML
---
|
|
prelude: >
|
|
Perform validation on filter parameters on listing resources.
|
|
features:
|
|
- |
|
|
Starting from this release, neutron server will perform validation on
|
|
filter parameters on list requests. Neutron will return a 400 response
|
|
if the request contains invalid filter parameters.
|
|
The list of valid parameters is documented in the neutron API reference.
|
|
|
|
Add an API extension ``filter-validation`` to indicate this new API
|
|
behavior. This extension can be disabled by operators via a config option.
|
|
upgrade:
|
|
- |
|
|
Prior to the upgrade, if a request contains an unknown or unsupported
|
|
parameter, the server will silently ignore the invalid input.
|
|
After the upgrade, the server will return a 400 Bad Request response
|
|
instead.
|
|
|
|
API users might observe that requests that received a successful response
|
|
now receive a failure response. If they encounter such experience,
|
|
they are suggested to confirm if the API extension ``filter-validation``
|
|
is present and validate filter parameters in their requests.
|
|
|
|
Operators can disable this feature if they want to maintain
|
|
backward-compatibility. If they choose to do that, the API extension
|
|
``filter-validation`` will not be present and the API behavior is
|
|
unchanged.
|
|
other:
|
|
- |
|
|
Each plugin can decide if it wants to support filter validation by
|
|
setting ``__filter_validation_support`` to True or False. If this field is
|
|
not set, the default value is False.
|
|
Right now, the ML2 plugin and all the in-tree service plugins support
|
|
filter validation. Out-of-tree plugins will have filter validation
|
|
disabled by default but they can turn it on if they choose to.
|
|
For filter validation to be supported, the core plugin and all the
|
|
services plugins in a deployment must support it.
|