Skip to content

Commit 5c11479

Browse files
committed
Updated API docs for stack state change
Signed-off-by: Rashed Kamal <rashed.kamal@broadcom.com>
1 parent 23f23c2 commit 5c11479

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Name | Type | Description | Default
4545
**metadata.labels** | [_label object_](#labels) | Labels applied to the stack
4646
**metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the stack
4747
**state** | string | The state of the stack; valid states are: `ACTIVE`, `RESTRICTED`, `DEPRECATED`, `DISABLED`
48-
**state_reason** | string | Optional plain text describing the stack change
48+
**state_reason** | string | Optional plain text describing the stack state change
4949

5050
#### Permitted roles
5151
|

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Name | Type | Description
1515
**name** | _string_ | The name of the stack
1616
**description** | _string_ | The description of the stack
1717
**state** | string | The state of the stack; valid states are: `ACTIVE`, `RESTRICTED`, `DEPRECATED`, `DISABLED`
18-
**state_reason** | string | Optional plain text describing the stack change
18+
**state_reason** | string | Optional plain text describing the stack state change
1919
**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.
2020
**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.
2121
**default** | _boolean_ | Whether the stack is configured to be the default stack for new applications.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ curl "https://api.example.org/v3/stacks/[guid]" \
99
-X PATCH \
1010
-H "Authorization: bearer [token]" \
1111
-H "Content-Type: application/json" \
12-
-d '{ "metadata": { "labels": { "key": "value" }, "annotations": {"note": "detailed information"}},"state":"ACTIVE", "state_reason": "Optional plain text describing the stack change" }'
12+
-d '{ "metadata": { "labels": { "key": "value" }, "annotations": {"note": "detailed information"}},"state":"ACTIVE", "state_reason": "Optional plain text describing the stack state change" }'
1313

1414
```
1515

@@ -34,7 +34,7 @@ Name | Type | Description
3434
**metadata.labels** | [_label object_](#labels) | Labels applied to the stack
3535
**metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the stack
3636
**state** | string | The state of the stack; valid states are: `ACTIVE`, `RESTRICTED`, `DEPRECATED`, `DISABLED`
37-
**state_reason** | string | Optional plain text describing the stack change
37+
**state_reason** | string | Optional plain text describing the stack state change
3838

3939
#### Permitted roles
4040
|

0 commit comments

Comments
 (0)