Add Stack States in API documentation

Signed-off-by: Rashed Kamal <rashed.kamal@broadcom.com>

Author: rashedkvm

docs/v3/source/includes/api_resources/_stacks.erb

@@ -5,6 +5,7 @@
    "updated_at": "2018-11-09T22:43:28Z",
    "name": "my-stack",
    "description": "Here is my stack!",
+   "state": "ACTIVE",
    "build_rootfs_image": "my-stack",
    "run_rootfs_image": "my-stack",
    "default": true,
@@ -45,6 +46,7 @@
       "build_rootfs_image": "my-stack-1-build",
       "run_rootfs_image": "my-stack-1-run",
       "description": "This is my first stack!",
+      "state": "ACTIVE",
       "default": true,
       "metadata": {
         "labels": {},
@@ -64,6 +66,7 @@
       "description": "This is my second stack!",
       "build_rootfs_image": "my-stack-2-build",
       "run_rootfs_image": "my-stack-2-run",
+      "state": "DEPRECATED",
       "default": false,
       "metadata": {
         "labels": {},
@@ -79,3 +82,26 @@
 }
 
 <% end %>
+
+<% content_for :single_stack_disabled do | metadata={} |  %>
+{
+   "guid": "11c916c9-c2f9-440e-8e73-102e79c4704d",
+   "created_at": "2018-11-09T22:43:28Z",
+   "updated_at": "2018-11-09T22:43:28Z",
+   "name": "my-stack",
+   "description": "Here is my stack!",
+   "state": "ACTIVE",
+   "build_rootfs_image": "my-stack",
+   "run_rootfs_image": "my-stack",
+   "default": true,
+   "metadata": {
+     "labels": <%= metadata.fetch(:labels, {}).to_json(space: ' ', object_nl: ' ')%>,
+     "annotations": <%= metadata.fetch(:annotations, {}).to_json(space: ' ', object_nl: ' ')%>
+   },
+   "links": {
+      "self": {
+         "href": "https://api.example.com/v3/stacks/11c916c9-c2f9-440e-8e73-102e79c4704d"
+      }
+   }
+}
+<% end %>

docs/v3/source/includes/resources/stacks/_object.md.erb

@@ -14,6 +14,7 @@ Name | Type | Description
 **updated_at** | _[timestamp](#timestamps)_ | The time with zone when the object was last updated
 **name** | _string_ | The name of the stack
 **description** | _string_ | The description of the stack
+**state** | string | The state of the stack; valid states are: `ACTIVE`, `RESTRICTED`, `DEPRECATED`, `DISABLED`
 **build_rootfs_image** | _string | The name of the stack image associated with staging/building Apps. If a stack does not have unique images, this will be the same as the stack name.
 **run_rootfs_image** | _string | The name of the stack image associated with running Apps + Tasks. If a stack does not have unique images, this will be the same as the stack name.
 **default** | _boolean_ | Whether the stack is configured to be the default stack for new applications.

docs/v3/source/includes/resources/stacks/_update.md.erb

@@ -9,7 +9,7 @@ curl "https://api.example.org/v3/stacks/[guid]" \
   -X PATCH \
   -H "Authorization: bearer [token]" \
   -H "Content-Type: application/json" \
-  -d '{ "metadata": { "labels": { "key": "value" }, "annotations": {"note": "detailed information"}}}'
+  -d '{ "metadata": { "labels": { "key": "value" }, "annotations": {"note": "detailed information"}, "state": "DISABLED" }}'
 
 ```
 
@@ -21,7 +21,7 @@ Example Response
 HTTP/1.1 200 OK
 Content-Type: application/json
 
-<%= yield_content :single_stack, labels: { "key" => "value" }, "annotations": {"note" => "detailed information"} %>
+<%= yield_content :single_stack_disabled, labels: { "key" => "value" }, "annotations": {"note" => "detailed information"} %>
 ```
 
 #### Definition
@@ -33,6 +33,7 @@ Name | Type | Description
 ---- | ---- | -----------
 **metadata.labels** | [_label object_](#labels) | Labels applied to the stack
 **metadata.annotations**  | [_annotation object_](#annotations) | Annotations applied to the stack
+**state** | string | The state of the stack; valid states are: `ACTIVE`, `RESTRICTED`, `DEPRECATED`, `DISABLED`
 
 #### Permitted roles
  |