From 4aaa8bc0bfb4b43e3d76c9903a61c0f0bff629ca Mon Sep 17 00:00:00 2001 From: jichenjc Date: Sat, 25 Feb 2017 21:45:05 +0800 Subject: [PATCH] Clean up metadata param in doc several params like metadata_xxx are used and actually they are same, so just clean up them and use metadata_object instead part of bp:api-ref-in-rst-pike Change-Id: I455c02b5dcd77df43fc8c0113269f71a5207d3d5 --- api-ref/source/images.inc | 14 +++++++------- api-ref/source/os-aggregates.inc | 2 +- api-ref/source/os-server-groups.inc | 6 +++--- api-ref/source/os-volumes.inc | 8 ++++---- api-ref/source/parameters.yaml | 23 ----------------------- 5 files changed, 15 insertions(+), 38 deletions(-) diff --git a/api-ref/source/images.inc b/api-ref/source/images.inc index dfa0906172d5..61d13234db44 100644 --- a/api-ref/source/images.inc +++ b/api-ref/source/images.inc @@ -100,7 +100,7 @@ Response - name: image_name - minRam: minRam_body - minDisk: minDisk_body - - metadata: metadata_image + - metadata: metadata_object - created: created - updated: updated - status: image_status @@ -144,7 +144,7 @@ Response - name: image_name - minRam: minRam_body - minDisk: minDisk_body - - metadata: metadata_image + - metadata: metadata_object - created: created - updated: updated - status: image_status @@ -205,7 +205,7 @@ Response .. rest_parameters:: parameters.yaml - - metadata: metadata_image + - metadata: metadata_object **Example List Image Metadata Details: JSON response** @@ -230,7 +230,7 @@ Request .. rest_parameters:: parameters.yaml - image_id: image_id - - metadata: metadata_image + - metadata: metadata_object **Example Create Image Metadata: JSON request** @@ -242,7 +242,7 @@ Response .. rest_parameters:: parameters.yaml - - metadata: metadata_image + - metadata: metadata_object **Example Create Image Metadata: JSON response** @@ -267,7 +267,7 @@ Request .. rest_parameters:: parameters.yaml - image_id: image_id - - metadata: metadata_image + - metadata: metadata_object **Example Update Image Metadata: JSON request** @@ -279,7 +279,7 @@ Response .. rest_parameters:: parameters.yaml - - metadata: metadata_image + - metadata: metadata_object **Example Update Image Metadata: JSON response** diff --git a/api-ref/source/os-aggregates.inc b/api-ref/source/os-aggregates.inc index 67149ce29c86..ef9a13114d0d 100644 --- a/api-ref/source/os-aggregates.inc +++ b/api-ref/source/os-aggregates.inc @@ -322,7 +322,7 @@ Request - aggregate_id: aggregate_id - set_metadata: set_metadata - - metadata: metadata_set_required + - metadata: metadata_object **Example Create Or Update Aggregate Metadata: JSON request** diff --git a/api-ref/source/os-server-groups.inc b/api-ref/source/os-server-groups.inc index e3d210a903f4..295e11bf38a4 100644 --- a/api-ref/source/os-server-groups.inc +++ b/api-ref/source/os-server-groups.inc @@ -38,7 +38,7 @@ Response - name: name_server_group - policies: policies - members: members - - metadata: metadata_required + - metadata: metadata_object - project_id: project_id_server_group - user_id: user_id_server_group @@ -82,7 +82,7 @@ Response - name: name_server_group - policies: policies - members: members - - metadata: metadata_required + - metadata: metadata_object - project_id: project_id_server_group - user_id: user_id_server_group @@ -119,7 +119,7 @@ Response - name: name_server_group - policies: policies - members: members - - metadata: metadata_required + - metadata: metadata_object - project_id: project_id_server_group - user_id: user_id_server_group diff --git a/api-ref/source/os-volumes.inc b/api-ref/source/os-volumes.inc index 6e0b63902512..a49bd05efac2 100644 --- a/api-ref/source/os-volumes.inc +++ b/api-ref/source/os-volumes.inc @@ -50,7 +50,7 @@ Response - displayDescription: display_description - displayName: display_name - id: volume_id_resp - - metadata: metadata_set_required + - metadata: metadata_object - size: size - snapshotId: snapshot_id - status: volume_status @@ -110,7 +110,7 @@ Response - displayName: display_name - displayDescription: display_description - id: volume_id_resp - - metadata: metadata_set_required + - metadata: metadata_object - size: size - snapshotId: snapshot_id - status: volume_status @@ -158,7 +158,7 @@ Response - displayName: display_name - displayDescription: display_description - id: volume_id_resp - - metadata: metadata_set_required + - metadata: metadata_object - size: size - snapshotId: snapshot_id - status: volume_status @@ -205,7 +205,7 @@ Response - displayName: display_name - displayDescription: display_description - id: volume_id_resp - - metadata: metadata_set_required + - metadata: metadata_object - size: size - snapshotId: snapshot_id - status: volume_status diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index c1aa107af357..352d94c60894 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -2978,8 +2978,6 @@ meta: in: body required: true type: object -# TODO(karenb): Clean-up the various metadata object params. -# See metadata, metadata_required, metadata_object, metadata_set_required ... metadata: description: | Metadata key and value pairs. The maximum size of the metadata key and value is @@ -2994,13 +2992,6 @@ metadata_compat: in: body required: true type: object -metadata_image: - description: | - Metadata key and value pairs. The maximum size for each metadata key and value - pair is 255 bytes. - in: body - required: true - type: object metadata_items: description: | The number of allowed metadata items for each instance. @@ -3027,20 +3018,6 @@ metadata_object: in: body required: true type: object -metadata_required: - description: | - Metadata key and value pairs. The maximum size of the metadata key and value is - 255 bytes each. The associated metadata key and value pairs. - in: body - required: true - type: object -metadata_set_required: - description: | - Metadata key and value pairs. The maximum size of the metadata key and value is - 255 bytes each. - in: body - required: true - type: object migrate: description: | The action.