Debian Codegraph @

releasenotes/notes/support-filter-validation-fee2cdeedbe8ad76.yaml

raw
1 ---
2 prelude: >
3 Perform validation on filter parameters on listing resources.
4 features:
5 - |
6 Starting from this release, neutron server will perform validation on
7 filter parameters on list requests. Neutron will return a 400 response
8 if the request contains invalid filter parameters.
9 The list of valid parameters is documented in the neutron API reference.
10
11 Add an API extension ``filter-validation`` to indicate this new API
12 behavior. This extension can be disabled by operators via a config option.
13 upgrade:
14 - |
15 Prior to the upgrade, if a request contains an unknown or unsupported
16 parameter, the server will silently ignore the invalid input.
17 After the upgrade, the server will return a 400 Bad Request response
18 instead.
19
20 API users might observe that requests that received a successful response
21 now receive a failure response. If they encounter such experience,
22 they are suggested to confirm if the API extension ``filter-validation``
23 is present and validate filter parameters in their requests.
24
25 Operators can disable this feature if they want to maintain
26 backward-compatibility. If they choose to do that, the API extension
27 ``filter-validation`` will not be present and the API behavior is
28 unchanged.
29 other:
30 - |
31 Each plugin can decide if it wants to support filter validation by
32 setting ``__filter_validation_support`` to True or False. If this field is
33 not set, the default value is False.
34 Right now, the ML2 plugin and all the in-tree service plugins support
35 filter validation. Out-of-tree plugins will have filter validation
36 disabled by default but they can turn it on if they choose to.
37 For filter validation to be supported, the core plugin and all the
38 services plugins in a deployment must support it.