From 8db0e33a3ade107d456c406b9704aaf6f71da00f Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Mon, 28 Aug 2017 16:30:26 -0500 Subject: [PATCH] api-ref: Remove unused parameter defs During the initial migration of the api-ref docs, there were several parameter definitions pulled over that are not actually used anywhere in the docs. It may be that some of these _should_ be referenced, but at least as of right now they are not. Rather than carrying them around on the chance that they could be used down the road, we should just clean them out for now. Change-Id: Ic9018608b00705c80df05243647f5c81124610df --- api-ref/source/v1/parameters.yaml | 39 ------------- api-ref/source/v2/parameters.yaml | 95 ------------------------------- api-ref/source/v3/parameters.yaml | 50 ---------------- 3 files changed, 184 deletions(-) diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml index b5374b07965..a6f81941060 100644 --- a/api-ref/source/v1/parameters.yaml +++ b/api-ref/source/v1/parameters.yaml @@ -13,12 +13,6 @@ admin_tenant_id: in: path required: false type: string -snapshot_id_1: - description: | - The UUID of the snapshot. - in: path - required: false - type: string tenant_id: description: | The UUID of the tenant in a multi-tenancy cloud. @@ -500,12 +494,6 @@ security_group_rules: in: body required: false type: integer -security_group_rules_1: - description: | - A ``security_group_rules`` object. - in: body - required: true - type: string security_groups: description: | The number of security groups that are allowed @@ -513,19 +501,6 @@ security_groups: in: body required: true type: integer -security_groups_1: - description: | - A ``security_groups`` object. - in: body - required: true - type: string -security_groups_2: - description: | - The number of security groups that are allowed - for each tenant. - in: body - required: false - type: integer size: description: | The size of the volume, in gibibytes (GiB). @@ -546,14 +521,6 @@ snapshot_id: in: body required: false type: string -snapshot_id_2: - description: | - The UUID of the source volume snapshot. The API - creates a new volume snapshot with the same size as the source - volume snapshot. - in: body - required: true - type: string source_replica: description: | The UUID of the replication volume to clone. This was for legacy @@ -568,12 +535,6 @@ source_volid: in: body required: false type: string -source_volid_1: - description: | - The UUID of the source volume. - in: body - required: true - type: string status: description: | The volume status. diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml index 6739be71e62..4c0b87d2f1f 100644 --- a/api-ref/source/v2/parameters.yaml +++ b/api-ref/source/v2/parameters.yaml @@ -102,12 +102,6 @@ quotas_tenant_id: in: path required: true type: string -snapshot_id_1: - description: | - The UUID of the snapshot. - in: path - required: false - type: string tenant_id: description: | The UUID of the tenant in a multi-tenancy cloud. @@ -204,20 +198,6 @@ marker: in: query required: false type: string -metadata_query: - description: | - Filters results by a metadata key and value pair. - Default=None. - in: query - required: true - type: object -migration_status_query: - description: | - Filters results by a migration status. Default=None. - Admin only. - in: query - required: false - type: string name_volume: description: | Filters results by a name. Default=None. @@ -257,22 +237,6 @@ sort_key: in: query required: false type: string -sort_key_1: - description: | - Sorts by an image attribute. A valid value is - ``name``, ``status``, ``container_format``, ``disk_format``, - ``size``, ``id``, ``created_at``, or ``updated_at``. Default is - ``created_at``. The API uses the natural sorting direction of the - ``sort_key`` attribute value. - in: query - required: false - type: string -status_query: - description: | - Filters results by a status. Default=None. - in: query - required: false - type: boolean usage: description: | Set to ``usage=true`` to show quota usage. @@ -1527,12 +1491,6 @@ size: in: body required: true type: integer -size_1: - description: | - The size of the backup, in GB. - in: body - required: true - type: integer snapshot: description: | A partial representation of a snapshot used in @@ -1540,12 +1498,6 @@ snapshot: in: body required: true type: string -snapshot_1: - description: | - A ``snapshot`` object. - in: body - required: true - type: object snapshot_id: description: | To create a volume from an existing snapshot, @@ -1560,14 +1512,6 @@ snapshot_id_2: in: body required: true type: string -snapshot_id_3: - description: | - The UUID of the source volume snapshot. The API - creates a new volume snapshot with the same size as the source - volume snapshot. - in: body - required: true - type: string source_cgid: description: | The UUID of the source consistency group. @@ -1588,30 +1532,12 @@ source_volid: in: body required: false type: string -source_volid_1: - description: | - The UUID of the source volume. - in: body - required: true - type: string specs: description: | A ``specs`` object. in: body required: true type: object -specs_1: - description: | - Specification key and value pairs. - in: body - required: true - type: object -specs_2: - description: | - Specification key and value pairs. - in: body - required: true - type: string status: description: | The ``status`` of the consistency group snapshot. @@ -1643,20 +1569,6 @@ status_4: in: body required: true type: string -status_5: - description: | - The consistency group status. A valid value is - ``creating``, ``available``, ``error``, ``deleting``, - ``updating``, or ``invalid``. - in: body - required: true - type: string -status_6: - description: | - The volume status. - in: body - required: false - type: string status_7: description: | The status for the backup. @@ -1670,13 +1582,6 @@ storage_protocol: in: body required: true type: string -storage_protocol_1: - description: | - The storage protocol, such as Fibre Channel, - iSCSI, NFS, and so on. - in: body - required: true - type: string total_capacity: description: | The total capacity for the back-end volume, in diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml index f175ec710c5..ccdc8ddf0a4 100644 --- a/api-ref/source/v3/parameters.yaml +++ b/api-ref/source/v3/parameters.yaml @@ -303,7 +303,6 @@ migration_status_query: Admin only. in: query required: false - type: string name_volume: description: | Filters results by a name. Default=None. @@ -366,16 +365,6 @@ sort_key: in: query required: false type: string -sort_key_1: - description: | - Sorts by an image attribute. A valid value is - ``name``, ``status``, ``container_format``, ``disk_format``, - ``size``, ``id``, ``created_at``, or ``updated_at``. Default is - ``created_at``. The API uses the natural sorting direction of the - ``sort_key`` attribute value. - in: query - required: false - type: string sort_key_group_snapshot: description: | Sorts by an attribute. A valid value is ``name``, @@ -2312,12 +2301,6 @@ size: in: body required: true type: integer -size_1: - description: | - The size of the backup, in GB. - in: body - required: true - type: integer skip_validation: description: | If set to false, the quota value can't be set lower than the in_use quota. @@ -2434,12 +2417,6 @@ source_volid: in: body required: false type: string -source_volid_1: - description: | - The UUID of the source volume. - in: body - required: true - type: string spec_value: description: | The value of the group specification corresponding to the specified key. @@ -2452,12 +2429,6 @@ specs: in: body required: true type: object -specs_1: - description: | - Specification key and value pairs. - in: body - required: true - type: object specs_2: description: | Specification key and value pairs. @@ -2501,20 +2472,6 @@ status_4: in: body required: true type: string -status_5: - description: | - The consistency group status. A valid value is - ``creating``, ``available``, ``error``, ``deleting``, - ``updating``, or ``invalid``. - in: body - required: true - type: string -status_6: - description: | - The volume status. - in: body - required: false - type: string status_7: description: | The ``status`` of the generic group snapshot. @@ -2540,13 +2497,6 @@ storage_protocol: in: body required: true type: string -storage_protocol_1: - description: | - The storage protocol, such as Fibre Channel, - iSCSI, NFS, and so on. - in: body - required: true - type: string summary_metadata: description: | The dictionary of lists contains all the volumes' metadata,