Skip to content
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

Commit 2f168e6

Browse files
committed
include the default values requests
1 parent bced659 commit 2f168e6

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

content/v3/repos/deployments.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -124,10 +124,10 @@ Users with push access can create a deployment for a given ref:
124124
Name | Type | Description
125125
-----|------|--------------
126126
`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: `""`
131131

132132
#### Example
133133

@@ -178,8 +178,8 @@ Users with push access can create deployment statuses for a given deployment:
178178
Name | Type | Description
179179
-----|------|--------------
180180
`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: `""`
183183

184184
#### Example
185185

0 commit comments

Comments
 (0)