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
Jérome Perrin
gitlab-ce
Commits
f1253fa7
Commit
f1253fa7
authored
Oct 02, 2013
by
Marin Jankovski
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update issues, milestones, notes api docs.
parent
5e96d070
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
97 additions
and
16 deletions
+97
-16
doc/api/issues.md
doc/api/issues.md
+10
-10
doc/api/milestones.md
doc/api/milestones.md
+15
-0
doc/api/notes.md
doc/api/notes.md
+72
-6
No files found.
doc/api/issues.md
View file @
f1253fa7
...
@@ -22,10 +22,10 @@ GET /issues
...
@@ -22,10 +22,10 @@ GET /issues
"username"
:
"john_smith"
,
"username"
:
"john_smith"
,
"email"
:
"john@example.com"
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"name"
:
"John Smith"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-05-23T08:00:58Z"
"created_at"
:
"2012-05-23T08:00:58Z"
},
},
"state"
:
'closed'
,
"state"
:
"closed"
,
"updated_at"
:
"2012-07-02T17:53:12Z"
,
"updated_at"
:
"2012-07-02T17:53:12Z"
,
"created_at"
:
"2012-07-02T17:53:12Z"
"created_at"
:
"2012-07-02T17:53:12Z"
},
},
...
@@ -42,7 +42,7 @@ GET /issues
...
@@ -42,7 +42,7 @@ GET /issues
"title"
:
"v1.0"
,
"title"
:
"v1.0"
,
"description"
:
""
,
"description"
:
""
,
"due_date"
:
"2012-07-20"
,
"due_date"
:
"2012-07-20"
,
"state"
:
'reopenend'
,
"state"
:
"reopenend"
,
"updated_at"
:
"2012-07-04T13:42:48Z"
,
"updated_at"
:
"2012-07-04T13:42:48Z"
,
"created_at"
:
"2012-07-04T13:42:48Z"
"created_at"
:
"2012-07-04T13:42:48Z"
},
},
...
@@ -51,7 +51,7 @@ GET /issues
...
@@ -51,7 +51,7 @@ GET /issues
"username"
:
"jack_smith"
,
"username"
:
"jack_smith"
,
"email"
:
"jack@example.com"
,
"email"
:
"jack@example.com"
,
"name"
:
"Jack Smith"
,
"name"
:
"Jack Smith"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-05-23T08:01:01Z"
"created_at"
:
"2012-05-23T08:01:01Z"
},
},
"author"
:
{
"author"
:
{
...
@@ -59,10 +59,10 @@ GET /issues
...
@@ -59,10 +59,10 @@ GET /issues
"username"
:
"john_smith"
,
"username"
:
"john_smith"
,
"email"
:
"john@example.com"
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"name"
:
"John Smith"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-05-23T08:00:58Z"
"created_at"
:
"2012-05-23T08:00:58Z"
},
},
"state"
:
'opened'
,
"state"
:
"opened"
,
"updated_at"
:
"2012-07-12T13:43:19Z"
,
"updated_at"
:
"2012-07-12T13:43:19Z"
,
"created_at"
:
"2012-06-28T12:58:06Z"
"created_at"
:
"2012-06-28T12:58:06Z"
}
}
...
@@ -111,7 +111,7 @@ Parameters:
...
@@ -111,7 +111,7 @@ Parameters:
"title"
:
"v1.0"
,
"title"
:
"v1.0"
,
"description"
:
""
,
"description"
:
""
,
"due_date"
:
"2012-07-20"
,
"due_date"
:
"2012-07-20"
,
"state"
:
'closed'
,
"state"
:
"closed"
,
"updated_at"
:
"2012-07-04T13:42:48Z"
,
"updated_at"
:
"2012-07-04T13:42:48Z"
,
"created_at"
:
"2012-07-04T13:42:48Z"
"created_at"
:
"2012-07-04T13:42:48Z"
},
},
...
@@ -120,7 +120,7 @@ Parameters:
...
@@ -120,7 +120,7 @@ Parameters:
"username"
:
"jack_smith"
,
"username"
:
"jack_smith"
,
"email"
:
"jack@example.com"
,
"email"
:
"jack@example.com"
,
"name"
:
"Jack Smith"
,
"name"
:
"Jack Smith"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-05-23T08:01:01Z"
"created_at"
:
"2012-05-23T08:01:01Z"
},
},
"author"
:
{
"author"
:
{
...
@@ -128,10 +128,10 @@ Parameters:
...
@@ -128,10 +128,10 @@ Parameters:
"username"
:
"john_smith"
,
"username"
:
"john_smith"
,
"email"
:
"john@example.com"
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"name"
:
"John Smith"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-05-23T08:00:58Z"
"created_at"
:
"2012-05-23T08:00:58Z"
},
},
"state"
:
'opened'
,
"state"
:
"opened"
,
"updated_at"
:
"2012-07-12T13:43:19Z"
,
"updated_at"
:
"2012-07-12T13:43:19Z"
,
"created_at"
:
"2012-06-28T12:58:06Z"
"created_at"
:
"2012-06-28T12:58:06Z"
}
}
...
...
doc/api/milestones.md
View file @
f1253fa7
...
@@ -6,6 +6,21 @@ Returns a list of project milestones.
...
@@ -6,6 +6,21 @@ Returns a list of project milestones.
GET /projects/:id/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:
Parameters:
+
`id`
(required) - The ID of a project
+
`id`
(required) - The ID of a project
...
...
doc/api/notes.md
View file @
f1253fa7
...
@@ -8,17 +8,22 @@ Get a list of project wall notes.
...
@@ -8,17 +8,22 @@ Get a list of project wall notes.
GET /projects/:id/notes
GET /projects/:id/notes
```
```
Parameters:
+
`id`
(required) - The ID of a project
```
json
```
json
[
[
{
{
"id"
:
522
,
"id"
:
522
,
"body"
:
"The solution is rather tricky"
,
"body"
:
"The solution is rather tricky"
,
"attachment"
:
null
,
"author"
:
{
"author"
:
{
"id"
:
1
,
"id"
:
1
,
"username"
:
"john_smith"
,
"username"
:
"john_smith"
,
"email"
:
"john@example.com"
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"name"
:
"John Smith"
,
"
blocked"
:
false
,
"
state"
:
"active"
,
"created_at"
:
"2012-05-23T08:00:58Z"
"created_at"
:
"2012-05-23T08:00:58Z"
},
},
"created_at"
:
"2012-11-27T19:16:44Z"
"created_at"
:
"2012-11-27T19:16:44Z"
...
@@ -26,11 +31,6 @@ GET /projects/:id/notes
...
@@ -26,11 +31,6 @@ GET /projects/:id/notes
]
]
```
```
Parameters:
+
`id`
(required) - The ID of a project
### Get single wall note
### Get single wall note
Returns a single wall note.
Returns a single wall note.
...
@@ -74,6 +74,38 @@ Parameters:
...
@@ -74,6 +74,38 @@ Parameters:
+
`id`
(required) - The ID of a project
+
`id`
(required) - The ID of a project
+
`issue_id`
(required) - The ID of an issue
+
`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
### Get single issue note
...
@@ -135,6 +167,24 @@ Parameters:
...
@@ -135,6 +167,24 @@ Parameters:
+
`snippet_id`
(required) - The ID of a project snippet
+
`snippet_id`
(required) - The ID of a project snippet
+
`note_id`
(required) - The ID of an snippet note
+
`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
### Create new snippet note
...
@@ -181,6 +231,22 @@ Parameters:
...
@@ -181,6 +231,22 @@ Parameters:
+
`merge_request_id`
(required) - The ID of a project merge request
+
`merge_request_id`
(required) - The ID of a project merge request
+
`note_id`
(required) - The ID of a merge request note
+
`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
### Create new merge request note
...
...
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