Skip to content

Commit 293e173

Browse files
committed
Update deployments.md
Document the maximum length for deployment status descriptions. More than 140 characters returns 422.
1 parent 7571a7e commit 293e173

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

content/v3/repos/deployments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ Name | Type | Description
205205
-----|------|--------------
206206
`state`|`string` | **Required**. The state of the status. Can be one of `pending`, `success`, `error`, or `failure`.
207207
`target_url`|`string` | The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Default: `""`
208-
`description`|`string` | A short description of the status. Default: `""`
208+
`description`|`string` | A short description of the status. Maximum length of 140 characters. Default: `""`
209209

210210
#### Example
211211

0 commit comments

Comments
 (0)