Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
iv
gitlab-ce
Commits
62673d58
Commit
62673d58
authored
Oct 03, 2013
by
Dmitriy Zaporozhets
Browse files
Options
Browse Files
Download
Plain Diff
Merge branch 'update_api_documentation' of /home/git/repositories/gitlab/gitlabhq
parents
c44c5f5f
da54a1e6
Changes
12
Hide whitespace changes
Inline
Side-by-side
Showing
12 changed files
with
290 additions
and
318 deletions
+290
-318
doc/api/README.md
doc/api/README.md
+1
-1
doc/api/deploy_keys.md
doc/api/deploy_keys.md
+5
-2
doc/api/groups.md
doc/api/groups.md
+19
-6
doc/api/issues.md
doc/api/issues.md
+10
-10
doc/api/merge_requests.md
doc/api/merge_requests.md
+14
-19
doc/api/milestones.md
doc/api/milestones.md
+15
-0
doc/api/notes.md
doc/api/notes.md
+72
-6
doc/api/project_snippets.md
doc/api/project_snippets.md
+1
-1
doc/api/projects.md
doc/api/projects.md
+130
-62
doc/api/system_hooks.md
doc/api/system_hooks.md
+19
-0
doc/api/user_teams.md
doc/api/user_teams.md
+0
-209
doc/api/users.md
doc/api/users.md
+4
-2
No files found.
doc/api/README.md
View file @
62673d58
...
...
@@ -117,7 +117,7 @@ When listing resources you can pass the following parameters:
+
[
Deploy Keys
](
deploy_keys.md
)
+
[
System Hooks
](
system_hooks.md
)
+
[
Groups
](
groups.md
)
+
[
User Teams
](
user_teams.md
)
## Clients
...
...
doc/api/deploy_keys.md
View file @
62673d58
...
...
@@ -20,13 +20,15 @@ Parameters:
"key"
:
"ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4
596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4
soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0="
,
"created_at"
:
"2013-10-02T10:12:29Z"
},
{
"id"
:
3
,
"title"
:
"Another Public key"
,
"key"
:
"ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4
596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4
soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0="
soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0="
,
"created_at"
:
"2013-10-02T11:12:29Z"
}
]
```
...
...
@@ -51,7 +53,8 @@ Parameters:
"title"
:
"Public key"
,
"key"
:
"ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4
596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4
soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0="
soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0="
,
"created_at"
:
"2013-10-02T10:12:29Z"
}
```
...
...
doc/api/groups.md
View file @
62673d58
...
...
@@ -8,12 +8,12 @@ GET /groups
```
json
[
{
"id"
:
1
,
"name"
:
"Foobar Group"
,
"path"
:
"foo-bar"
,
"owner_id"
:
18
}
{
"id"
:
1
,
"name"
:
"Foobar Group"
,
"path"
:
"foo-bar"
,
"owner_id"
:
18
}
]
```
...
...
@@ -59,6 +59,19 @@ Parameters:
## Group members
**Group access levels**
The group access levels are defined in the
`Gitlab::Access`
module. Currently, these levels are recognized:
```
GUEST = 10
REPORTER = 20
DEVELOPER = 30
MASTER = 40
OWNER = 50
```
### List group members
Get a list of group members viewable by the authenticated user.
...
...
doc/api/issues.md
View file @
62673d58
...
...
@@ -22,10 +22,10 @@ GET /issues
"username"
:
"john_smith"
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-05-23T08:00:58Z"
},
"state"
:
'closed'
,
"state"
:
"closed"
,
"updated_at"
:
"2012-07-02T17:53:12Z"
,
"created_at"
:
"2012-07-02T17:53:12Z"
},
...
...
@@ -42,7 +42,7 @@ GET /issues
"title"
:
"v1.0"
,
"description"
:
""
,
"due_date"
:
"2012-07-20"
,
"state"
:
'reopenend'
,
"state"
:
"reopenend"
,
"updated_at"
:
"2012-07-04T13:42:48Z"
,
"created_at"
:
"2012-07-04T13:42:48Z"
},
...
...
@@ -51,7 +51,7 @@ GET /issues
"username"
:
"jack_smith"
,
"email"
:
"jack@example.com"
,
"name"
:
"Jack Smith"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-05-23T08:01:01Z"
},
"author"
:
{
...
...
@@ -59,10 +59,10 @@ GET /issues
"username"
:
"john_smith"
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-05-23T08:00:58Z"
},
"state"
:
'opened'
,
"state"
:
"opened"
,
"updated_at"
:
"2012-07-12T13:43:19Z"
,
"created_at"
:
"2012-06-28T12:58:06Z"
}
...
...
@@ -111,7 +111,7 @@ Parameters:
"title"
:
"v1.0"
,
"description"
:
""
,
"due_date"
:
"2012-07-20"
,
"state"
:
'closed'
,
"state"
:
"closed"
,
"updated_at"
:
"2012-07-04T13:42:48Z"
,
"created_at"
:
"2012-07-04T13:42:48Z"
},
...
...
@@ -120,7 +120,7 @@ Parameters:
"username"
:
"jack_smith"
,
"email"
:
"jack@example.com"
,
"name"
:
"Jack Smith"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-05-23T08:01:01Z"
},
"author"
:
{
...
...
@@ -128,10 +128,10 @@ Parameters:
"username"
:
"john_smith"
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-05-23T08:00:58Z"
},
"state"
:
'opened'
,
"state"
:
"opened"
,
"updated_at"
:
"2012-07-12T13:43:19Z"
,
"created_at"
:
"2012-06-28T12:58:06Z"
}
...
...
doc/api/merge_requests.md
View file @
62673d58
...
...
@@ -19,14 +19,13 @@ Parameters:
"source_branch"
:
"test1"
,
"project_id"
:
3
,
"title"
:
"test1"
,
"closed"
:
true
,
"merged"
:
false
,
"state"
:
"opened"
,
"author"
:{
"id"
:
1
,
"username"
:
"admin"
,
"email"
:
"admin@local.host"
,
"name"
:
"Administrator"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-04-29T08:46:00Z"
},
"assignee"
:{
...
...
@@ -34,7 +33,7 @@ Parameters:
"username"
:
"admin"
,
"email"
:
"admin@local.host"
,
"name"
:
"Administrator"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-04-29T08:46:00Z"
}
}
...
...
@@ -62,14 +61,13 @@ Parameters:
"source_branch"
:
"test1"
,
"project_id"
:
3
,
"title"
:
"test1"
,
"closed"
:
true
,
"merged"
:
false
,
"state"
:
"merged"
,
"author"
:{
"id"
:
1
,
"username"
:
"admin"
,
"email"
:
"admin@local.host"
,
"name"
:
"Administrator"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-04-29T08:46:00Z"
},
"assignee"
:{
...
...
@@ -77,7 +75,7 @@ Parameters:
"username"
:
"admin"
,
"email"
:
"admin@local.host"
,
"name"
:
"Administrator"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-04-29T08:46:00Z"
}
}
...
...
@@ -97,7 +95,7 @@ Parameters:
+
`id`
(required) - The ID of a project
+
`source_branch`
(required) - The source branch
+
`target_branch`
(required) - The target branch
+
`assignee_id`
- Assignee user ID
+
`assignee_id`
(optional)
- Assignee user ID
+
`title`
(required) - Title of MR
```
json
...
...
@@ -107,14 +105,13 @@ Parameters:
"source_branch"
:
"test1"
,
"project_id"
:
3
,
"title"
:
"test1"
,
"closed"
:
true
,
"merged"
:
false
,
"state"
:
"opened"
,
"author"
:{
"id"
:
1
,
"username"
:
"admin"
,
"email"
:
"admin@local.host"
,
"name"
:
"Administrator"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-04-29T08:46:00Z"
},
"assignee"
:{
...
...
@@ -122,7 +119,7 @@ Parameters:
"username"
:
"admin"
,
"email"
:
"admin@local.host"
,
"name"
:
"Administrator"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-04-29T08:46:00Z"
}
}
...
...
@@ -145,24 +142,22 @@ Parameters:
+
`target_branch`
- The target branch
+
`assignee_id`
- Assignee user ID
+
`title`
- Title of MR
+
`closed`
- Status of MR. true - closed
```
json
{
"id"
:
1
,
"target_branch"
:
"master"
,
"source_branch"
:
"test1"
,
"project_id"
:
3
,
"title"
:
"test1"
,
"closed"
:
true
,
"merged"
:
false
,
"state"
:
"opened"
,
"author"
:{
"id"
:
1
,
"username"
:
"admin"
,
"email"
:
"admin@local.host"
,
"name"
:
"Administrator"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-04-29T08:46:00Z"
},
"assignee"
:{
...
...
@@ -170,7 +165,7 @@ Parameters:
"username"
:
"admin"
,
"email"
:
"admin@local.host"
,
"name"
:
"Administrator"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-04-29T08:46:00Z"
}
}
...
...
doc/api/milestones.md
View file @
62673d58
...
...
@@ -6,6 +6,21 @@ Returns a list of project milestones.
GET /projects/:id/milestones
```
```
json
[
{
"id"
:
12
,
"project_id"
:
16
,
"title"
:
"10.0"
,
"description"
:
"Version"
,
"due_date"
:
"2013-11-29"
,
"state"
:
"active"
,
"updated_at"
:
"2013-10-02T09:24:18Z"
,
"created_at"
:
"2013-10-02T09:24:18Z"
}
]
```
Parameters:
+
`id`
(required) - The ID of a project
...
...
doc/api/notes.md
View file @
62673d58
...
...
@@ -8,17 +8,22 @@ Get a list of project wall notes.
GET /projects/:id/notes
```
Parameters:
+
`id`
(required) - The ID of a project
```
json
[
{
"id"
:
522
,
"body"
:
"The solution is rather tricky"
,
"attachment"
:
null
,
"author"
:
{
"id"
:
1
,
"username"
:
"john_smith"
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-05-23T08:00:58Z"
},
"created_at"
:
"2012-11-27T19:16:44Z"
...
...
@@ -26,11 +31,6 @@ GET /projects/:id/notes
]
```
Parameters:
+
`id`
(required) - The ID of a project
### Get single wall note
Returns a single wall note.
...
...
@@ -74,6 +74,38 @@ Parameters:
+
`id`
(required) - The ID of a project
+
`issue_id`
(required) - The ID of an issue
```
json
[
{
"id"
:
302
,
"body"
:
"_Status changed to closed_"
,
"attachment"
:
null
,
"author"
:{
"id"
:
1
,
"username"
:
"pipin"
,
"email"
:
"admin@example.com"
,
"name"
:
"Pip"
,
"state"
:
"active"
,
"created_at"
:
"2013-09-30T13:46:01Z"
},
"created_at"
:
"2013-10-02T09:22:45Z"
},
{
"id"
:
305
,
"body"
:
"Text of the comment
\r\n
"
,
"attachment"
:
null
,
"author"
:{
"id"
:
1
,
"username"
:
"pipin"
,
"email"
:
"admin@example.com"
,
"name"
:
"Pip"
,
"state"
:
"active"
,
"created_at"
:
"2013-09-30T13:46:01Z"
},
"created_at"
:
"2013-10-02T09:56:03Z"
}
]
```
### Get single issue note
...
...
@@ -135,6 +167,24 @@ Parameters:
+
`snippet_id`
(required) - The ID of a project snippet
+
`note_id`
(required) - The ID of an snippet note
```
json
{
"id"
:
52
,
"title"
:
"Snippet"
,
"file_name"
:
"snippet.rb"
,
"author"
:{
"id"
:
1
,
"username"
:
"pipin"
,
"email"
:
"admin@example.com"
,
"name"
:
"Pip"
,
"state"
:
"active"
,
"created_at"
:
"2013-09-30T13:46:01Z"
},
"expires_at"
:
null
,
"updated_at"
:
"2013-10-02T07:34:20Z"
,
"created_at"
:
"2013-10-02T07:34:20Z"
}
```
### Create new snippet note
...
...
@@ -181,6 +231,22 @@ Parameters:
+
`merge_request_id`
(required) - The ID of a project merge request
+
`note_id`
(required) - The ID of a merge request note
```
json
{
"id"
:
301
,
"body"
:
"Comment for MR"
,
"attachment"
:
null
,
"author"
:{
"id"
:
1
,
"username"
:
"pipin"
,
"email"
:
"admin@example.com"
,
"name"
:
"Pip"
,
"state"
:
"active"
,
"created_at"
:
"2013-09-30T13:46:01Z"
},
"created_at"
:
"2013-10-02T08:57:14Z"
}
```
### Create new merge request note
...
...
doc/api/project_snippets.md
View file @
62673d58
...
...
@@ -34,7 +34,7 @@ Parameters:
"username"
:
"john_smith"
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-05-23T08:00:58Z"
},
"expires_at"
:
null
,
...
...
doc/api/projects.md
View file @
62673d58
...
...
@@ -11,51 +11,72 @@ GET /projects
```
json
[
{
"id"
:
3
,
"name"
:
"rails"
,
"id"
:
4
,
"description"
:
null
,
"default_branch"
:
"master"
,
"public"
:
false
,
"ssh_url_to_repo"
:
"git@example.com:diaspora/diaspora-client.git"
,
"http_url_to_repo"
:
"http://example.com/diaspora/diaspora-client.git"
,
"web_url"
:
"http://example.com/diaspora/diaspora-client"
,
"owner"
:
{
"id"
:
1
,
"username"
:
"john_smith"
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"blocked"
:
false
,
"created_at"
:
"2012-05-23T08:00:58Z"
"id"
:
3
,
"name"
:
"Diaspora"
,
"created_at"
:
"2013-09-30T13: 46: 02Z"
},
"public"
:
true
,
"path"
:
"rails"
,
"path_with_namespace"
:
"rails/rails"
,
"issues_enabled"
:
false
,
"merge_requests_enabled"
:
false
,
"wall_enabled"
:
true
,
"name"
:
"Diaspora Client"
,
"name_with_namespace"
:
"Diaspora / Diaspora Client"
,
"path"
:
"diaspora-client"
,
"path_with_namespace"
:
"diaspora/diaspora-client"
,
"issues_enabled"
:
true
,
"merge_requests_enabled"
:
true
,
"wall_enabled"
:
false
,
"wiki_enabled"
:
true
,
"created_at"
:
"2012-05-23T08:05:02Z"
,
"last_activity_at"
:
"2012-05-23T08:05:02Z"
"snippets_enabled"
:
false
,
"created_at"
:
"2013-09-30T13: 46: 02Z"
,
"last_activity_at"
:
"2013-09-30T13: 46: 02Z"
,
"namespace"
:
{
"created_at"
:
"2013-09-30T13: 46: 02Z"
,
"description"
:
""
,
"id"
:
3
,
"name"
:
"Diaspora"
,
"owner_id"
:
1
,
"path"
:
"diaspora"
,
"updated_at"
:
"2013-09-30T13: 46: 02Z"
}
},
{
"id"
:
5
,
"name"
:
"gitlab"
,
"id"
:
6
,
"description"
:
null
,
"default_branch"
:
"api"
,
"owner"
:
{
"id"
:
1
,
"username"
:
"john_smith"
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"blocked"
:
false
,
"created_at"
:
"2012-05-23T08:00:58Z"
"default_branch"
:
"master"
,
"public"
:
false
,
"ssh_url_to_repo"
:
"git@example.com:brightbox/puppet.git"
,
"http_url_to_repo"
:
"http://example.com/brightbox/puppet.git"
,
"web_url"
:
"http://example.com/brightbox/puppet"
,
"owner"
:
{
"id"
:
4
,
"name"
:
"Brightbox"
,
"created_at"
:
"2013-09-30T13:46:02Z"
},
"public"
:
true
,
"path"
:
"gitlab"
,
"path_with_namespace"
:
"randx/gitlab"
,
"name"
:
"Puppet"
,
"name_with_namespace"
:
"Brightbox / Puppet"
,
"path"
:
"puppet"
,
"path_with_namespace"
:
"brightbox/puppet"
,
"issues_enabled"
:
true
,
"merge_requests_enabled"
:
true
,
"wall_enabled"
:
tru
e
,
"wall_enabled"
:
fals
e
,
"wiki_enabled"
:
true
,
"snippets_enabled"
:
true
,
"created_at"
:
"2012-05-30T12:49:20Z"
,
"last_activity_at"
:
"2012-05-23T08:05:02Z"
"snippets_enabled"
:
false
,
"created_at"
:
"2013-09-30T13:46:02Z"
,
"last_activity_at"
:
"2013-09-30T13:46:02Z"
,
"namespace"
:
{
"created_at"
:
"2013-09-30T13:46:02Z"
,
"description"
:
""
,
"id"
:
4
,
"name"
:
"Brightbox"
,
"owner_id"
:
1
,
"path"
:
"brightbox"
,
"updated_at"
:
"2013-09-30T13:46:02Z"
}
}
]
```
...
...
@@ -76,29 +97,38 @@ Parameters:
```
json
{
"id"
:
5
,
"name"
:
"gitlab"
,
"name_with_namespace"
:
"GitLab / gitlabhq"
,
"id"
:
3
,
"description"
:
null
,
"default_branch"
:
"api"
,
"default_branch"
:
"master"
,
"public"
:
false
,
"ssh_url_to_repo"
:
"git@example.com:diaspora/diaspora-project-site.git"
,
"http_url_to_repo"
:
"http://example.com/diaspora/diaspora-project-site.git"
,
"web_url"
:
"http://example.com/diaspora/diaspora-project-site"
,
"owner"
:
{
"id"
:
1
,
"username"
:
"john_smith"
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"blocked"
:
false
,
"created_at"
:
"2012-05-23T08:00:58Z"
"id"
:
3
,
"name"
:
"Diaspora"
,
"created_at"
:
"2013-09-30T13: 46: 02Z"
},
"public"
:
true
,
"path"
:
"gitlab"
,
"path_with_namespace"
:
"randx/gitlab"
,
"name"
:
"Diaspora Project Site"
,
"name_with_namespace"
:
"Diaspora / Diaspora Project Site"
,
"path"
:
"diaspora-project-site"
,
"path_with_namespace"
:
"diaspora/diaspora-project-site"
,
"issues_enabled"
:
true
,
"merge_requests_enabled"
:
true
,
"wall_enabled"
:
tru
e
,
"wall_enabled"
:
fals
e
,
"wiki_enabled"
:
true
,
"snippets_enabled"
:
true
,
"created_at"
:
"2012-05-30T12:49:20Z"
,
"last_activity_at"
:
"2012-05-23T08:05:02Z"
"snippets_enabled"
:
false
,
"created_at"
:
"2013-09-30T13: 46: 02Z"
,
"last_activity_at"
:
"2013-09-30T13: 46: 02Z"
,
"namespace"
:
{
"created_at"
:
"2013-09-30T13: 46: 02Z"
,
"description"
:
""
,
"id"
:
3
,
"name"
:
"Diaspora"
,
"owner_id"
:
1
,
"path"
:
"diaspora"
,
"updated_at"
:
"2013-09-30T13: 46: 02Z"
}
}
```
...
...
@@ -191,17 +221,6 @@ Parameters:
+
`snippets_enabled`
(optional)
+
`public`
(optional)
**Project access levels**
The project access levels are defined in the
`user_project.rb`
class. Currently, these levels are recognized:
```
GUEST = 10
REPORTER = 20
DEVELOPER = 30
MASTER = 40
```
### Create project for user
...
...
@@ -261,7 +280,7 @@ Parameters:
"username"
:
"john_smith"
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-05-23T08:00:58Z"
,
"access_level"
:
40
}
...
...
@@ -417,6 +436,55 @@ Parameters:
+
`id`
(required) - The ID of the project
```
json
[
{
"name"
:
"async"
,
"commit"
:
{
"id"
:
"a2b702edecdf41f07b42653eb1abe30ce98b9fca"
,
"parents"
:
[{
"id"
:
"3f94fc7c85061973edc9906ae170cc269b07ca55"
}],
"tree"
:
"c68537c6534a02cc2b176ca1549f4ffa190b58ee"
,
"message"
:
"give caolan his credit where it's due (up top)"
,
"author"
:
{
"name"
:
"Jeremy Ashkenas"
,
"email"
:
"jashkenas@example.com"
},
"committer"
:
{
"name"
:
"Jeremy Ashkenas"
,
"email"
:
"jashkenas@example.com"
},
"authored_date"
:
"2010-12-08T21:28:50+00:00"
,
"committed_date"
:
"2010-12-08T21:28:50+00:00"
},
"protected"
:
false
},
{
"name"
:
"gh-pages"
,
"commit"
:
{
"id"
:
"101c10a60019fe870d21868835f65c25d64968fc"
,
"parents"
:
[{
"id"
:
"9c15d2e26945a665131af5d7b6d30a06ba338aaa"
}],
"tree"
:
"fb5cc9d45da3014b17a876ad539976a0fb9b352a"
,
"message"
:
"Underscore.js 1.5.2"
,
"author"
:
{
"name"
:
"Jeremy Ashkenas"
,
"email"
:
"jashkenas@example.com"
},
"committer"
:
{
"name"
:
"Jeremy Ashkenas"
,
"email"
:
"jashkenas@example.com"
},
"authored_date"
:
"2013-09-07T12: 58: 21+00: 00"
,
"committed_date"
:
"2013-09-07T12: 58: 21+00: 00"
},
"protected"
:
false
}
]
```
### List single branch
...
...
doc/api/system_hooks.md
View file @
62673d58
...
...
@@ -12,6 +12,15 @@ Parameters:
+
**none**
```
json
[
{
"id"
:
3
,
"url"
:
"http://example.com/hook"
,
"created_at"
:
"2013-10-02T10:15:31Z"
}
]
```
## Add new system hook hook
...
...
@@ -34,6 +43,16 @@ Parameters:
+
`id`
(required) - The ID of hook
```
json
{
"event_name"
:
"project_create"
,
"name"
:
"Ruby"
,
"path"
:
"ruby"
,
"project_id"
:
1
,
"owner_name"
:
"Someone"
,
"owner_email"
:
"example@gitlabhq.com"
}
```
## Delete system hook
...
...
doc/api/user_teams.md
deleted
100644 → 0
View file @
c44c5f5f
## User teams
### List user teams
Get a list of user teams viewable by the authenticated user.
```
GET /user_teams
```
```
json
[
{
id:
1
,
name:
"User team 1"
,
path:
"user_team1"
,
owner_id:
1
},
{
id:
2
,
name:
"User team 2"
,
path:
"user_team2"
,
owner_id:
1
}
]
```
### Get single user team
Get a specific user team, identified by user team ID, which is viewable by the authenticated user.
```
GET /user_teams/:id
```
Parameters:
+
`id`
(required) - The ID of a user_team
```
json
{
id:
1
,
name:
"User team 1"
,
path:
"user_team1"
,
owner_id:
1
}
```
### Create user team
Creates new user team owned by user. Available only for admins.
```
POST /user_teams
```
Parameters:
+
`name`
(required) - new user team name
+
`path`
(required) - new user team internal name
## User team members
### List user team members
Get a list of project team members.
```
GET /user_teams/:id/members
```
Parameters:
+
`id`
(required) - The ID of a user_team
### Get user team member
Gets a user team member.
```
GET /user_teams/:id/members/:user_id
```
Parameters:
+
`id`
(required) - The ID of a user_team
+
`user_id`
(required) - The ID of a user
```
json
{
id:
2
,
username:
"john_doe"
,
email:
"joh@doe.org"
,
name:
"John Doe"
,
state:
"active"
,
created_at:
"2012-10-22T14:13:35Z"
,
access_level:
30
}
```
### Add user team member
Adds a user to a user team.
```
POST /user_teams/:id/members
```
Parameters:
+
`id`
(required) - The ID of a user team
+
`user_id`
(required) - The ID of a user to add
+
`access_level`
(required) - Project access level
### Remove user team member
Removes user from user team.
```
DELETE /user_teams/:id/members/:user_id
```
Parameters:
+
`id`
(required) - The ID of a user team
+
`user_id`
(required) - The ID of a team member
## User team projects
### List user team projects
Get a list of project team projects.
```
GET /user_teams/:id/projects
```
Parameters:
+
`id`
(required) - The ID of a user_team
### Get user team project
Gets a user team project.
```
GET /user_teams/:id/projects/:project_id
```
Parameters:
+
`id`
(required) - The ID of a user_team
+
`project_id`
(required) - The ID of a user
```
json
{
id:
12
,
name:
"project1"
,
description:
null
,
default_branch:
"develop"
,
public:
false
,
path:
"project1"
,
path_with_namespace:
"group1/project1"
,
issues_enabled:
false
,
merge_requests_enabled:
true
,
wall_enabled:
true
,
wiki_enabled:
false
,
created_at:
"2013-03-11T12:59:08Z"
,
greatest_access_level:
30
}
```
### Add user team project
Adds a project to a user team.
```
POST /user_teams/:id/projects
```
Parameters:
+
`id`
(required) - The ID of a user team
+
`project_id`
(required) - The ID of a project to add
+
`greatest_access_level`
(required) - Maximum project access level
### Remove user team project
Removes project from user team.
```
DELETE /user_teams/:id/projects/:project_id
```
Parameters:
+
`id`
(required) - The ID of a user team
+
`project_id`
(required) - The ID of a team project
doc/api/users.md
View file @
62673d58
...
...
@@ -43,7 +43,8 @@ GET /users
"theme_id"
:
1
,
"color_scheme_id"
:
3
,
"is_admin"
:
false
,
"can_create_group"
:
true
"can_create_group"
:
true
,
"can_create_project"
:
true
}
]
```
...
...
@@ -78,7 +79,8 @@ Parameters:
"theme_id"
:
1
,
"color_scheme_id"
:
2
,
"is_admin"
:
false
,
"can_create_group"
:
true
"can_create_group"
:
true
,
"can_create_project"
:
true
}
```
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment