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
1
Merge Requests
1
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
nexedi
gitlab-ce
Commits
569a595a
Commit
569a595a
authored
Jun 14, 2017
by
Oswaldo Ferreira
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add docs
parent
369138ff
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
103 additions
and
0 deletions
+103
-0
doc/api/issue_links.md
doc/api/issue_links.md
+103
-0
No files found.
doc/api/issue_links.md
0 → 100644
View file @
569a595a
# Issue links API
## List issue relations
Get a list of related issues of a given issue, sorted by the relationship creation datetime (ascending).
Issues will be filtered according users authorization.
```
GET /projects/:id/issues/:issue_iid/links
```
Parameters:
| Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------|
|
`id`
| integer/string | yes | The ID or
[
URL-encoded path of the project
](
README.md#namespaced-path-encoding
)
owned by the authenticated user |
|
`issue_iid`
| integer | yes | The internal ID of a project's issue |
```
json
[
{
"id"
:
84
,
"iid"
:
14
,
"issue_link_id"
:
1
"project_id"
:
4
,
"created_at"
:
"2016-01-07T12:44:33.959Z"
,
"title"
:
"Issues with auth"
,
"state"
:
"opened"
,
"assignees"
:
[],
"assignee"
:
null
,
"labels"
:
[
"bug"
],
"author"
:
{
"name"
:
"Alexandra Bashirian"
,
"avatar_url"
:
null
,
"state"
:
"active"
,
"web_url"
:
"https://gitlab.example.com/eileen.lowe"
,
"id"
:
18
,
"username"
:
"eileen.lowe"
},
"description"
:
null
,
"updated_at"
:
"2016-01-07T12:44:33.959Z"
,
"milestone"
:
null
,
"subscribed"
:
true
,
"user_notes_count"
:
0
,
"due_date"
:
null
,
"web_url"
:
"http://example.com/example/example/issues/14"
,
"confidential"
:
false
,
"weight"
:
null
,
}
]
```
## Create an issue link
Creates a two-way relation between an issue to another. Users must have write access on both issues
in order to succeed.
```
POST /projects/:id/issues/:issue_iid/links
```
| Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------|
|
`id`
| integer/string | yes | The ID or
[
URL-encoded path of the project
](
README.md#namespaced-path-encoding
)
owned by the authenticated user |
|
`issue_iid`
| integer | yes | The internal ID of a project's issue |
|
`target_project_id`
| integer/string | yes | The ID or
[
URL-encoded path of the project
](
README.md#namespaced-path-encoding
)
of a target project |
|
`target_issue_iid`
| integer/string | yes | The internal ID of a target project's issue |
```
json
{
"id"
:
1
,
"source_issue_id"
:
2
,
"target_issue_id"
:
3
}
```
## Delete an issue link
Deletes an issue link, thus removes the two-way relationship.
```
DELETE /projects/:id/issues/:issue_iid/links/:issue_link_id
```
| Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------|
|
`id`
| integer/string | yes | The ID or
[
URL-encoded path of the project
](
README.md#namespaced-path-encoding
)
owned by the authenticated user |
|
`issue_iid`
| integer | yes | The internal ID of a project's issue |
|
`issue_link_id`
| integer/string | yes | The ID of an issue relationship |
```
json
{
"id"
:
1
,
"source_issue_id"
:
2
,
"target_issue_id"
:
3
}
```
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