summaryrefslogtreecommitdiff
path: root/doc/api/issues.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/issues.md')
-rw-r--r--doc/api/issues.md47
1 files changed, 20 insertions, 27 deletions
diff --git a/doc/api/issues.md b/doc/api/issues.md
index c769d7bb69a..f775d502a6d 100644
--- a/doc/api/issues.md
+++ b/doc/api/issues.md
@@ -73,7 +73,6 @@ GET /issues
]
```
-
## List project issues
Get a list of project issues. This function accepts pagination parameters `page` and `per_page`
@@ -85,8 +84,7 @@ GET /projects/:id/issues
Parameters:
-+ `id` (required) - The ID of a project
-
+- `id` (required) - The ID of a project
## Single issue
@@ -98,8 +96,8 @@ GET /projects/:id/issues/:issue_id
Parameters:
-+ `id` (required) - The ID of a project
-+ `issue_id` (required) - The ID of a project issue
+- `id` (required) - The ID of a project
+- `issue_id` (required) - The ID of a project issue
```json
{
@@ -142,7 +140,6 @@ Parameters:
}
```
-
## New issue
Creates a new project issue.
@@ -153,13 +150,12 @@ POST /projects/:id/issues
Parameters:
-+ `id` (required) - The ID 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
-
+- `id` (required) - The ID 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
## Edit issue
@@ -171,21 +167,18 @@ PUT /projects/:id/issues/:issue_id
Parameters:
-+ `id` (required) - The ID 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
-+ `state_event` (optional) - The state event of an issue ('close' to close issue and 'reopen' to reopen it)
-
+- `id` (required) - The ID 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
+- `state_event` (optional) - The state event of an issue ('close' to close issue and 'reopen' to reopen it)
## Delete existing issue (**Deprecated**)
-The function is deprecated and returns a `405 Method Not Allowed`
-error if called. An issue gets now closed and is done by calling `PUT /projects/:id/issues/:issue_id` with
-parameter `closed` set to 1.
+The function is deprecated and returns a `405 Method Not Allowed` error if called. An issue gets now closed and is done by calling `PUT /projects/:id/issues/:issue_id` with parameter `closed` set to 1.
```
DELETE /projects/:id/issues/:issue_id
@@ -193,8 +186,8 @@ DELETE /projects/:id/issues/:issue_id
Parameters:
-+ `id` (required) - The project ID
-+ `issue_id` (required) - The ID of the issue
+- `id` (required) - The project ID
+- `issue_id` (required) - The ID of the issue
## Comments on issues