Merge "Error on API Guide warnings"
This commit is contained in:
commit
235d1a3795
@ -249,7 +249,8 @@ on compute hosts rather than servers.
|
|||||||
|
|
||||||
- **Aggregates**
|
- **Aggregates**
|
||||||
|
|
||||||
Please see :doc:`aggregates.rst`
|
See `Aggregates developer information
|
||||||
|
<http://docs.openstack.org/developer/nova/aggregates.html>`_.
|
||||||
|
|
||||||
- **Migrations**
|
- **Migrations**
|
||||||
|
|
||||||
|
@ -87,3 +87,8 @@ Contents
|
|||||||
paginated_collections
|
paginated_collections
|
||||||
polling_changes-since_parameter
|
polling_changes-since_parameter
|
||||||
request_and_response_formats
|
request_and_response_formats
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:hidden:
|
||||||
|
|
||||||
|
extra_specs_and_properties
|
||||||
|
@ -150,6 +150,7 @@ be used and interpreted by nova.
|
|||||||
and pagination.
|
and pagination.
|
||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
Precondition:
|
Precondition:
|
||||||
there are 2 servers existing in cloud with following info:
|
there are 2 servers existing in cloud with following info:
|
||||||
|
|
||||||
@ -168,6 +169,7 @@ be used and interpreted by nova.
|
|||||||
**Example: General user query server with administrator only options**
|
**Example: General user query server with administrator only options**
|
||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
Request with non-administrator context:
|
Request with non-administrator context:
|
||||||
GET /servers/detail?locked=1
|
GET /servers/detail?locked=1
|
||||||
Note that 'locked' is not returned through API layer
|
Note that 'locked' is not returned through API layer
|
||||||
@ -189,6 +191,7 @@ be used and interpreted by nova.
|
|||||||
**Example: Administrator query server with administrator only options**
|
**Example: Administrator query server with administrator only options**
|
||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
Request with administrator context:
|
Request with administrator context:
|
||||||
GET /servers/detail?locked=1
|
GET /servers/detail?locked=1
|
||||||
|
|
||||||
@ -213,6 +216,7 @@ be used and interpreted by nova.
|
|||||||
**Example: User query server using exact matching on host**
|
**Example: User query server using exact matching on host**
|
||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
Precondition:
|
Precondition:
|
||||||
Request with administrator context:
|
Request with administrator context:
|
||||||
GET /servers/detail
|
GET /servers/detail
|
||||||
@ -252,6 +256,7 @@ be used and interpreted by nova.
|
|||||||
**Example: Query server using regex matching on name**
|
**Example: Query server using regex matching on name**
|
||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
Precondition:
|
Precondition:
|
||||||
Request with administrator context:
|
Request with administrator context:
|
||||||
GET /servers/detail
|
GET /servers/detail
|
||||||
@ -305,6 +310,7 @@ be used and interpreted by nova.
|
|||||||
regex matching on name**
|
regex matching on name**
|
||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
Precondition:
|
Precondition:
|
||||||
Request with administrator context:
|
Request with administrator context:
|
||||||
GET /servers/detail
|
GET /servers/detail
|
||||||
@ -346,7 +352,7 @@ be used and interpreted by nova.
|
|||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
||||||
- **Speical keys are used to tweek the query**
|
- **Special keys are used to tweek the query**
|
||||||
``changes-since`` returns instances updated after the given time,
|
``changes-since`` returns instances updated after the given time,
|
||||||
``deleted`` return (or exclude) deleted instances and ``soft_deleted``
|
``deleted`` return (or exclude) deleted instances and ``soft_deleted``
|
||||||
modify behavior of 'deleted' to either include or exclude instances whose
|
modify behavior of 'deleted' to either include or exclude instances whose
|
||||||
@ -355,6 +361,7 @@ be used and interpreted by nova.
|
|||||||
**Example: User query server with special keys changes-since**
|
**Example: User query server with special keys changes-since**
|
||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
Precondition:
|
Precondition:
|
||||||
GET /servers/detail
|
GET /servers/detail
|
||||||
|
|
||||||
|
4
tox.ini
4
tox.ini
@ -90,7 +90,7 @@ commands =
|
|||||||
python setup.py build_sphinx
|
python setup.py build_sphinx
|
||||||
bash -c '! find doc/ -type f -name *.json | xargs -t -n1 python -m json.tool 2>&1 > /dev/null | grep -B1 -v ^python'
|
bash -c '! find doc/ -type f -name *.json | xargs -t -n1 python -m json.tool 2>&1 > /dev/null | grep -B1 -v ^python'
|
||||||
oslo-config-generator --config-file=etc/nova/nova-config-generator.conf
|
oslo-config-generator --config-file=etc/nova/nova-config-generator.conf
|
||||||
sphinx-build -b html api-guide/source api-guide/build/html
|
sphinx-build -W -b html api-guide/source api-guide/build/html
|
||||||
|
|
||||||
[testenv:api-guide]
|
[testenv:api-guide]
|
||||||
# This environment is called from CI scripts to test and publish
|
# This environment is called from CI scripts to test and publish
|
||||||
@ -100,7 +100,7 @@ commands =
|
|||||||
# drop the install_command.
|
# drop the install_command.
|
||||||
install_command = pip install -U --force-reinstall {opts} {packages}
|
install_command = pip install -U --force-reinstall {opts} {packages}
|
||||||
commands =
|
commands =
|
||||||
sphinx-build -b html -d api-guide/build/doctrees api-guide/source api-guide/build/html
|
sphinx-build -W -b html -d api-guide/build/doctrees api-guide/source api-guide/build/html
|
||||||
|
|
||||||
[testenv:bandit]
|
[testenv:bandit]
|
||||||
commands = bandit -c bandit.yaml -r nova -n 5 -ll
|
commands = bandit -c bandit.yaml -r nova -n 5 -ll
|
||||||
|
Loading…
Reference in New Issue
Block a user