Update API docs with state_reason

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

Author: rashedkvm

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

@@ -6,6 +6,7 @@
    "name": "my-stack",
    "description": "Here is my stack!",
    "state": "ACTIVE",
+   "state_reason": null,
    "build_rootfs_image": "my-stack",
    "run_rootfs_image": "my-stack",
    "default": true,
@@ -47,6 +48,7 @@
       "run_rootfs_image": "my-stack-1-run",
       "description": "This is my first stack!",
       "state": "ACTIVE",
+      "state_reason": null,
       "default": true,
       "metadata": {
         "labels": {},
@@ -67,6 +69,7 @@
       "build_rootfs_image": "my-stack-2-build",
       "run_rootfs_image": "my-stack-2-run",
       "state": "DEPRECATED",
+      "state_reason": "Stack deprecated and will be removed in future release",
       "default": false,
       "metadata": {
         "labels": {},
@@ -91,6 +94,7 @@
    "name": "my-stack",
    "description": "Here is my stack!",
    "state": "DISABLED",
+   "state_reason": "Stack disabled and cannot be used for staging new application",
    "build_rootfs_image": "my-stack",
    "run_rootfs_image": "my-stack",
    "default": true,

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

@@ -13,6 +13,7 @@ curl "https://api.example.org/v3/stacks" \
     "name": "my-stack",
     "description": "Here is my stack!",
     "state": "ACTIVE",
+    "state_reason": "",
   }'
 ```
 
@@ -44,6 +45,7 @@ Name | Type | Description | Default
 **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`
+**state_reason** | string | Optional plain text describing the stack change
 
 #### Permitted roles
  |

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

@@ -15,6 +15,7 @@ Name | Type | Description
 **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`
+**state_reason** | string | Optional plain text describing the stack change
 **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"}},"state":"ACTIVE"}'
+  -d '{ "metadata": { "labels": { "key": "value" }, "annotations": {"note": "detailed information"}},"state":"ACTIVE", "state_reason": "Optional plain text describing the stack change" }'
 
 ```
 
@@ -34,6 +34,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`
+**state_reason** | string | Optional plain text describing the stack change
 
 #### Permitted roles
  |