summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/api/projects.md79
-rw-r--r--doc/api/system_hooks.md47
-rw-r--r--doc/install/installation.md2
3 files changed, 127 insertions, 1 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md
index 32b7077ab09..4cbefbb6189 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -296,3 +296,82 @@ Parameters:
+ `hook_id` (required) - The ID of hook to delete
Will return status `200 OK` on success, or `404 Not found` on fail.
+
+
+## List deploy keys
+
+Get a list of a project's deploy keys.
+
+```
+GET /projects/:id/keys
+```
+
+```json
+[
+ {
+ "id": 1,
+ "title" : "Public key"
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4
+ 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4
+ soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
+ },
+ {
+ "id": 3,
+ "title" : "Another Public key"
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4
+ 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4
+ soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0="
+ }
+]
+```
+
+## Single deploy key
+
+Get a single key.
+
+```
+GET /projects/:id/keys/:key_id
+```
+
+Parameters:
+
++ `id` (required) - The ID of an deploy key
+
+```json
+{
+ "id": 1,
+ "title" : "Public key"
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4
+ 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4
+ soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0="
+}
+```
+## Add deploy key
+
+Create new deploy key for a project
+
+```
+POST /projects/:id/keys
+```
+
+Parameters:
+
++ `title` (required) - new deploy key's title
++ `key` (required) - new deploy key
+
+Will return created key with status `201 Created` on success, or `404 Not
+found` on fail.
+
+## Delete deploy key
+
+Delete a deploy key from a project
+
+```
+DELETE /projects/:id/keys/:key_id
+```
+
+Parameters:
+
++ `id` (required) - Deploy key ID
+
+Will return `200 OK` on success, or `404 Not Found` on fail.
diff --git a/doc/api/system_hooks.md b/doc/api/system_hooks.md
new file mode 100644
index 00000000000..f6e11ed238e
--- /dev/null
+++ b/doc/api/system_hooks.md
@@ -0,0 +1,47 @@
+All methods require admin authorization.
+
+## List system hooks
+
+Get list of system hooks
+
+```
+GET /hooks
+```
+
+Will return hooks with status `200 OK` on success, or `404 Not found` on fail.
+
+## Add new system hook hook
+
+```
+POST /hooks
+```
+
+Parameters:
+
++ `url` (required) - The hook URL
+
+Will return status `201 Created` on success, or `404 Not found` on fail.
+
+## Test system hook
+
+```
+GET /hooks/:id
+```
+
+Parameters:
+
++ `id` (required) - The ID of hook
+
+Will return hook with status `200 OK` on success, or `404 Not found` on fail.
+
+## Delete system hook
+
+```
+DELETE /hooks/:id
+```
+
+Parameters:
+
++ `id` (required) - The ID of hook
+
+Will return status `200 OK` on success, or `404 Not found` on fail. \ No newline at end of file
diff --git a/doc/install/installation.md b/doc/install/installation.md
index d0f586af6b4..51a8dcfb876 100644
--- a/doc/install/installation.md
+++ b/doc/install/installation.md
@@ -288,7 +288,7 @@ a different host, you can configure its connection string via the
`config/resque.yml` file.
# example
- production: redis.example.tld:6379
+ production: redis://redis.example.tld:6379
## Custom SSH Connection