You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 1, 2017. It is now read-only.
Copy file name to clipboardExpand all lines: content/v3/repos/deployments.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -124,10 +124,10 @@ Users with push access can create a deployment for a given ref:
124
124
Name | Type | Description
125
125
-----|------|--------------
126
126
`ref`|`string`| **Required**. The ref to deploy. This can be a branch, tag, or sha.
127
-
`force`|`boolean`| Optional parameter to bypass any ahead/behind checks or commit status checks.
128
-
`payload`|`string` | Optional JSON payload with extra information about the deployment.
129
-
`auto_merge`|`boolean`| Optional parameter to merge the default branch into the requested deployment branch if necessary.
130
-
`description`|`string` | Optional short description.
127
+
`force`|`boolean`| Optional parameter to bypass any ahead/behind checks or commit status checks. Default: `false`
128
+
`payload`|`string` | Optional JSON payload with extra information about the deployment. Default: `""`
129
+
`auto_merge`|`boolean`| Optional parameter to merge the default branch into the requested deployment branch if necessary. Default: `false`
130
+
`description`|`string` | Optional short description. Default: `""`
131
131
132
132
#### Example
133
133
@@ -178,8 +178,8 @@ Users with push access can create deployment statuses for a given deployment:
178
178
Name | Type | Description
179
179
-----|------|--------------
180
180
`state`|`string` | **Required**. The state of the status. Can be one of `pending`, `success`, `error`, or `failure`.
181
-
`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.
182
-
`description`|`string` | A short description of the status.
181
+
`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: `""`
182
+
`description`|`string` | A short description of the status. Default: `""`
0 commit comments