diff --git a/setup.cfg b/setup.cfg index 52f79b7..32338b9 100644 --- a/setup.cfg +++ b/setup.cfg @@ -17,9 +17,8 @@ classifier = source-dir = doc/source build-dir = doc/build all_files = 1 - -[pbr] -warnerrors = True +builders = html +warning-is-error = 1 [upload_sphinx] upload-dir = doc/build/html diff --git a/specs/pike/like-filter.rst b/specs/pike/like-filter.rst index 9224943..5e8d21d 100644 --- a/specs/pike/like-filter.rst +++ b/specs/pike/like-filter.rst @@ -90,54 +90,54 @@ Microversion bump is required for this change. * Add ``name~`` and ``description~`` parameter to list API interfaces. It means we can use this new parameter to inexact filtering:: - List shares with share name + List shares with share name - GET /v2//shares?name~=test + GET /v2//shares?name~=test - Accept: application/json + Accept: application/json - JSON Response + JSON Response - { - "shares": [ + { + "shares": [ + { + "status": "available", + "export_location": %ip%:/opt/stack/data/manila/mnt/share-%share_id%, + "name": "test_1", + ... + }, { - "status": "available", - "export_location": %ip%:/opt/stack/data/manila/mnt/share-%share_id%, - "name": "test_1", - ... - }, - { - "status": "available", - "export_location": null, - "name": "2_test", - ... - } - ] - } + "status": "available", + "export_location": null, + "name": "2_test", + ... + } + ] + } -List snapshot with share snapshot name + List snapshot with share snapshot name -GET /v2//snapshots?name~=snap_test + GET /v2//snapshots?name~=snap_test -Accept: application/json + Accept: application/json -JSON Response + JSON Response -{ - "shares": [ - { - "status": "available", - "name": "snap_test_1", - ... - }, - { - "status": "available", - "name": "snap_test_xxxxx", - ... - } - ] -} + { + "shares": [ + { + "status": "available", + "name": "snap_test_1", + ... + }, + { + "status": "available", + "name": "snap_test_xxxxx", + ... + } + ] + } Client impact ------------- @@ -145,7 +145,7 @@ Client impact The Manila client will add a new command argument '--name~' and '--description~' to 'list' to filter manila resource by inexact match:: - manila list [--name~ ] [--description~ ] + manila list [--name~ ] [--description~ ] We assuming we have two shares in the name of'test_1', '2_test', usually we would get none of them if type this command:: @@ -231,4 +231,4 @@ _`[1]`: https://review.openstack.org/#/c/45026/ _`[2]`: https://review.openstack.org/#/c/266688/ _`[3]`: https://en.wikipedia.org/wiki/ReDoS _`[4]`: https://review.openstack.org/#/c/442982/ -_`[5]`: https://review.openstack.org/#/c/441516/ \ No newline at end of file +_`[5]`: https://review.openstack.org/#/c/441516/