Skip to content

G
gitlab-ce
Commit 298aa612 authored by James Ramsay's avatar James Ramsay
Browse files
Options

Fix issues API docs inconsistencies 

Replace incorrect URLs with gitlab.example.com and remove erroneous
back ticks.
parent 33f32314
Hide whitespace changes
Inline Side-by-side
Showing with 44 additions and 44 deletions
doc/api/issues.md
View file @ 298aa612
...@@ -134,7 +134,7 @@ Example response: ...@@ -134,7 +134,7 @@ Example response:
"merge_requests_count": 0, "merge_requests_count": 0,
"user_notes_count": 1, "user_notes_count": 1,
"due_date": "2016-07-22", "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": { "references": {
"short": "#6", "short": "#6",
"relative": "my-group/my-project#6", "relative": "my-group/my-project#6",
...@@ -151,10 +151,10 @@ Example response: ...@@ -151,10 +151,10 @@ Example response:
"confidential": false, "confidential": false,
"discussion_locked": false, "discussion_locked": false,
"_links":{ "_links":{
"self":"http://example.com/api/v4/projects/1/issues/76", "self":"http://gitlab.example.com/api/v4/projects/1/issues/76",
"notes":"`http://example.com/`api/v4/projects/1/issues/76/notes", "notes":"http://gitlab.example.com/api/v4/projects/1/issues/76/notes",
"award_emoji":"http://example.com/api/v4/projects/1/issues/76/award_emoji", "award_emoji":"http://gitlab.example.com/api/v4/projects/1/issues/76/award_emoji",
"project":"http://example.com/api/v4/projects/1" "project":"http://gitlab.example.com/api/v4/projects/1"
}, },
"task_completion_status":{ "task_completion_status":{
"count":0, "count":0,
...@@ -292,7 +292,7 @@ Example response: ...@@ -292,7 +292,7 @@ Example response:
"closed_by" : null, "closed_by" : null,
"user_notes_count": 1, "user_notes_count": 1,
"due_date": null, "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": { "references": {
"short": "#1", "short": "#1",
"relative": "my-project#1", "relative": "my-project#1",
...@@ -309,10 +309,10 @@ Example response: ...@@ -309,10 +309,10 @@ Example response:
"confidential": false, "confidential": false,
"discussion_locked": false, "discussion_locked": false,
"_links":{ "_links":{
"self":"http://example.com/api/v4/projects/4/issues/41", "self":"http://gitlab.example.com/api/v4/projects/4/issues/41",
"notes":"`http://example.com/`api/v4/projects/4/issues/41/notes", "notes":"http://gitlab.example.com/api/v4/projects/4/issues/41/notes",
"award_emoji":"http://example.com/api/v4/projects/4/issues/41/award_emoji", "award_emoji":"http://gitlab.example.com/api/v4/projects/4/issues/41/award_emoji",
"project":"http://example.com/api/v4/projects/4" "project":"http://gitlab.example.com/api/v4/projects/4"
}, },
"task_completion_status":{ "task_completion_status":{
"count":0, "count":0,
...@@ -456,7 +456,7 @@ Example response: ...@@ -456,7 +456,7 @@ Example response:
}, },
"user_notes_count": 1, "user_notes_count": 1,
"due_date": "2016-07-22", "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": { "references": {
"short": "#1", "short": "#1",
"relative": "#1", "relative": "#1",
...@@ -473,10 +473,10 @@ Example response: ...@@ -473,10 +473,10 @@ Example response:
"confidential": false, "confidential": false,
"discussion_locked": false, "discussion_locked": false,
"_links":{ "_links":{
"self":"http://example.com/api/v4/projects/4/issues/41", "self":"http://gitlab.example.com/api/v4/projects/4/issues/41",
"notes":"`http://example.com/`api/v4/projects/4/issues/41/notes", "notes":"http://gitlab.example.com/api/v4/projects/4/issues/41/notes",
"award_emoji":"http://example.com/api/v4/projects/4/issues/41/award_emoji", "award_emoji":"http://gitlab.example.com/api/v4/projects/4/issues/41/award_emoji",
"project":"http://example.com/api/v4/projects/4" "project":"http://gitlab.example.com/api/v4/projects/4"
}, },
"task_completion_status":{ "task_completion_status":{
"count":0, "count":0,
...@@ -581,7 +581,7 @@ Example response: ...@@ -581,7 +581,7 @@ Example response:
"subscribed": false, "subscribed": false,
"user_notes_count": 1, "user_notes_count": 1,
"due_date": null, "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": { "references": {
"short": "#1", "short": "#1",
"relative": "#1", "relative": "#1",
...@@ -596,10 +596,10 @@ Example response: ...@@ -596,10 +596,10 @@ Example response:
"confidential": false, "confidential": false,
"discussion_locked": false, "discussion_locked": false,
"_links": { "_links": {
"self": "http://example.com/api/v4/projects/1/issues/2", "self": "http://gitlab.example.com/api/v4/projects/1/issues/2",
"notes": "http://example.com/api/v4/projects/1/issues/2/notes", "notes": "http://gitlab.example.com/api/v4/projects/1/issues/2/notes",
"award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji", "award_emoji": "http://gitlab.example.com/api/v4/projects/1/issues/2/award_emoji",
"project": "http://example.com/api/v4/projects/1" "project": "http://gitlab.example.com/api/v4/projects/1"
}, },
"task_completion_status":{ "task_completion_status":{
"count":0, "count":0,
...@@ -710,7 +710,7 @@ Example response: ...@@ -710,7 +710,7 @@ Example response:
"subscribed" : true, "subscribed" : true,
"user_notes_count": 0, "user_notes_count": 0,
"due_date": null, "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": { "references": {
"short": "#14", "short": "#14",
"relative": "#14", "relative": "#14",
...@@ -725,10 +725,10 @@ Example response: ...@@ -725,10 +725,10 @@ Example response:
"confidential": false, "confidential": false,
"discussion_locked": false, "discussion_locked": false,
"_links": { "_links": {
"self": "http://example.com/api/v4/projects/1/issues/2", "self": "http://gitlab.example.com/api/v4/projects/1/issues/2",
"notes": "http://example.com/api/v4/projects/1/issues/2/notes", "notes": "http://gitlab.example.com/api/v4/projects/1/issues/2/notes",
"award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji", "award_emoji": "http://gitlab.example.com/api/v4/projects/1/issues/2/award_emoji",
"project": "http://example.com/api/v4/projects/1" "project": "http://gitlab.example.com/api/v4/projects/1"
}, },
"task_completion_status":{ "task_completion_status":{
"count":0, "count":0,
...@@ -832,7 +832,7 @@ Example response: ...@@ -832,7 +832,7 @@ Example response:
"subscribed" : true, "subscribed" : true,
"user_notes_count": 0, "user_notes_count": 0,
"due_date": "2016-07-22", "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": { "references": {
"short": "#15", "short": "#15",
"relative": "#15", "relative": "#15",
...@@ -847,10 +847,10 @@ Example response: ...@@ -847,10 +847,10 @@ Example response:
"confidential": false, "confidential": false,
"discussion_locked": false, "discussion_locked": false,
"_links": { "_links": {
"self": "http://example.com/api/v4/projects/1/issues/2", "self": "http://gitlab.example.com/api/v4/projects/1/issues/2",
"notes": "http://example.com/api/v4/projects/1/issues/2/notes", "notes": "http://gitlab.example.com/api/v4/projects/1/issues/2/notes",
"award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji", "award_emoji": "http://gitlab.example.com/api/v4/projects/1/issues/2/award_emoji",
"project": "http://example.com/api/v4/projects/1" "project": "http://gitlab.example.com/api/v4/projects/1"
}, },
"task_completion_status":{ "task_completion_status":{
"count":0, "count":0,
...@@ -985,7 +985,7 @@ Example response: ...@@ -985,7 +985,7 @@ Example response:
"web_url": "https://gitlab.example.com/solon.cremin" "web_url": "https://gitlab.example.com/solon.cremin"
}, },
"due_date": null, "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": { "references": {
"short": "#11", "short": "#11",
"relative": "#11", "relative": "#11",
...@@ -1000,10 +1000,10 @@ Example response: ...@@ -1000,10 +1000,10 @@ Example response:
"confidential": false, "confidential": false,
"discussion_locked": false, "discussion_locked": false,
"_links": { "_links": {
"self": "http://example.com/api/v4/projects/1/issues/2", "self": "http://gitlab.example.com/api/v4/projects/1/issues/2",
"notes": "http://example.com/api/v4/projects/1/issues/2/notes", "notes": "http://gitlab.example.com/api/v4/projects/1/issues/2/notes",
"award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji", "award_emoji": "http://gitlab.example.com/api/v4/projects/1/issues/2/award_emoji",
"project": "http://example.com/api/v4/projects/1" "project": "http://gitlab.example.com/api/v4/projects/1"
}, },
"task_completion_status":{ "task_completion_status":{
"count":0, "count":0,
...@@ -1091,7 +1091,7 @@ Example response: ...@@ -1091,7 +1091,7 @@ Example response:
"web_url": "https://gitlab.example.com/solon.cremin" "web_url": "https://gitlab.example.com/solon.cremin"
}, },
"due_date": null, "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": { "references": {
"short": "#11", "short": "#11",
"relative": "#11", "relative": "#11",
...@@ -1106,10 +1106,10 @@ Example response: ...@@ -1106,10 +1106,10 @@ Example response:
"confidential": false, "confidential": false,
"discussion_locked": false, "discussion_locked": false,
"_links": { "_links": {
"self": "http://example.com/api/v4/projects/1/issues/2", "self": "http://gitlab.example.com/api/v4/projects/1/issues/2",
"notes": "http://example.com/api/v4/projects/1/issues/2/notes", "notes": "http://gitlab.example.com/api/v4/projects/1/issues/2/notes",
"award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji", "award_emoji": "http://gitlab.example.com/api/v4/projects/1/issues/2/award_emoji",
"project": "http://example.com/api/v4/projects/1" "project": "http://gitlab.example.com/api/v4/projects/1"
}, },
"task_completion_status":{ "task_completion_status":{
"count":0, "count":0,
...@@ -1190,7 +1190,7 @@ Example response: ...@@ -1190,7 +1190,7 @@ Example response:
}, },
"subscribed": false, "subscribed": false,
"due_date": null, "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": { "references": {
"short": "#12", "short": "#12",
"relative": "#12", "relative": "#12",
...@@ -1297,7 +1297,7 @@ Example response: ...@@ -1297,7 +1297,7 @@ Example response:
"downvotes": 0, "downvotes": 0,
"merge_requests_count": 0, "merge_requests_count": 0,
"due_date": null, "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": { "references": {
"short": "#10", "short": "#10",
"relative": "#10", "relative": "#10",
...@@ -1729,7 +1729,7 @@ Example response: ...@@ -1729,7 +1729,7 @@ Example response:
"username": "user1", "username": "user1",
"state": "active", "state": "active",
"avatar_url": "http://www.gravatar.com/avatar/c922747a93b40d1ea88262bf1aebee62?s=80&d=identicon", "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, "id": 5,
...@@ -1737,7 +1737,7 @@ Example response: ...@@ -1737,7 +1737,7 @@ Example response:
"username": "user5", "username": "user5",
"state": "active", "state": "active",
"avatar_url": "http://www.gravatar.com/avatar/4aea8cf834ed91844a2da4ff7ae6b491?s=80&d=identicon", "avatar_url": "http://www.gravatar.com/avatar/4aea8cf834ed91844a2da4ff7ae6b491?s=80&d=identicon",
"web_url": "http://localhost/user5" "web_url": "http://gitlab.example.com/user5"
} }
] ]
``` ```
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7