From c3d7880ed62e8862908b523114138dda8dad5203 Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Wed, 3 Jul 2019 13:22:33 -0500 Subject: [PATCH] Cleanup api-ref sample files Updates have been made to the api-ref sample files where some of them have been moved under subdirectories to better organize things. A few of the old files were left behind in doing this, and a few were added without updating the files that referenced them. This cleans a few of those cases up. Change-Id: I58c8f2f2e533476385f1ec510fe04e31bceb64cc Signed-off-by: Sean McGinnis --- .../v3/samples/extensions-list-response.json | 212 ------------------ .../v3/samples/snapshot-manage-response.json | 17 -- .../volumes-list-detailed-response.json | 105 --------- .../v3/samples/volumes-list-response.json | 37 --- .../volumes-list-summary-response.json | 0 api-ref/source/v3/snapshot-manage.inc | 2 +- api-ref/source/v3/volumes-v3-volumes.inc | 2 +- 7 files changed, 2 insertions(+), 373 deletions(-) delete mode 100644 api-ref/source/v3/samples/extensions-list-response.json delete mode 100644 api-ref/source/v3/samples/snapshot-manage-response.json delete mode 100644 api-ref/source/v3/samples/volumes-list-detailed-response.json delete mode 100644 api-ref/source/v3/samples/volumes-list-response.json rename api-ref/source/v3/samples/{ => volumes}/volumes-list-summary-response.json (100%) diff --git a/api-ref/source/v3/samples/extensions-list-response.json b/api-ref/source/v3/samples/extensions-list-response.json deleted file mode 100644 index 775bc54d5ca..00000000000 --- a/api-ref/source/v3/samples/extensions-list-response.json +++ /dev/null @@ -1,212 +0,0 @@ -{ - "extensions": [ - { - "updated": "2013-04-18T00:00:00+00:00", - "name": "SchedulerHints", - "links": [], - "namespace": "https://docs.openstack.org/block-service/ext/scheduler-hints/api/v3", - "alias": "OS-SCH-HNT", - "description": "Pass arbitrary key/value pairs to the scheduler." - }, - { - "updated": "2011-06-29T00:00:00+00:00", - "name": "Hosts", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/hosts/api/v1.1", - "alias": "os-hosts", - "description": "Admin-only host administration." - }, - { - "updated": "2011-11-03T00:00:00+00:00", - "name": "VolumeTenantAttribute", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/volume_tenant_attribute/api/v1", - "alias": "os-vol-tenant-attr", - "description": "Expose the internal project_id as an attribute of a volume." - }, - { - "updated": "2011-08-08T00:00:00+00:00", - "name": "Quotas", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/quotas-sets/api/v1.1", - "alias": "os-quota-sets", - "description": "Quota management support." - }, - { - "updated": "2011-08-24T00:00:00+00:00", - "name": "TypesManage", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/types-manage/api/v1", - "alias": "os-types-manage", - "description": "Types manage support." - }, - { - "updated": "2013-07-10T00:00:00+00:00", - "name": "VolumeEncryptionMetadata", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/os-volume-encryption-metadata/api/v1", - "alias": "os-volume-encryption-metadata", - "description": "Volume encryption metadata retrieval support." - }, - { - "updated": "2012-12-12T00:00:00+00:00", - "name": "Backups", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/backups/api/v1", - "alias": "backups", - "description": "Backups support." - }, - { - "updated": "2013-07-16T00:00:00+00:00", - "name": "SnapshotActions", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/snapshot-actions/api/v1.1", - "alias": "os-snapshot-actions", - "description": "Enable snapshot manager actions." - }, - { - "updated": "2012-05-31T00:00:00+00:00", - "name": "VolumeActions", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/volume-actions/api/v1.1", - "alias": "os-volume-actions", - "description": "Enable volume actions\n " - }, - { - "updated": "2013-10-03T00:00:00+00:00", - "name": "UsedLimits", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/used-limits/api/v1.1", - "alias": "os-used-limits", - "description": "Provide data on limited resources that are being used." - }, - { - "updated": "2012-05-31T00:00:00+00:00", - "name": "VolumeUnmanage", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/volume-unmanage/api/v1.1", - "alias": "os-volume-unmanage", - "description": "Enable volume unmanage operation." - }, - { - "updated": "2011-11-03T00:00:00+00:00", - "name": "VolumeHostAttribute", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/volume_host_attribute/api/v1", - "alias": "os-vol-host-attr", - "description": "Expose host as an attribute of a volume." - }, - { - "updated": "2013-07-01T00:00:00+00:00", - "name": "VolumeTypeEncryption", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/volume-type-encryption/api/v1", - "alias": "encryption", - "description": "Encryption support for volume types." - }, - { - "updated": "2013-06-27T00:00:00+00:00", - "name": "AvailabilityZones", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/os-availability-zone/api/v1", - "alias": "os-availability-zone", - "description": "Describe Availability Zones." - }, - { - "updated": "2013-08-02T00:00:00+00:00", - "name": "Qos_specs_manage", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/qos-specs/api/v1", - "alias": "qos-specs", - "description": "QoS specs support." - }, - { - "updated": "2011-08-24T00:00:00+00:00", - "name": "TypesExtraSpecs", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/types-extra-specs/api/v1", - "alias": "os-types-extra-specs", - "description": "Type extra specs support." - }, - { - "updated": "2013-08-08T00:00:00+00:00", - "name": "VolumeMigStatusAttribute", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/volume_mig_status_attribute/api/v1", - "alias": "os-vol-mig-status-attr", - "description": "Expose migration_status as an attribute of a volume." - }, - { - "updated": "2012-08-13T00:00:00+00:00", - "name": "CreateVolumeExtension", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/image-create/api/v1", - "alias": "os-image-create", - "description": "Allow creating a volume from an image in the Create Volume API." - }, - { - "updated": "2014-01-10T00:00:00-00:00", - "name": "ExtendedServices", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/extended_services/api/v3", - "alias": "os-extended-services", - "description": "Extended services support." - }, - { - "updated": "2012-06-19T00:00:00+00:00", - "name": "ExtendedSnapshotAttributes", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/extended_snapshot_attributes/api/v1", - "alias": "os-extended-snapshot-attributes", - "description": "Extended SnapshotAttributes support." - }, - { - "updated": "2012-12-07T00:00:00+00:00", - "name": "VolumeImageMetadata", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/volume_image_metadata/api/v1", - "alias": "os-vol-image-meta", - "description": "Show image metadata associated with the volume." - }, - { - "updated": "2012-03-12T00:00:00+00:00", - "name": "QuotaClasses", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/quota-classes-sets/api/v1.1", - "alias": "os-quota-class-sets", - "description": "Quota classes management support." - }, - { - "updated": "2013-05-29T00:00:00+00:00", - "name": "VolumeTransfer", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/volume-transfer/api/v1.1", - "alias": "os-volume-transfer", - "description": "Volume transfer management support." - }, - { - "updated": "2014-02-10T00:00:00+00:00", - "name": "VolumeManage", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/os-volume-manage/api/v1", - "alias": "os-volume-manage", - "description": "Allows existing backend storage to be 'managed' by Cinder." - }, - { - "updated": "2012-08-25T00:00:00+00:00", - "name": "AdminActions", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/admin-actions/api/v1.1", - "alias": "os-admin-actions", - "description": "Enable admin actions." - }, - { - "updated": "2012-10-28T00:00:00-00:00", - "name": "Services", - "links": [], - "namespace": "https://docs.openstack.org/volume/ext/services/api/v3", - "alias": "os-services", - "description": "Services support." - } - ] -} diff --git a/api-ref/source/v3/samples/snapshot-manage-response.json b/api-ref/source/v3/samples/snapshot-manage-response.json deleted file mode 100644 index 7aece20cdaa..00000000000 --- a/api-ref/source/v3/samples/snapshot-manage-response.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "snapshot": { - "status": "creating", - "size": 1, - "metadata": { - "manage-snap-meta1": "value1", - "manage-snap-meta3": "value3", - "manage-snap-meta2": "value2" - }, - "name": "tempest-SnapshotManageAdminTest-Managed-Snapshot-1317877679", - "volume_id": "1df34919-aba7-4a1b-a614-3b409d71ac03", - "created_at": "2018-09-26T03:45:03.893592", - "description": "tempest-SnapshotManageAdminTest-Managed-Snapshot-Description-49497381", - "id": "b6314a71-9d3d-439a-861d-b790def0d693", - "updated_at": null - } -} diff --git a/api-ref/source/v3/samples/volumes-list-detailed-response.json b/api-ref/source/v3/samples/volumes-list-detailed-response.json deleted file mode 100644 index 82a21d737ce..00000000000 --- a/api-ref/source/v3/samples/volumes-list-detailed-response.json +++ /dev/null @@ -1,105 +0,0 @@ -{ - "volumes": [ - { - "migration_status": null, - "attachments": [ - { - "server_id": "f4fda93b-06e0-4743-8117-bc8bcecd651b", - "attachment_id": "3b4db356-253d-4fab-bfa0-e3626c0b8405", - "host_name": null, - "volume_id": "6edbc2f4-1507-44f8-ac0d-eed1d2608d38", - "device": "/dev/vdb", - "id": "6edbc2f4-1507-44f8-ac0d-eed1d2608d38" - } - ], - "links": [ - { - "href": "http://23.253.248.171:8776/v3/bab7d5c60cd041a0a36f7c4b6e1dd978/volumes/6edbc2f4-1507-44f8-ac0d-eed1d2608d38", - "rel": "self" - }, - { - "href": "http://23.253.248.171:8776/bab7d5c60cd041a0a36f7c4b6e1dd978/volumes/6edbc2f4-1507-44f8-ac0d-eed1d2608d38", - "rel": "bookmark" - } - ], - "availability_zone": "nova", - "os-vol-host-attr:host": "difleming@lvmdriver-1#lvmdriver-1", - "encrypted": false, - "replication_status": "disabled", - "snapshot_id": null, - "id": "6edbc2f4-1507-44f8-ac0d-eed1d2608d38", - "size": 2, - "user_id": "32779452fcd34ae1a53a797ac8a1e064", - "os-vol-tenant-attr:tenant_id": "bab7d5c60cd041a0a36f7c4b6e1dd978", - "os-vol-mig-status-attr:migstat": null, - "metadata": { - "readonly": false, - "attached_mode": "rw" - }, - "status": "in-use", - "description": null, - "multiattach": true, - "source_volid": null, - "consistencygroup_id": null, - "os-vol-mig-status-attr:name_id": null, - "name": "test-volume-attachments", - "bootable": "false", - "created_at": "2015-11-29T03:01:44.000000", - "volume_type": "lvmdriver-1", - "group_id": "8fbe5733-eb03-4c88-9ef9-f32b7d03a5e4" - }, - { - "migration_status": null, - "attachments": [], - "links": [ - { - "href": "http://23.253.248.171:8776/v3/bab7d5c60cd041a0a36f7c4b6e1dd978/volumes/173f7b48-c4c1-4e70-9acc-086b39073506", - "rel": "self" - }, - { - "href": "http://23.253.248.171:8776/bab7d5c60cd041a0a36f7c4b6e1dd978/volumes/173f7b48-c4c1-4e70-9acc-086b39073506", - "rel": "bookmark" - } - ], - "availability_zone": "nova", - "os-vol-host-attr:host": "difleming@lvmdriver-1#lvmdriver-1", - "encrypted": false, - "replication_status": "disabled", - "snapshot_id": null, - "id": "173f7b48-c4c1-4e70-9acc-086b39073506", - "size": 1, - "user_id": "32779452fcd34ae1a53a797ac8a1e064", - "os-vol-tenant-attr:tenant_id": "bab7d5c60cd041a0a36f7c4b6e1dd978", - "os-vol-mig-status-attr:migstat": null, - "metadata": {}, - "status": "available", - "volume_image_metadata": { - "kernel_id": "8a55f5f1-78f7-4477-8168-977d8519342c", - "checksum": "eb9139e4942121f22bbc2afc0400b2a4", - "min_ram": "0", - "ramdisk_id": "5f6bdf8a-92db-4988-865b-60bdd808d9ef", - "disk_format": "ami", - "image_name": "cirros-0.3.4-x86_64-uec", - "image_id": "b48c53e1-9a96-4a5a-a630-2e74ec54ddcc", - "container_format": "ami", - "min_disk": "0", - "size": "25165824" - }, - "description": "", - "multiattach": false, - "source_volid": null, - "consistencygroup_id": null, - "os-vol-mig-status-attr:name_id": null, - "name": "test-volume", - "bootable": "true", - "created_at": "2015-11-29T02:25:18.000000", - "volume_type": "lvmdriver-1", - "group_id": "8fbe5733-eb03-4c88-9ef9-f32b7d03a5e4" - } - ], - "volumes_links": [{ - "href": "https://158.69.65.111/volume/v3/4ad9f06ab8654e40befa59a2e7cac86d/volumes/detail?limit=1&marker=3b451d5d-9358-4a7e-a746-c6fd8b0e1462", - "rel": "next" - }], - "count": 10 -} diff --git a/api-ref/source/v3/samples/volumes-list-response.json b/api-ref/source/v3/samples/volumes-list-response.json deleted file mode 100644 index 29e737abfda..00000000000 --- a/api-ref/source/v3/samples/volumes-list-response.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "volumes": [ - { - "id": "45baf976-c20a-4894-a7c3-c94b7376bf55", - "links": [ - { - "href": "http://localhost:8776/v3/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/45baf976-c20a-4894-a7c3-c94b7376bf55", - "rel": "self" - }, - { - "href": "http://localhost:8776/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/45baf976-c20a-4894-a7c3-c94b7376bf55", - "rel": "bookmark" - } - ], - "name": "vol-004" - }, - { - "id": "5aa119a8-d25b-45a7-8d1b-88e127885635", - "links": [ - { - "href": "http://localhost:8776/v3/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/5aa119a8-d25b-45a7-8d1b-88e127885635", - "rel": "self" - }, - { - "href": "http://localhost:8776/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/5aa119a8-d25b-45a7-8d1b-88e127885635", - "rel": "bookmark" - } - ], - "name": "vol-003" - } - ], - "volumes_links": [{ - "href": "https://158.69.65.111/volume/v3/4ad9f06ab8654e40befa59a2e7cac86d/volumes/detail?limit=1&marker=3b451d5d-9358-4a7e-a746-c6fd8b0e1462", - "rel": "next" - }], - "count": 10 -} diff --git a/api-ref/source/v3/samples/volumes-list-summary-response.json b/api-ref/source/v3/samples/volumes/volumes-list-summary-response.json similarity index 100% rename from api-ref/source/v3/samples/volumes-list-summary-response.json rename to api-ref/source/v3/samples/volumes/volumes-list-summary-response.json diff --git a/api-ref/source/v3/snapshot-manage.inc b/api-ref/source/v3/snapshot-manage.inc index c649b67f5d8..6d54edbfa13 100644 --- a/api-ref/source/v3/snapshot-manage.inc +++ b/api-ref/source/v3/snapshot-manage.inc @@ -72,7 +72,7 @@ Response Response Example ---------------- -.. literalinclude:: ./samples/snapshot-manage-response.json +.. literalinclude:: ./samples/snapshot_manage_extensions/snapshot-manage-response.json :language: javascript diff --git a/api-ref/source/v3/volumes-v3-volumes.inc b/api-ref/source/v3/volumes-v3-volumes.inc index 487da8d1515..f46176ed4d9 100644 --- a/api-ref/source/v3/volumes-v3-volumes.inc +++ b/api-ref/source/v3/volumes-v3-volumes.inc @@ -797,5 +797,5 @@ Response Parameters Response Example ---------------- -.. literalinclude:: ./samples/volumes-list-summary-response.json +.. literalinclude:: ./samples/volumes/volumes-list-summary-response.json :language: javascript