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
024e0348
Commit
024e0348
authored
Jul 24, 2012
by
Nihad Abbasov
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
update API docs
parent
7b33d8cb
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
182 additions
and
0 deletions
+182
-0
doc/api/README.md
doc/api/README.md
+1
-0
doc/api/issues.md
doc/api/issues.md
+181
-0
No files found.
doc/api/README.md
View file @
024e0348
...
...
@@ -27,3 +27,4 @@ The API uses JSON to serialize data. You don't need to specify `.json` at the en
+
[
Users
](
https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/users.md
)
+
[
Projects
](
https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/projects.md
)
+
[
Issues
](
https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/issues.md
)
doc/api/issues.md
0 → 100644
View file @
024e0348
## List issues
Get all issues created by authenticed user.
```
GET /issues
```
```
json
[
{
"id"
:
43
,
"title"
:
"4xx/5xx pages"
,
"description"
:
""
,
"labels"
:
[
],
"milestone"
:
null
,
"assignee"
:
null
,
"author"
:
{
"id"
:
1
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"blocked"
:
false
,
"created_at"
:
"2012-05-23T08:00:58Z"
},
"closed"
:
true
,
"updated_at"
:
"2012-07-02T17:53:12Z"
,
"created_at"
:
"2012-07-02T17:53:12Z"
},
{
"id"
:
42
,
"title"
:
"Add user settings"
,
"description"
:
""
,
"labels"
:
[
"feature"
],
"milestone"
:
{
"id"
:
1
,
"title"
:
"v1.0"
,
"description"
:
""
,
"due_date"
:
"2012-07-20"
,
"closed"
:
false
,
"updated_at"
:
"2012-07-04T13:42:48Z"
,
"created_at"
:
"2012-07-04T13:42:48Z"
},
"assignee"
:
{
"id"
:
2
,
"email"
:
"jack@example.com"
,
"name"
:
"Jack Smith"
,
"blocked"
:
false
,
"created_at"
:
"2012-05-23T08:01:01Z"
},
"author"
:
{
"id"
:
1
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"blocked"
:
false
,
"created_at"
:
"2012-05-23T08:00:58Z"
},
"closed"
:
false
,
"updated_at"
:
"2012-07-12T13:43:19Z"
,
"created_at"
:
"2012-06-28T12:58:06Z"
}
]
```
## List project issues
Get a list of project issues.
```
GET /projects/:id/issues
```
Parameters:
+
`id`
(required) - The code name of a project
## Single issue
Get a project issue.
```
GET /projects/:id/issues/:issue_id
```
Parameters:
+
`id`
(required) - The code name of a project
+
`issue_id`
(required) - The ID of a project issue
```
json
{
"id"
:
42
,
"title"
:
"Add user settings"
,
"description"
:
""
,
"labels"
:
[
"feature"
],
"milestone"
:
{
"id"
:
1
,
"title"
:
"v1.0"
,
"description"
:
""
,
"due_date"
:
"2012-07-20"
,
"closed"
:
false
,
"updated_at"
:
"2012-07-04T13:42:48Z"
,
"created_at"
:
"2012-07-04T13:42:48Z"
},
"assignee"
:
{
"id"
:
2
,
"email"
:
"jack@example.com"
,
"name"
:
"Jack Smith"
,
"blocked"
:
false
,
"created_at"
:
"2012-05-23T08:01:01Z"
},
"author"
:
{
"id"
:
1
,
"email"
:
"john@example.com"
,
"name"
:
"John Smith"
,
"blocked"
:
false
,
"created_at"
:
"2012-05-23T08:00:58Z"
},
"closed"
:
false
,
"updated_at"
:
"2012-07-12T13:43:19Z"
,
"created_at"
:
"2012-06-28T12:58:06Z"
}
```
## New issue
Create a new project issue.
```
POST /projects/:id/issues
```
Parameters:
+
`id`
(required) - The code name of a project
+
`title`
(required) - The title of an issue
+
`description`
(optional) - The description of an issue
+
`assignee_id`
(optional) - The ID of a user to assign issue
+
`milestone_id`
(optional) - The ID of a milestone to assign issue
+
`labels`
(optional) - Comma-separated label names for an issue
Will return created issue with status
`201 Created`
on success, or
`404 Not found`
on fail.
## Edit issue
Update an existing project issue.
```
PUT /projects/:id/issues/:issue_id
```
Parameters:
+
`id`
(required) - The code name of a project
+
`issue_id`
(required) - The ID of a project's issue
+
`title`
(optional) - The title of an issue
+
`description`
(optional) - The description of an issue
+
`assignee_id`
(optional) - The ID of a user to assign issue
+
`milestone_id`
(optional) - The ID of a milestone to assign issue
+
`labels`
(optional) - Comma-separated label names for an issue
+
`closed`
(optional) - The state of an issue (0 = false, 1 = true)
Will return updated issue with status
`200 OK`
on success, or
`404 Not found`
on fail.
## Delete issue
Delete existing project issue.
```
DELETE /projects/:id/issues/:issue_id
```
Parameters:
+
`id`
(required) - The code name of a project
+
`issue_id`
(required) - The ID of a project's issue
Status code
`200`
will be returned on success.
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