Merge "verify api-ref os-server-password.inc"

api-ref/source/os-server-password.inc

@@ -1,7 +1,4 @@
 .. -*- rst -*-
-.. needs:parameter_verification
-.. needs:example_verification
-.. needs:body_verification
 
 ================================================
  Servers password (servers, os-server-password)
@@ -18,9 +15,16 @@ Show Server Password
 
 Shows the administrative password for a server.
 
-This operation calls the metadata service to query metadata information and does not read password information from the server itself.
+This operation calls the metadata service to query metadata information and
+does not read password information from the server itself.
 
-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.
+The password saved in the metadata service is typically encrypted using the
+public SSH key injected into this server, so the SSH private key is needed to
+read the password.
+
+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.
 
 Normal response codes: 200
 
@@ -37,6 +41,10 @@ Request
 Response
 --------
 
+.. rest_parameters:: parameters.yaml
+
+  - password: password
+
 **Example Show Server Password: JSON response**
 
 .. literalinclude:: ../../doc/api_samples/os-server-password/get-password-resp.json
@@ -47,11 +55,14 @@ Clear Admin Password
 
 .. rest_method:: DELETE /v2.1/{tenant_id}/servers/{server_id}/os-server-password
 
-Clears the encrypted administrative password for a server, which removes it from the metadata server.
+Clears the encrypted administrative password for a server, which removes it
+from the database.
 
 This action does not actually change the instance server password.
 
-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.
+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.
 
 Normal response codes: 204
 
@@ -68,3 +79,4 @@ Request
 Response
 --------
 
+There is no body content for the response of a successful DELETE action.

api-ref/source/parameters.yaml

@@ -2147,6 +2147,12 @@ parent_group_id:
   in: body
   required: true
   type: string
+password:
+  description: |
+    The password returned from metadata server.
+  in: body
+  required: false
+  type: string
 pause:
   description: |
     The action.