From 6a8e844aab86f1ebb388ff1b9b16dd8e86c73530 Mon Sep 17 00:00:00 2001
From: pcrews <gleebix@gmail.com>
Date: Mon, 9 Feb 2015 13:09:30 -0800
Subject: [PATCH] document snapshot auto-delete

Adding to the api docs to note that stack snapshots will be
auto-deleted upon stack deletion and that only active stacks
can be restored.  Deleted stacks must be recreated.

Change-Id: I3cb55846f7215d326ea10071e133a4776dc52be5
Closes-Bug: 1413298
---
 .../wadls/orchestration-api/src/v1/orchestration-api.wadl | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl b/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl
index 86a0ed812..98c57f632 100644
--- a/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl
+++ b/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl
@@ -817,7 +817,7 @@ are specified, this value overrides any value provided for
     <method name="DELETE" id="stack_delete">
         <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
             title="Delete stack">
-            <para role="shortdesc">Deletes a specified stack.</para>
+            <para role="shortdesc">Deletes a specified stack and any snapshots of that stack.</para>
         </wadl:doc>
         <response status="204"/>
     </method>
@@ -841,7 +841,7 @@ are specified, this value overrides any value provided for
         <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
             title="Snapshot stack">
             <para role="shortdesc">Takes a snapshot of all the resources in the
-                stack.</para>
+                stack. All snapshots are deleted upon deletion of the stack.</para>
         </wadl:doc>
         <request>
             <representation mediaType="application/json">
@@ -894,7 +894,9 @@ are specified, this value overrides any value provided for
     <method name="POST" id="stack_restore_snapshot">
         <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
             title="Restore snapshot">
-            <para role="shortdesc">Restore a stack snapshot.</para>
+            <para role="shortdesc">Restore a stack snapshot. Only active stacks
+                can be restored from a snapshot. Deleted stacks must be
+                recreated.</para>
         </wadl:doc>
         <response status="202"/>
     </method>