From a1d2b2ad0f0efb2186ad4e056c08b0da892f1199 Mon Sep 17 00:00:00 2001
From: Shivanand Tendulker <stendulker@gmail.com>
Date: Thu, 8 Feb 2018 13:29:16 -0500
Subject: [PATCH] Follow-up patch for documentation of rescue mode
This is the follow-up patch addresses outstanding comments for
commit 689dbf6b5c6ec1dcaf1fa37d288518c91eedf4ec.
Change-Id: I72c189988c5c274c32d61a2b9aea5a84da2b2c6e
Related-Bug: #1526449
---
doc/source/contributor/rescue.rst | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/doc/source/contributor/rescue.rst b/doc/source/contributor/rescue.rst
index 16b185f40..934da8b6d 100644
--- a/doc/source/contributor/rescue.rst
+++ b/doc/source/contributor/rescue.rst
@@ -29,6 +29,16 @@ invoked, it triggers rescue mode::
``rescue_password`` is a required parameter for this command.
+Upon success, it returns following data in response::
+
+ {"command_name": "finalize_rescue",
+ "command_params": {
+ "rescue_password": "p455w0rd"},
+ "command_status": "SUCCEEDED"
+ "command_result": null
+ "command_error": null
+ }
+
If successful, this synchronous command will:
1. Write the salted and crypted ``rescue_password`` to