From eb9b3657c4412e51d2eb276d7242cdc33ae60ae8 Mon Sep 17 00:00:00 2001 From: Sam Gunaratne Date: Thu, 8 May 2025 14:10:11 -0600 Subject: [PATCH] Fix doc formatting of Deployment status.details.error --- docs/v3/source/includes/resources/deployments/_object.md.erb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/v3/source/includes/resources/deployments/_object.md.erb b/docs/v3/source/includes/resources/deployments/_object.md.erb index 62c191fd610..50f1538bc10 100644 --- a/docs/v3/source/includes/resources/deployments/_object.md.erb +++ b/docs/v3/source/includes/resources/deployments/_object.md.erb @@ -16,7 +16,7 @@ Name | Type | Description **status.reason** | _string_ | The reason for the status of the deployment;
following list represents valid values:
1. If **status.value** is `ACTIVE`
- `DEPLOYING`
- `PAUSED` (only valid for canary deployments)
- `CANCELING`
2. If **status.value** is `FINALIZED`
- `DEPLOYED`
- `CANCELED`
- `SUPERSEDED` (another deployment created for app before completion)
**status.details.last_successful_healthcheck** | _[timestamp](#timestamps)_ | Timestamp of the last successful healthcheck **status.details.last_status_change** | _[timestamp](#timestamps)_ | Timestamp of last change to status.value or status.reason**status.details.last_status_change** | _[timestamp](#timestamps)_ | Timestamp of last change to status.value or status.reason -**status.details.error** | _string_ | | Brief description of error encountered while deploying, if any. This field is cleared once the deployment progresses successfully. +**status.details.error** | _string_ | Brief description of error encountered while deploying, if any. This field is cleared once the deployment progresses successfully. **status.canary.steps.current** | _integer_ | The current canary step. Only available for deployments with strategy 'canary'. (experimental) **status.canary.steps.total** | _integer_ | The total number of canary steps. Only available for deployments with strategy 'canary'. (experimental) **strategy** | _string_ | Strategy used for the deployment; supported strategies are `rolling` and `canary` (experimental)