openstack/neutron
Code Issues Proposed changes

Deprecate allow_sorting and allow_pagination options

Browse Source 
There is no technical reason to disable sorting and pagination, except
maybe performance concerns. But there are other ways to DoS-attack
neutron-server services, like... any other type of request. So the
concern is moot.

Keeping those options available for configuration reduces compatibility
between Neutron installations. It's better to do the right thing, and do
it right, implementing the feature for the benefit of API users.

DocImpact Update configuration documentation to reflect deprecation.

Change-Id: Iad26221a58589b10381f1a0d69a88c92fb5adeee
Related-Bug: #1566514
This commit is contained in:
Ihar Hrachyshka 2016-06-16 13:41:23 +02:00 committed by Assaf Muller
parent 9733cc2552
commit fdf66024d3
2 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
neutron/conf/common.py
View File

@ -54,9 +54,14 @@ core_opts = [
cfg.BoolOpt('allow_bulk', default=True,
help=_("Allow the usage of the bulk API")),
cfg.BoolOpt('allow_pagination', default=True,
help=_("Allow the usage of the pagination")),
deprecated_for_removal=True,
help=_("Allow the usage of the pagination. This option has "
"been deprecated and will now be enabled "
"unconditionally.")),
cfg.BoolOpt('allow_sorting', default=True,
help=_("Allow the usage of the sorting")),
deprecated_for_removal=True,
help=_("Allow the usage of the sorting. This option has been "
"deprecated and will now be enabled unconditionally.")),
cfg.StrOpt('pagination_max_limit', default="-1",
help=_("The maximum number of items returned in a single "
"response, value was 'infinite' or negative integer "

4
releasenotes/notes/deprecate-allow-sorting-allow-pagination-4549c92a74cfe15d.yaml Normal file
View File

@ -0,0 +1,4 @@
---
deprecations:
- The ``allow_sorting`` and ``allow_pagination`` configuration options
are deprecated and will be removed in a future release.