Skip to content

G
gitlab-ce
Commit 190b2c6b authored by Achilleas Pipinellis's avatar Achilleas Pipinellis
Browse files
Options

Merge branch 'docs/fix-markdown-api-issues' into 'master' 

Fix markdown table in API Issues docs

See merge request !1596
parents 570565fd 950350f4
Hide whitespace changes
Inline Side-by-side
Showing with 31 additions and 41 deletions
doc/api/issues.md
View file @ 190b2c6b
......@@ -29,17 +29,15 @@ GET /issues?iids[]=42&iids[]=43
GET /issues?search=issue+title+or+description
```
|-------------+----------------+----------+-----------------------------------------------------------------------------------------------------------------------------|
| Attribute | Type | Required | Description |
|-------------+----------------+----------+-----------------------------------------------------------------------------------------------------------------------------|
|-------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------------------|
| `state` | string | no | Return all issues or just those that are `opened` or `closed` |
| `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `No+Label` lists all issues with no labels |
| `milestone` | string | no | The milestone title |
| `iids` | Array[integer] | no | Return only the issues having the given `iid` |
| `order_by` | string | no | Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at` |
| `sort` | string | no | Return requests sorted in `asc` or `desc` order. Default is `desc` |
| `search` | string | no | Search issues against their `title` and `description` |
|-------------+----------------+----------+-----------------------------------------------------------------------------------------------------------------------------|
| `search` | string | no | Search issues against their `title` and `description` |
```bash
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/issues
......@@ -112,9 +110,8 @@ GET /groups/:id/issues?iids[]=42&iids[]=43
GET /groups/:id/issues?search=issue+title+or+description
```
|-------------+----------------+----------+-----------------------------------------------------------------------------------------------------------------------------|
| Attribute | Type | Required | Description |
|-------------+----------------+----------+-----------------------------------------------------------------------------------------------------------------------------|
|-------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------------------|
| `id` | integer | yes | The ID of a group |
| `state` | string | no | Return all issues or just those that are `opened` or `closed` |
| `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `No+Label` lists all issues with no labels |
......@@ -123,7 +120,6 @@ GET /groups/:id/issues?search=issue+title+or+description
| `order_by` | string | no | Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at` |
| `sort` | string | no | Return requests sorted in `asc` or `desc` order. Default is `desc` |
| `search` | string | no | Search group issues against their `title` and `description` |
|-------------+----------------+----------+-----------------------------------------------------------------------------------------------------------------------------|
```bash
......@@ -197,9 +193,8 @@ GET /projects/:id/issues?iids[]=42&iids[]=43
GET /projects/:id/issues?search=issue+title+or+description
```
|-------------+----------------+----------+-----------------------------------------------------------------------------------------------------------------------------|
| Attribute | Type | Required | Description |
|-------------+----------------+----------+-----------------------------------------------------------------------------------------------------------------------------|
|-------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------------------|
| `id` | integer | yes | The ID of a project |
| `iids` | Array[integer] | no | Return only the milestone having the given `iid` |
| `state` | string | no | Return all issues or just those that are `opened` or `closed` |
......@@ -208,7 +203,6 @@ GET /projects/:id/issues?search=issue+title+or+description
| `order_by` | string | no | Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at` |
| `sort` | string | no | Return requests sorted in `asc` or `desc` order. Default is `desc` |
| `search` | string | no | Search project issues against their `title` and `description` |
|-------------+----------------+----------+-----------------------------------------------------------------------------------------------------------------------------|
```bash
......@@ -275,7 +269,7 @@ GET /projects/:id/issues/:issue_iid
|-------------+---------+----------+--------------------------------------|
| Attribute | Type | Required | Description |
|-------------+---------+----------+--------------------------------------|
|-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
|-------------+---------+----------+--------------------------------------|
......@@ -341,24 +335,20 @@ Creates a new project issue.
POST /projects/:id/issues
```
|-------------------------------------------+---------+----------+------------------------------------------------------------------------------------------------------------------------------------------------------|
| Attribute | Type | Required | Description |
|-------------------------------------------+---------+----------+------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | integer | yes | The ID of a project |
| `title` | string | yes | The title of an issue |
| `description` | string | no | The description of an issue |
| `confidential` | boolean | no | Set an issue to be confidential. Default is `false`. |
| `assignee_id` | integer | no | The ID of a user to assign issue |
| `milestone_id` | integer | no | The ID of a milestone to assign issue |
| `labels` | string | no | Comma-separated label names for an issue |
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. `2016-03-11T03:45:40Z` (requires admin or project owner rights) |
| `due_date` | string | no | Date time string in the format YEAR-MONTH-DAY, e.g. `2016-03-11` |
| `merge_request_to_resolve_discussions_of` | integer | no | The IID of a merge request in which to resolve all issues. This will fill the issue with a default description and mark all discussions as resolved. |
| - | - | - | When passing a description or title, these values will take precedence over the default values. |
| `discussion_to_resolve` | string | no | The ID of a discussion to resolve. This will fill in the issue with a default description and mark the discussion |
| - | - | - | as resolved. Use in combination with `merge_request_to_resolve_discussions_of`. |
| `weight` | integer | no | The weight of the issue in range 0 to 9 |
|-------------------------------------------+---------+----------+------------------------------------------------------------------------------------------------------------------------------------------------------|
| Attribute | Type | Required | Description |
|-------------------------------------------|---------|----------|--------------|
| `id` | integer | yes | The ID of a project |
| `title` | string | yes | The title of an issue |
| `description` | string | no | The description of an issue |
| `confidential` | boolean | no | Set an issue to be confidential. Default is `false`. |
| `assignee_id` | integer | no | The ID of a user to assign issue |
| `milestone_id` | integer | no | The ID of a milestone to assign issue |
| `labels` | string | no | Comma-separated label names for an issue |
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. `2016-03-11T03:45:40Z` (requires admin or project owner rights) |
| `due_date` | string | no | Date time string in the format YEAR-MONTH-DAY, e.g. `2016-03-11` |
| `merge_request_to_resolve_discussions_of` | integer | no | The IID of a merge request in which to resolve all issues. This will fill the issue with a default description and mark all discussions as resolved. When passing a description or title, these values will take precedence over the default values.|
| `discussion_to_resolve` | string | no | The ID of a discussion to resolve. This will fill in the issue with a default description and mark the discussion as resolved. Use in combination with `merge_request_to_resolve_discussions_of`. |
| `weight` | integer | no | The weight of the issue in range 0 to 9 |
```bash
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/4/issues?title=Issues%20with%20auth&labels=bug
......@@ -409,7 +399,7 @@ PUT /projects/:id/issues/:issue_iid
|----------------+---------+----------+------------------------------------------------------------------------------------------------------------|
| Attribute | Type | Required | Description |
|----------------+---------+----------+------------------------------------------------------------------------------------------------------------|
|----------------|---------|----------|------------------------------------------------------------------------------------------------------------|
| `id` | integer | yes | The ID of a project |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
| `title` | string | no | The title of an issue |
......@@ -472,7 +462,7 @@ DELETE /projects/:id/issues/:issue_iid
|-------------+---------+----------+--------------------------------------|
| Attribute | Type | Required | Description |
|-------------+---------+----------+--------------------------------------|
|-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
|-------------+---------+----------+--------------------------------------|
......@@ -496,7 +486,7 @@ POST /projects/:id/issues/:issue_iid/move
|-----------------+---------+----------+--------------------------------------|
| Attribute | Type | Required | Description |
|-----------------+---------+----------+--------------------------------------|
|-----------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
| `to_project_id` | integer | yes | The ID of the new project |
......@@ -555,7 +545,7 @@ POST /projects/:id/issues/:issue_iid/subscribe
|-------------+---------+----------+--------------------------------------|
| Attribute | Type | Required | Description |
|-------------+---------+----------+--------------------------------------|
|-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
|-------------+---------+----------+--------------------------------------|
......@@ -613,7 +603,7 @@ POST /projects/:id/issues/:issue_iid/unsubscribe
|-------------+---------+----------+--------------------------------------|
| Attribute | Type | Required | Description |
|-------------+---------+----------+--------------------------------------|
|-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
|-------------+---------+----------+--------------------------------------|
......@@ -634,7 +624,7 @@ POST /projects/:id/issues/:issue_iid/todo
|-------------+---------+----------+--------------------------------------|
| Attribute | Type | Required | Description |
|-------------+---------+----------+--------------------------------------|
|-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
|-------------+---------+----------+--------------------------------------|
......@@ -728,7 +718,7 @@ POST /projects/:id/issues/:issue_iid/time_estimate
|-------------+---------+----------+------------------------------------------|
| Attribute | Type | Required | Description |
|-------------+---------+----------+------------------------------------------|
|-------------|---------|----------|------------------------------------------|
| `id` | integer | yes | The ID of a project |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
| `duration` | string | yes | The duration in human format. e.g: 3h30m |
......@@ -759,7 +749,7 @@ POST /projects/:id/issues/:issue_iid/reset_time_estimate
|-------------+---------+----------+--------------------------------------|
| Attribute | Type | Required | Description |
|-------------+---------+----------+--------------------------------------|
|-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
|-------------+---------+----------+--------------------------------------|
......@@ -789,7 +779,7 @@ POST /projects/:id/issues/:issue_iid/add_spent_time
|-------------+---------+----------+------------------------------------------|
| Attribute | Type | Required | Description |
|-------------+---------+----------+------------------------------------------|
|-------------|---------|----------|------------------------------------------|
| `id` | integer | yes | The ID of a project |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
| `duration` | string | yes | The duration in human format. e.g: 3h30m |
......@@ -820,7 +810,7 @@ POST /projects/:id/issues/:issue_iid/reset_spent_time
|-------------+---------+----------+--------------------------------------|
| Attribute | Type | Required | Description |
|-------------+---------+----------+--------------------------------------|
|-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
|-------------+---------+----------+--------------------------------------|
......@@ -848,7 +838,7 @@ GET /projects/:id/issues/:issue_iid/time_stats
|-------------+---------+----------+--------------------------------------|
| Attribute | Type | Required | Description |
|-------------+---------+----------+--------------------------------------|
|-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
|-------------+---------+----------+--------------------------------------|
......@@ -870,4 +860,4 @@ Example response:
## Comments on issues
Comments are done via the [notes](notes.md) resource.
Comments are done via the [notes](notes.md) resource.
\ No newline at end of file
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