openstack/nova
Code Issues Proposed changes

Make metadata doc more readable

Browse Source 
Found that docs about server metadata is quite
hard to understand, made some modifications to
be more readable.

Change-Id: If74dc383149068f2c568482c78e6db1e19f7d3af
This commit is contained in:
Kevin_Zheng 2017-03-28 11:39:18 +08:00 committed by Zhenyu Zheng
parent da039c3d20
commit 1be9b0e680
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
api-ref/source/metadata.inc
View File

@ -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.
@ -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.
@ -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.