summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdam Mulvany <amulvany@gitlab.com>2017-12-04 10:09:57 +1100
committerAdam Mulvany <amulvany@gitlab.com>2017-12-04 10:09:57 +1100
commita76b451c218750c147e656b0fcd8975c1e1f7498 (patch)
tree47559c5deb6e38b81432d6dc26eca2a7c890a337
parent90f8fa0347473d60404db7a25d5a7195e60f17db (diff)
downloadgitlab-ce-docs-update-api-issues-update-deploy-key-am.tar.gz
Refine deploy_key request in docsdocs-update-api-issues-update-deploy-key-am
-rw-r--r--doc/api/deploy_keys.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/deploy_keys.md b/doc/api/deploy_keys.md
index 566ff75bbe2..ffb486173e0 100644
--- a/doc/api/deploy_keys.md
+++ b/doc/api/deploy_keys.md
@@ -147,8 +147,8 @@ PUT /projects/:id/deploy_keys/:id
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `key_id` | integer/string | yes | The ID of the deploy key |
-| `title` | string | optional | New deploy key's title |
-| `can_push` | boolean | no | Can deploy key push to the project's repository |
+| `title` | string | optional | The title of the deploy key |
+| `can_push` | boolean | no | Whether the deploy key will have write permissions to the repository |
```bash
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --header "Content-Type: application/json" --data '{"key_id":"3", "title": "My updated key", "can_push": "true"}' "https://gitlab.example.com/api/v4/projects/5/deploy_keys/3"