Skip to content

Commit 569c2bd

Browse files
committed
Describe stack states in API doc
Signed-off-by: Rashed Kamal <[email protected]>
1 parent 54e547f commit 569c2bd

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ curl "https://api.example.org/v3/stacks" \
1212
-d '{
1313
"name": "my-stack",
1414
"description": "Here is my stack!",
15+
"state": "ACTIVE",
1516
}'
1617
```
1718

@@ -42,6 +43,7 @@ Name | Type | Description | Default
4243
**description** | _string_ | Description of the stack; must no longer than 250 characters | `null`
4344
**metadata.labels** | [_label object_](#labels) | Labels applied to the stack
4445
**metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the stack
46+
**state** | string | The state of the stack; valid states are: `ACTIVE`, `RESTRICTED`, `DEPRECATED`, `DISABLED`
4547

4648
#### Permitted roles
4749
|

docs/v3/source/includes/resources/stacks/_header.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,15 @@ An application will automatically use buildpacks associated with the application
1212

1313
Stacks are not used for apps with a [Docker lifecycle](#docker-lifecycle).
1414

15+
Operators control stack availability through state management. The following states determine how a stack can be used:
16+
17+
*ACTIVE*: Default state. The stack is fully available for all operations.
18+
19+
*DEPRECATED*: The stack is nearing end-of-life. It remains fully functional,
20+
but users should migrate to an ACTIVE stack.
21+
22+
*RESTRICTED*: A transitional state typically applied before deprecation or disabling.
23+
New application creation is blocked; existing deployments continue to operate normally.
24+
25+
*DISABLED*: The stack has reached end-of-life. New application creation and restaging are prohibited.
26+
Running applications remain available.

0 commit comments

Comments
 (0)