From aff3e8699a47da6fa0faa9573fc3c2eabdf386c9 Mon Sep 17 00:00:00 2001 From: Davanum Srinivas Date: Wed, 21 Jan 2015 22:25:10 -0500 Subject: [PATCH] Cleanup bad JSON files - Add missing commas - Replace single quote with double quote - events field contains a list of events (event-create-req.json) - Remove empty files - Adds a JSON validation test to the docs pipeline Co-Authored-By: Nicolas Simonds Change-Id: I9a4a9b6b8e2da73b5f25145be3b2faa44ebdb340 --- .../admin-actions-reset-state.json | 0 .../os-certificates/certificate-create-req.json | 0 .../floating-ips-create-nopool-req.json | 0 ...ating-ip-dns-create-or-update-entry-req.json | 9 ++++----- .../floating-ip-dns-create-or-update-req.json | 11 +++++------ .../floating-ips-create-nopool-req.json | 0 .../server-post-req.json | 0 .../consoles/consoles-create-req.json | 0 .../os-availability-zone/server-post-req.json | 2 +- .../os-certificates/certificate-create-req.json | 0 .../floating-ips-bulk-create-req.json | 2 +- .../floating-ips-create-nopool-req.json | 0 .../event-create-req.json | 17 +++++++++-------- tox.ini | 4 +++- 14 files changed, 23 insertions(+), 22 deletions(-) delete mode 100644 doc/api_samples/os-admin-actions/admin-actions-reset-state.json delete mode 100644 doc/api_samples/os-certificates/certificate-create-req.json delete mode 100644 doc/api_samples/os-extended-floating-ips/floating-ips-create-nopool-req.json delete mode 100644 doc/api_samples/os-floating-ips/floating-ips-create-nopool-req.json delete mode 100644 doc/api_samples/os-hide-server-addresses/server-post-req.json delete mode 100644 doc/v3/api_samples/consoles/consoles-create-req.json delete mode 100644 doc/v3/api_samples/os-certificates/certificate-create-req.json delete mode 100644 doc/v3/api_samples/os-floating-ips/floating-ips-create-nopool-req.json diff --git a/doc/api_samples/os-admin-actions/admin-actions-reset-state.json b/doc/api_samples/os-admin-actions/admin-actions-reset-state.json deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/doc/api_samples/os-certificates/certificate-create-req.json b/doc/api_samples/os-certificates/certificate-create-req.json deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/doc/api_samples/os-extended-floating-ips/floating-ips-create-nopool-req.json b/doc/api_samples/os-extended-floating-ips/floating-ips-create-nopool-req.json deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-entry-req.json b/doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-entry-req.json index 934ed21b20..77b8fdb6be 100644 --- a/doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-entry-req.json +++ b/doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-entry-req.json @@ -1,7 +1,6 @@ { - 'dns_entry' : - { - 'ip': '192.168.53.11', - 'dns_type': 'A' - } + "dns_entry": { + "ip": "192.168.53.11", + "dns_type": "A" + } } \ No newline at end of file diff --git a/doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-req.json b/doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-req.json index 05aac422da..2d517ff2c0 100644 --- a/doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-req.json +++ b/doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-req.json @@ -1,8 +1,7 @@ { - 'domain_entry' : - { - 'domain': 'domain1.example.org', - 'scope': 'public', - 'project': 'project1' - } + "domain_entry": { + "domain": "domain1.example.org", + "scope": "public", + "project": "project1" + } } \ No newline at end of file diff --git a/doc/api_samples/os-floating-ips/floating-ips-create-nopool-req.json b/doc/api_samples/os-floating-ips/floating-ips-create-nopool-req.json deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/doc/api_samples/os-hide-server-addresses/server-post-req.json b/doc/api_samples/os-hide-server-addresses/server-post-req.json deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/doc/v3/api_samples/consoles/consoles-create-req.json b/doc/v3/api_samples/consoles/consoles-create-req.json deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/doc/v3/api_samples/os-availability-zone/server-post-req.json b/doc/v3/api_samples/os-availability-zone/server-post-req.json index 462360ec4a..021b8d2f1b 100644 --- a/doc/v3/api_samples/os-availability-zone/server-post-req.json +++ b/doc/v3/api_samples/os-availability-zone/server-post-req.json @@ -3,7 +3,7 @@ "name" : "new-server-test", "imageRef" : "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b", "flavorRef" : "http://openstack.example.com/openstack/flavors/1", - "availability_zone" : "test" + "availability_zone" : "test", "metadata" : { "My Server Name" : "Apache1" } diff --git a/doc/v3/api_samples/os-certificates/certificate-create-req.json b/doc/v3/api_samples/os-certificates/certificate-create-req.json deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/doc/v3/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.json b/doc/v3/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.json index d5403b7d88..cdc4849b5b 100644 --- a/doc/v3/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.json +++ b/doc/v3/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.json @@ -1,6 +1,6 @@ { "floating_ips_bulk_create": { - "ip_range": "192.168.1.0/24" + "ip_range": "192.168.1.0/24", "pool": "nova", "interface": "eth0" } diff --git a/doc/v3/api_samples/os-floating-ips/floating-ips-create-nopool-req.json b/doc/v3/api_samples/os-floating-ips/floating-ips-create-nopool-req.json deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/doc/v3/api_samples/os-server-external-events/event-create-req.json b/doc/v3/api_samples/os-server-external-events/event-create-req.json index 215c3efd4a..8cd7ce2b05 100644 --- a/doc/v3/api_samples/os-server-external-events/event-create-req.json +++ b/doc/v3/api_samples/os-server-external-events/event-create-req.json @@ -1,9 +1,10 @@ { - "events": {[ - { - "name": "test-event", - "tag": "foo", - "status": "completed", - "server_uuid": "3df201cf-2451-44f2-8d25-a4ca826fc1f3" - }]} -} + "events": [ + { + "name": "test-event", + "tag": "foo", + "status": "completed", + "server_uuid": "3df201cf-2451-44f2-8d25-a4ca826fc1f3" + } + ] +} \ No newline at end of file diff --git a/tox.ini b/tox.ini index 74d7d469a1..cb15a3b041 100644 --- a/tox.ini +++ b/tox.ini @@ -59,7 +59,9 @@ commands = commands = {posargs} [testenv:docs] -commands = python setup.py build_sphinx +commands = + 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' [flake8] # E125 is deliberately excluded. See https://github.com/jcrocholl/pep8/issues/126