Commit 55880751aacb609d6d9d5bff2dd236c1b1952551
1 parent
f1253fa7
Exists in
master
and in
4 other branches
Update deploy keys, groups and system hooks api docs.
Showing
3 changed files
with
30 additions
and
8 deletions
Show diff stats
doc/api/deploy_keys.md
@@ -20,13 +20,15 @@ Parameters: | @@ -20,13 +20,15 @@ Parameters: | ||
20 | "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 | 20 | "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 |
21 | 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 | 21 | 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 |
22 | soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", | 22 | soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", |
23 | + "created_at":"2013-10-02T10:12:29Z" | ||
23 | }, | 24 | }, |
24 | { | 25 | { |
25 | "id": 3, | 26 | "id": 3, |
26 | "title" : "Another Public key", | 27 | "title" : "Another Public key", |
27 | "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 | 28 | "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 |
28 | 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 | 29 | 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 |
29 | - soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=" | 30 | + soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", |
31 | + "created_at":"2013-10-02T11:12:29Z" | ||
30 | } | 32 | } |
31 | ] | 33 | ] |
32 | ``` | 34 | ``` |
@@ -51,7 +53,8 @@ Parameters: | @@ -51,7 +53,8 @@ Parameters: | ||
51 | "title" : "Public key", | 53 | "title" : "Public key", |
52 | "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 | 54 | "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 |
53 | 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 | 55 | 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 |
54 | - soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=" | 56 | + soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", |
57 | + "created_at":"2013-10-02T10:12:29Z" | ||
55 | } | 58 | } |
56 | ``` | 59 | ``` |
57 | 60 |
doc/api/groups.md
@@ -8,12 +8,12 @@ GET /groups | @@ -8,12 +8,12 @@ GET /groups | ||
8 | 8 | ||
9 | ```json | 9 | ```json |
10 | [ | 10 | [ |
11 | - { | ||
12 | - "id": 1, | ||
13 | - "name": "Foobar Group", | ||
14 | - "path": "foo-bar", | ||
15 | - "owner_id": 18 | ||
16 | - } | 11 | + { |
12 | + "id": 1, | ||
13 | + "name": "Foobar Group", | ||
14 | + "path": "foo-bar", | ||
15 | + "owner_id": 18 | ||
16 | + } | ||
17 | ] | 17 | ] |
18 | ``` | 18 | ``` |
19 | 19 |
doc/api/system_hooks.md
@@ -12,6 +12,15 @@ Parameters: | @@ -12,6 +12,15 @@ Parameters: | ||
12 | 12 | ||
13 | + **none** | 13 | + **none** |
14 | 14 | ||
15 | +```json | ||
16 | +[ | ||
17 | + { | ||
18 | + "id":3, | ||
19 | + "url":"http://example.com/hook", | ||
20 | + "created_at":"2013-10-02T10:15:31Z" | ||
21 | + } | ||
22 | +] | ||
23 | +``` | ||
15 | 24 | ||
16 | ## Add new system hook hook | 25 | ## Add new system hook hook |
17 | 26 | ||
@@ -34,6 +43,16 @@ Parameters: | @@ -34,6 +43,16 @@ Parameters: | ||
34 | 43 | ||
35 | + `id` (required) - The ID of hook | 44 | + `id` (required) - The ID of hook |
36 | 45 | ||
46 | +```json | ||
47 | +{ | ||
48 | + "event_name":"project_create", | ||
49 | + "name":"Ruby", | ||
50 | + "path":"ruby", | ||
51 | + "project_id":1, | ||
52 | + "owner_name":"Someone", | ||
53 | + "owner_email":"example@gitlabhq.com" | ||
54 | +} | ||
55 | +``` | ||
37 | 56 | ||
38 | ## Delete system hook | 57 | ## Delete system hook |
39 | 58 |