openstack/manila-specs
Code Issues Proposed changes

Remove pbr warnerrors in favor of sphinx check

Browse Source 
This change removes the now unused "warnerrors" setting,
which is replaced by "warning-is-error" in sphinx
releases >= 1.5[0].

[0] http://lists.openstack.org/pipermail/openstack-dev/2017-March/113085.html

Change-Id: Idb373fb229b783f76755207767b0a1b42516d0be
This commit is contained in:
zhongjun
2017-05-18 15:03:43 +08:00
committed by zhongjun
parent 6b20c77484
commit 233c937cbe
2 changed files with 41 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
setup.cfg
View File

@@ -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

76
specs/pike/like-filter.rst
View File

@@ -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/<tenant_id>/shares?name~=test
GET /v2/<tenant_id>/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/<tenant_id>/snapshots?name~=snap_test
GET /v2/<tenant_id>/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~ <name~>] [--description~ <description~>]
manila list [--name~ <name~>] [--description~ <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::