summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-08-12 12:10:25 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-08-12 12:10:25 +0000
commit999f47e9e6da399de9dc1de404f073f7dd30af0d (patch)
tree926bf806abb6705632dc19ceb75269f40a4c9fac /doc/api
parent20bd3b7d4ebb1d7ebef305656b156313d09a6674 (diff)
downloadgitlab-ce-999f47e9e6da399de9dc1de404f073f7dd30af0d.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/epics.md48
-rw-r--r--doc/api/graphql/reference/gitlab_schema.graphql15
-rw-r--r--doc/api/graphql/reference/gitlab_schema.json37
-rw-r--r--doc/api/issues.md88
4 files changed, 130 insertions, 58 deletions
diff --git a/doc/api/epics.md b/doc/api/epics.md
index fcdbb8cea71..45bf406dec2 100644
--- a/doc/api/epics.md
+++ b/doc/api/epics.md
@@ -92,7 +92,7 @@ Example response:
"description": "Molestias dolorem eos vitae expedita impedit necessitatibus quo voluptatum.",
"state": "opened",
"confidential": "false",
- "web_url": "http://localhost:3001/groups/test/-/epics/4",
+ "web_url": "http://gitlab.example.com/groups/test/-/epics/4",
"reference": "&4",
"references": {
"short": "&4",
@@ -105,7 +105,7 @@ Example response:
"username": "kam",
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/018729e129a6f31c80a6327a30196823?s=80&d=identicon",
- "web_url": "http://localhost:3001/kam"
+ "web_url": "http://gitlab.example.com/kam"
},
"start_date": null,
"start_date_is_fixed": false,
@@ -123,7 +123,12 @@ Example response:
"closed_at": "2018-08-18T12:22:05.239Z",
"labels": [],
"upvotes": 4,
- "downvotes": 0
+ "downvotes": 0,
+ "_links":{
+ "self": "http://gitlab.example.com/api/v4/groups/7/epics/4",
+ "epic_issues": "http://gitlab.example.com/api/v4/groups/7/epics/4/issues",
+ "group":"http://gitlab.example.com/api/v4/groups/7"
+ }
},
{
"id": 50,
@@ -133,7 +138,7 @@ Example response:
"title": "Accusamus iste et ullam ratione voluptatem omnis debitis dolor est.",
"description": "Molestias dolorem eos vitae expedita impedit necessitatibus quo voluptatum.",
"state": "opened",
- "web_url": "http://localhost:3001/groups/test/sample/-/epics/4",
+ "web_url": "http://gitlab.example.com/groups/test/sample/-/epics/35",
"reference": "&4",
"references": {
"short": "&4",
@@ -146,7 +151,7 @@ Example response:
"username": "kam",
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/018729e129a6f31c80a6327a30196823?s=80&d=identicon",
- "web_url": "http://localhost:3001/kam"
+ "web_url": "http://gitlab.example.com/kam"
},
"start_date": null,
"start_date_is_fixed": false,
@@ -164,7 +169,12 @@ Example response:
"closed_at": "2018-08-18T12:22:05.239Z",
"labels": [],
"upvotes": 4,
- "downvotes": 0
+ "downvotes": 0,
+ "_links":{
+ "self": "http://gitlab.example.com/api/v4/groups/17/epics/35",
+ "epic_issues": "http://gitlab.example.com/api/v4/groups/17/epics/35/issues",
+ "group":"http://gitlab.example.com/api/v4/groups/17"
+ }
}
]
```
@@ -196,7 +206,7 @@ Example response:
"title": "Ea cupiditate dolores ut vero consequatur quasi veniam voluptatem et non.",
"description": "Molestias dolorem eos vitae expedita impedit necessitatibus quo voluptatum.",
"state": "opened",
- "web_url": "http://localhost:3001/groups/test/-/epics/5",
+ "web_url": "http://gitlab.example.com/groups/test/-/epics/5",
"reference": "&5",
"references": {
"short": "&5",
@@ -209,7 +219,7 @@ Example response:
"username": "arnita",
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/a2f5c6fcef64c9c69cb8779cb292be1b?s=80&d=identicon",
- "web_url": "http://localhost:3001/arnita"
+ "web_url": "http://gitlab.example.com/arnita"
},
"start_date": null,
"start_date_is_fixed": false,
@@ -228,7 +238,12 @@ Example response:
"labels": [],
"upvotes": 4,
"downvotes": 0,
- "subscribed": true
+ "subscribed": true,
+ "_links":{
+ "self": "http://gitlab.example.com/api/v4/groups/7/epics/5",
+ "epic_issues": "http://gitlab.example.com/api/v4/groups/7/epics/5/issues",
+ "group":"http://gitlab.example.com/api/v4/groups/7"
+ }
}
```
@@ -273,7 +288,7 @@ Example response:
"description": "Epic description",
"state": "opened",
"confidential": "false",
- "web_url": "http://localhost:3001/groups/test/-/epics/6",
+ "web_url": "http://gitlab.example.com/groups/test/-/epics/6",
"reference": "&6",
"references": {
"short": "&6",
@@ -304,7 +319,12 @@ Example response:
"closed_at": "2018-08-18T12:22:05.239Z",
"labels": [],
"upvotes": 4,
- "downvotes": 0
+ "downvotes": 0,
+ "_links":{
+ "self": "http://gitlab.example.com/api/v4/groups/7/epics/6",
+ "epic_issues": "http://gitlab.example.com/api/v4/groups/7/epics/6/issues",
+ "group":"http://gitlab.example.com/api/v4/groups/7"
+ }
}
```
@@ -350,7 +370,7 @@ Example response:
"description": "Epic description",
"state": "opened",
"confidential": "false",
- "web_url": "http://localhost:3001/groups/test/-/epics/6",
+ "web_url": "http://gitlab.example.com/groups/test/-/epics/6",
"reference": "&6",
"references": {
"short": "&6",
@@ -456,9 +476,9 @@ Example response:
"username": "arnita",
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/a2f5c6fcef64c9c69cb8779cb292be1b?s=80&d=identicon",
- "web_url": "http://localhost:3001/arnita"
+ "web_url": "http://gitlab.example.com/arnita"
},
- "web_url": "http://localhost:3001/groups/test/-/epics/5",
+ "web_url": "http://gitlab.example.com/groups/test/-/epics/5",
"reference": "&5",
"references": {
"short": "&5",
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql
index 56cf71b6d6d..abed0c85947 100644
--- a/doc/api/graphql/reference/gitlab_schema.graphql
+++ b/doc/api/graphql/reference/gitlab_schema.graphql
@@ -4313,6 +4313,11 @@ type DismissVulnerabilityPayload {
vulnerability: Vulnerability
}
+"""
+Identifier of EE::Iteration
+"""
+scalar EEIterationID
+
interface Entry {
"""
Flat path of the entry
@@ -12097,6 +12102,16 @@ type Query {
instanceSecurityDashboard: InstanceSecurityDashboard
"""
+ Find an iteration
+ """
+ iteration(
+ """
+ Find an iteration by its ID
+ """
+ id: EEIterationID!
+ ): Iteration
+
+ """
Metadata about GitLab
"""
metadata: Metadata
diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json
index b37573dc54e..44ffda7737f 100644
--- a/doc/api/graphql/reference/gitlab_schema.json
+++ b/doc/api/graphql/reference/gitlab_schema.json
@@ -12010,6 +12010,16 @@
"possibleTypes": null
},
{
+ "kind": "SCALAR",
+ "name": "EEIterationID",
+ "description": "Identifier of EE::Iteration",
+ "fields": null,
+ "inputFields": null,
+ "interfaces": null,
+ "enumValues": null,
+ "possibleTypes": null
+ },
+ {
"kind": "INTERFACE",
"name": "Entry",
"description": null,
@@ -35599,6 +35609,33 @@
"deprecationReason": null
},
{
+ "name": "iteration",
+ "description": "Find an iteration",
+ "args": [
+ {
+ "name": "id",
+ "description": "Find an iteration by its ID",
+ "type": {
+ "kind": "NON_NULL",
+ "name": null,
+ "ofType": {
+ "kind": "SCALAR",
+ "name": "EEIterationID",
+ "ofType": null
+ }
+ },
+ "defaultValue": null
+ }
+ ],
+ "type": {
+ "kind": "OBJECT",
+ "name": "Iteration",
+ "ofType": null
+ },
+ "isDeprecated": false,
+ "deprecationReason": null
+ },
+ {
"name": "metadata",
"description": "Metadata about GitLab",
"args": [
diff --git a/doc/api/issues.md b/doc/api/issues.md
index 99ba31ad3bc..262f0cd705e 100644
--- a/doc/api/issues.md
+++ b/doc/api/issues.md
@@ -134,7 +134,7 @@ Example response:
"merge_requests_count": 0,
"user_notes_count": 1,
"due_date": "2016-07-22",
- "web_url": "http://example.com/my-group/my-project/issues/6",
+ "web_url": "http://gitlab.example.com/my-group/my-project/issues/6",
"references": {
"short": "#6",
"relative": "my-group/my-project#6",
@@ -151,10 +151,10 @@ Example response:
"confidential": false,
"discussion_locked": false,
"_links":{
- "self":"http://example.com/api/v4/projects/1/issues/76",
- "notes":"`http://example.com/`api/v4/projects/1/issues/76/notes",
- "award_emoji":"http://example.com/api/v4/projects/1/issues/76/award_emoji",
- "project":"http://example.com/api/v4/projects/1"
+ "self":"http://gitlab.example.com/api/v4/projects/1/issues/76",
+ "notes":"http://gitlab.example.com/api/v4/projects/1/issues/76/notes",
+ "award_emoji":"http://gitlab.example.com/api/v4/projects/1/issues/76/award_emoji",
+ "project":"http://gitlab.example.com/api/v4/projects/1"
},
"task_completion_status":{
"count":0,
@@ -292,7 +292,7 @@ Example response:
"closed_by" : null,
"user_notes_count": 1,
"due_date": null,
- "web_url": "http://example.com/my-group/my-project/issues/1",
+ "web_url": "http://gitlab.example.com/my-group/my-project/issues/1",
"references": {
"short": "#1",
"relative": "my-project#1",
@@ -309,10 +309,10 @@ Example response:
"confidential": false,
"discussion_locked": false,
"_links":{
- "self":"http://example.com/api/v4/projects/4/issues/41",
- "notes":"`http://example.com/`api/v4/projects/4/issues/41/notes",
- "award_emoji":"http://example.com/api/v4/projects/4/issues/41/award_emoji",
- "project":"http://example.com/api/v4/projects/4"
+ "self":"http://gitlab.example.com/api/v4/projects/4/issues/41",
+ "notes":"http://gitlab.example.com/api/v4/projects/4/issues/41/notes",
+ "award_emoji":"http://gitlab.example.com/api/v4/projects/4/issues/41/award_emoji",
+ "project":"http://gitlab.example.com/api/v4/projects/4"
},
"task_completion_status":{
"count":0,
@@ -456,7 +456,7 @@ Example response:
},
"user_notes_count": 1,
"due_date": "2016-07-22",
- "web_url": "http://example.com/my-group/my-project/issues/1",
+ "web_url": "http://gitlab.example.com/my-group/my-project/issues/1",
"references": {
"short": "#1",
"relative": "#1",
@@ -473,10 +473,10 @@ Example response:
"confidential": false,
"discussion_locked": false,
"_links":{
- "self":"http://example.com/api/v4/projects/4/issues/41",
- "notes":"`http://example.com/`api/v4/projects/4/issues/41/notes",
- "award_emoji":"http://example.com/api/v4/projects/4/issues/41/award_emoji",
- "project":"http://example.com/api/v4/projects/4"
+ "self":"http://gitlab.example.com/api/v4/projects/4/issues/41",
+ "notes":"http://gitlab.example.com/api/v4/projects/4/issues/41/notes",
+ "award_emoji":"http://gitlab.example.com/api/v4/projects/4/issues/41/award_emoji",
+ "project":"http://gitlab.example.com/api/v4/projects/4"
},
"task_completion_status":{
"count":0,
@@ -581,7 +581,7 @@ Example response:
"subscribed": false,
"user_notes_count": 1,
"due_date": null,
- "web_url": "http://example.com/my-group/my-project/issues/1",
+ "web_url": "http://gitlab.example.com/my-group/my-project/issues/1",
"references": {
"short": "#1",
"relative": "#1",
@@ -596,10 +596,10 @@ Example response:
"confidential": false,
"discussion_locked": false,
"_links": {
- "self": "http://example.com/api/v4/projects/1/issues/2",
- "notes": "http://example.com/api/v4/projects/1/issues/2/notes",
- "award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji",
- "project": "http://example.com/api/v4/projects/1"
+ "self": "http://gitlab.example.com/api/v4/projects/1/issues/2",
+ "notes": "http://gitlab.example.com/api/v4/projects/1/issues/2/notes",
+ "award_emoji": "http://gitlab.example.com/api/v4/projects/1/issues/2/award_emoji",
+ "project": "http://gitlab.example.com/api/v4/projects/1"
},
"task_completion_status":{
"count":0,
@@ -710,7 +710,7 @@ Example response:
"subscribed" : true,
"user_notes_count": 0,
"due_date": null,
- "web_url": "http://example.com/my-group/my-project/issues/14",
+ "web_url": "http://gitlab.example.com/my-group/my-project/issues/14",
"references": {
"short": "#14",
"relative": "#14",
@@ -725,10 +725,10 @@ Example response:
"confidential": false,
"discussion_locked": false,
"_links": {
- "self": "http://example.com/api/v4/projects/1/issues/2",
- "notes": "http://example.com/api/v4/projects/1/issues/2/notes",
- "award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji",
- "project": "http://example.com/api/v4/projects/1"
+ "self": "http://gitlab.example.com/api/v4/projects/1/issues/2",
+ "notes": "http://gitlab.example.com/api/v4/projects/1/issues/2/notes",
+ "award_emoji": "http://gitlab.example.com/api/v4/projects/1/issues/2/award_emoji",
+ "project": "http://gitlab.example.com/api/v4/projects/1"
},
"task_completion_status":{
"count":0,
@@ -832,7 +832,7 @@ Example response:
"subscribed" : true,
"user_notes_count": 0,
"due_date": "2016-07-22",
- "web_url": "http://example.com/my-group/my-project/issues/15",
+ "web_url": "http://gitlab.example.com/my-group/my-project/issues/15",
"references": {
"short": "#15",
"relative": "#15",
@@ -847,10 +847,10 @@ Example response:
"confidential": false,
"discussion_locked": false,
"_links": {
- "self": "http://example.com/api/v4/projects/1/issues/2",
- "notes": "http://example.com/api/v4/projects/1/issues/2/notes",
- "award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji",
- "project": "http://example.com/api/v4/projects/1"
+ "self": "http://gitlab.example.com/api/v4/projects/1/issues/2",
+ "notes": "http://gitlab.example.com/api/v4/projects/1/issues/2/notes",
+ "award_emoji": "http://gitlab.example.com/api/v4/projects/1/issues/2/award_emoji",
+ "project": "http://gitlab.example.com/api/v4/projects/1"
},
"task_completion_status":{
"count":0,
@@ -985,7 +985,7 @@ Example response:
"web_url": "https://gitlab.example.com/solon.cremin"
},
"due_date": null,
- "web_url": "http://example.com/my-group/my-project/issues/11",
+ "web_url": "http://gitlab.example.com/my-group/my-project/issues/11",
"references": {
"short": "#11",
"relative": "#11",
@@ -1000,10 +1000,10 @@ Example response:
"confidential": false,
"discussion_locked": false,
"_links": {
- "self": "http://example.com/api/v4/projects/1/issues/2",
- "notes": "http://example.com/api/v4/projects/1/issues/2/notes",
- "award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji",
- "project": "http://example.com/api/v4/projects/1"
+ "self": "http://gitlab.example.com/api/v4/projects/1/issues/2",
+ "notes": "http://gitlab.example.com/api/v4/projects/1/issues/2/notes",
+ "award_emoji": "http://gitlab.example.com/api/v4/projects/1/issues/2/award_emoji",
+ "project": "http://gitlab.example.com/api/v4/projects/1"
},
"task_completion_status":{
"count":0,
@@ -1091,7 +1091,7 @@ Example response:
"web_url": "https://gitlab.example.com/solon.cremin"
},
"due_date": null,
- "web_url": "http://example.com/my-group/my-project/issues/11",
+ "web_url": "http://gitlab.example.com/my-group/my-project/issues/11",
"references": {
"short": "#11",
"relative": "#11",
@@ -1106,10 +1106,10 @@ Example response:
"confidential": false,
"discussion_locked": false,
"_links": {
- "self": "http://example.com/api/v4/projects/1/issues/2",
- "notes": "http://example.com/api/v4/projects/1/issues/2/notes",
- "award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji",
- "project": "http://example.com/api/v4/projects/1"
+ "self": "http://gitlab.example.com/api/v4/projects/1/issues/2",
+ "notes": "http://gitlab.example.com/api/v4/projects/1/issues/2/notes",
+ "award_emoji": "http://gitlab.example.com/api/v4/projects/1/issues/2/award_emoji",
+ "project": "http://gitlab.example.com/api/v4/projects/1"
},
"task_completion_status":{
"count":0,
@@ -1190,7 +1190,7 @@ Example response:
},
"subscribed": false,
"due_date": null,
- "web_url": "http://example.com/my-group/my-project/issues/12",
+ "web_url": "http://gitlab.example.com/my-group/my-project/issues/12",
"references": {
"short": "#12",
"relative": "#12",
@@ -1297,7 +1297,7 @@ Example response:
"downvotes": 0,
"merge_requests_count": 0,
"due_date": null,
- "web_url": "http://example.com/my-group/my-project/issues/10",
+ "web_url": "http://gitlab.example.com/my-group/my-project/issues/10",
"references": {
"short": "#10",
"relative": "#10",
@@ -1729,7 +1729,7 @@ Example response:
"username": "user1",
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/c922747a93b40d1ea88262bf1aebee62?s=80&d=identicon",
- "web_url": "http://localhost/user1"
+ "web_url": "http://gitlab.example.com/user1"
},
{
"id": 5,
@@ -1737,7 +1737,7 @@ Example response:
"username": "user5",
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/4aea8cf834ed91844a2da4ff7ae6b491?s=80&d=identicon",
- "web_url": "http://localhost/user5"
+ "web_url": "http://gitlab.example.com/user5"
}
]
```