Skip to content
This repository was archived by the owner on Jun 2, 2021. It is now read-only.

Commit 18a9c84

Browse files
committed
App restart action is no longer experimental
- Restart action is used by the v7 CLI so it should not be experimental - Update docs with more details on what the endpoint does [#174431779][#172191543] Authored-by: Greg Cobb <gcobb@pivotal.io>
1 parent ce3d1a0 commit 18a9c84

3 files changed

Lines changed: 10 additions & 5 deletions

File tree

docs/v3/source/includes/experimental_resources/app_restart/_header.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/v3/source/includes/experimental_resources/app_restart/_create.md.erb renamed to docs/v3/source/includes/resources/apps/_restart.md.erb

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Example Request
66

77
```shell
88
curl "https://api.example.org/v3/apps/[guid]/actions/restart" \
9-
-X POST \
10-
-H "Authorization: bearer [token]"
9+
-X POST \
10+
-H "Authorization: bearer [token]"
1111
```
1212

1313
```
@@ -21,6 +21,13 @@ Content-Type: application/json
2121
<%= yield_content :app_with_state, 'STARTED' %>
2222
```
2323

24+
This endpoint will synchronously stop and start an application.
25+
Unlike the [start](#start-an-app) and [stop](#stop-an-app) actions,
26+
this endpoint will error if the app is not successfully stopped
27+
in the runtime.
28+
29+
For restarting applications without downtime, see the [deployments](#deployments) resource.
30+
2431
#### Definition
2532
`POST /v3/apps/:guid/actions/restart`
2633

docs/v3/source/index.html.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ includes:
8080
- resources/apps/ssh_enabled
8181
- resources/apps/start
8282
- resources/apps/stop
83+
- resources/apps/restart
8384
- resources/apps/update_environment_variables
8485
- resources/app_features/header
8586
- resources/app_features/object
@@ -342,8 +343,6 @@ includes:
342343
- resources/users/update
343344
- resources/users/delete
344345
- experimental_resources/header
345-
- experimental_resources/app_restart/header
346-
- experimental_resources/app_restart/create
347346
- experimental_resources/revisions/header
348347
- experimental_resources/revisions/object
349348
- experimental_resources/revisions/get

0 commit comments

Comments
 (0)