Skip to content

Commit

Permalink
Make metadata doc more readable
Browse files Browse the repository at this point in the history
Found that docs about server metadata is quite
hard to understand, made some modifications to
be more readable.

Change-Id: If74dc383149068f2c568482c78e6db1e19f7d3af
  • Loading branch information
Kevin_Zheng committed Mar 31, 2017
1 parent da039c3 commit 1be9b0e
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions api-ref/source/metadata.inc
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,16 @@ Response
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json
:language: javascript

Update Metadata Items
=====================
Create or Update Metadata Items
===============================

.. rest_method:: POST /servers/{server_id}/metadata

Updates one or more metadata items for a server.
Create or update one or more metadata items for a server.

Replaces metadata items that match keys. Does not modify items that are not in the request.
Creates any metadata items that do not already exist in the server, replaces
exists metadata items that match keys. Does not modify items that are not in
the request.

Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.

Expand Down Expand Up @@ -85,12 +87,12 @@ Response
.. literalinclude:: ../../doc/api_samples/server-metadata/server-metadata-all-resp.json
:language: javascript

Create Or Replace Metadata Items
================================
Replace Metadata Items
======================

.. rest_method:: PUT /servers/{server_id}/metadata

Creates or replaces one or more metadata items for a server.
Replaces one or more metadata items for a server.

Creates any metadata items that do not already exist in the server. Removes and completely replaces any metadata items that already exist in the server with the metadata items in the request.

Expand Down Expand Up @@ -168,7 +170,8 @@ Create Or Update Metadata Item

Creates or replaces a metadata item, by key, for a server.

Creates a metadata item that does not already exist in the server. Removes and completely replaces a metadata item that already exists in the server with the metadata item in the request.
Creates a metadata item that does not already exist in the server. Replaces
existing metadata items that match keys with the metadata item in the request.

Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.

Expand Down

0 comments on commit 1be9b0e

Please sign in to comment.