openstack/nova
Code Issues Proposed changes

Fix api-ref with Sphinx 1.5

Browse Source 
Sphinx 1.5 is more picky about highlighting and currently building of
api-ref fails with:

Warning, treated as error:
/home/aj/Software/vcs/OpenStack/openstack/nova/api-ref/source/index.rst:4:
WARNING: Could not lex literal_block as "json". Highlighting skipped.

Fix problems found:
Remove duplicate "progress: 0" from
os-rescue/server-get-resp-unrescue.json,
os-server-tags/v2.26/servers-tags-details-resp.json,
os-server-tags/v2.26/server-tags-show-details-resp.json.

Change json to javascript for highlighting of delete_info.

Change-Id: I7cd969fb4c9d4bff995c34725cfb739cccaba12c
This commit is contained in:
Andreas Jaeger
2017-03-03 11:44:59 +01:00
parent e88dd0034b
commit 7ad3807500
4 changed files with 1 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
api-ref/source/parameters.yaml
View File

@@ -340,7 +340,7 @@ delete_info:
Information for snapshot deletion. Include the ID of the associated volume. For Information for snapshot deletion. Include the ID of the associated volume. For
example: example:
.. code-block:: json .. code-block:: javascript
DELETE /os-assisted-volume-snapshots?delete_info='{"volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c"}' DELETE /os-assisted-volume-snapshots?delete_info='{"volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c"}'
in: query in: query

1
doc/api_samples/os-rescue/server-get-resp-unrescue.json
View File

@@ -65,7 +65,6 @@
"os-extended-volumes:volumes_attached": [], "os-extended-volumes:volumes_attached": [],
"OS-SRV-USG:launched_at": "2013-09-23T13:37:00.880302", "OS-SRV-USG:launched_at": "2013-09-23T13:37:00.880302",
"OS-SRV-USG:terminated_at": null, "OS-SRV-USG:terminated_at": null,
"progress": 0,
"security_groups": [ "security_groups": [
{ {
"name": "default" "name": "default"

1
doc/api_samples/os-server-tags/v2.26/server-tags-show-details-resp.json
View File

@@ -75,7 +75,6 @@
"os-extended-volumes:volumes_attached": [], "os-extended-volumes:volumes_attached": [],
"OS-SRV-USG:launched_at": "2013-09-23T13:37:00.880302", "OS-SRV-USG:launched_at": "2013-09-23T13:37:00.880302",
"OS-SRV-USG:terminated_at": null, "OS-SRV-USG:terminated_at": null,
"progress": 0,
"security_groups": [ "security_groups": [
{ {
"name": "default" "name": "default"

1
doc/api_samples/os-server-tags/v2.26/servers-tags-details-resp.json
View File

@@ -76,7 +76,6 @@
"os-extended-volumes:volumes_attached": [], "os-extended-volumes:volumes_attached": [],
"OS-SRV-USG:launched_at": "2013-09-23T13:53:12.774549", "OS-SRV-USG:launched_at": "2013-09-23T13:53:12.774549",
"OS-SRV-USG:terminated_at": null, "OS-SRV-USG:terminated_at": null,
"progress": 0,
"security_groups": [ "security_groups": [
{ {
"name": "default" "name": "default"