diff --git a/api-ref/source/metadata.inc b/api-ref/source/metadata.inc index 24b4ae8d9a84..61cd28e2ed8d 100644 --- a/api-ref/source/metadata.inc +++ b/api-ref/source/metadata.inc @@ -1,7 +1,4 @@ .. -*- rst -*- -.. needs:parameter_verification -.. needs:example_verification -.. needs:body_verification ===================================== Server metadata (servers, metadata) @@ -37,7 +34,11 @@ Request Response -------- -**Example List All Metadata: JSON response** +.. rest_parameters:: parameters.yaml + + - metadata: metadata_object + +**Example List All Metadata:** .. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json :language: javascript @@ -65,8 +66,9 @@ Request - tenant_id: tenant_id - server_id: server_id + - metadata: metadata_object -**Example Update Metadata Items: JSON request** +**Example Update Metadata Items:** .. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-req.json :language: javascript @@ -74,7 +76,11 @@ Request Response -------- -**Example Update Metadata Items: JSON response** +.. rest_parameters:: parameters.yaml + + - metadata: metadata_object + +**Example Update Metadata Items:** .. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json :language: javascript @@ -102,8 +108,9 @@ Request - tenant_id: tenant_id - server_id: server_id + - metadata: metadata_object -**Example Create Or Replace Metadata Items: JSON request** +**Example Create Or Replace Metadata Items:** .. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-req.json :language: javascript @@ -111,7 +118,11 @@ Request Response -------- -**Example Create Or Replace Metadata Items: JSON response** +.. rest_parameters:: parameters.yaml + + - metadata: metadata_object + +**Example Create Or Replace Metadata Items:** .. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json :language: javascript @@ -141,7 +152,11 @@ Request Response -------- -**Example Show Metadata Item Details: JSON response** +.. rest_parameters:: parameters.yaml + + - meta: metadata_object + +**Example Show Metadata Item Details:** .. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-resp.json :language: javascript @@ -171,7 +186,7 @@ Request - server_id: server_id - key: key -**Example Create Or Update Metadata Item: JSON request** +**Example Create Or Update Metadata Item:** .. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-req.json :language: javascript @@ -179,7 +194,11 @@ Request Response -------- -**Example Create Or Update Metadata Item: JSON response** +.. rest_parameters:: parameters.yaml + + - meta: metadata_object + +**Example Create Or Update Metadata Item:** .. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-resp.json :language: javascript @@ -209,3 +228,4 @@ Request Response -------- +There is no body content for the response of a successful DELETE action. diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 7fab664220c9..e3347098013c 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -1803,19 +1803,6 @@ metadata_1: in: body required: false type: object -metadata_3: - description: | - The associated metadata key and value pairs. - in: body - required: true - type: object -metadata_4: - description: | - Metadata key and value pairs. The maximum size for each metadata key and value - pair is 255 bytes. - in: body - required: false - type: string metadata_compat: description: | A dictionary of metadata key-and-value pairs, which is maintained for backward @@ -1842,6 +1829,13 @@ metadata_items_quota_optional: in: body required: false type: integer +metadata_object: + 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_required: description: | Metadata key and value pairs. The maximum size of the metadata key and value is