Skip to content

G
gitlab-ce
Commit 6536e3d5 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis
Browse files
Options

Add URL encoding link to issues API 

[ci skip]
parent b472f999
Hide whitespace changes
Inline Side-by-side
Showing with 15 additions and 15 deletions
doc/api/issues.md
View file @ 6536e3d5
...@@ -111,7 +111,7 @@ GET /groups/:id/issues?search=issue+title+or+description ...@@ -111,7 +111,7 @@ GET /groups/:id/issues?search=issue+title+or+description
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|-------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------------------| |-------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------------------|
| `id` | integer | yes | The ID of a group | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user |
| `state` | string | no | Return all issues or just those that are `opened` or `closed` | | `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 | | `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 |
| `iids` | Array[integer] | no | Return only the issues having the given `iid` | | `iids` | Array[integer] | no | Return only the issues having the given `iid` |
...@@ -193,7 +193,7 @@ GET /projects/:id/issues?search=issue+title+or+description ...@@ -193,7 +193,7 @@ GET /projects/:id/issues?search=issue+title+or+description
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|-------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------------------| |-------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------------------|
| `id` | integer | yes | The ID of a project | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `iids` | Array[integer] | no | Return only the milestone having the given `iid` | | `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` | | `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 | | `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 |
...@@ -266,7 +266,7 @@ GET /projects/:id/issues/:issue_iid ...@@ -266,7 +266,7 @@ GET /projects/:id/issues/:issue_iid
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------| |-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project | | `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_iid` | integer | yes | The internal ID of a project's issue |
```bash ```bash
...@@ -331,7 +331,7 @@ POST /projects/:id/issues ...@@ -331,7 +331,7 @@ POST /projects/:id/issues
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|-------------------------------------------|---------|----------|--------------| |-------------------------------------------|---------|----------|--------------|
| `id` | integer | yes | The ID of a project | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `title` | string | yes | The title of an issue | | `title` | string | yes | The title of an issue |
| `description` | string | no | The description of an issue | | `description` | string | no | The description of an issue |
| `confidential` | boolean | no | Set an issue to be confidential. Default is `false`. | | `confidential` | boolean | no | Set an issue to be confidential. Default is `false`. |
...@@ -391,7 +391,7 @@ PUT /projects/:id/issues/:issue_iid ...@@ -391,7 +391,7 @@ PUT /projects/:id/issues/:issue_iid
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|----------------|---------|----------|------------------------------------------------------------------------------------------------------------| |----------------|---------|----------|------------------------------------------------------------------------------------------------------------|
| `id` | integer | yes | The ID of a project | | `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_iid` | integer | yes | The internal ID of a project's issue |
| `title` | string | no | The title of an issue | | `title` | string | no | The title of an issue |
| `description` | string | no | The description of an issue | | `description` | string | no | The description of an issue |
...@@ -450,7 +450,7 @@ DELETE /projects/:id/issues/:issue_iid ...@@ -450,7 +450,7 @@ DELETE /projects/:id/issues/:issue_iid
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------| |-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project | | `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_iid` | integer | yes | The internal ID of a project's issue |
```bash ```bash
...@@ -472,7 +472,7 @@ POST /projects/:id/issues/:issue_iid/move ...@@ -472,7 +472,7 @@ POST /projects/:id/issues/:issue_iid/move
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|-----------------|---------|----------|--------------------------------------| |-----------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project | | `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_iid` | integer | yes | The internal ID of a project's issue |
| `to_project_id` | integer | yes | The ID of the new project | | `to_project_id` | integer | yes | The ID of the new project |
...@@ -528,7 +528,7 @@ POST /projects/:id/issues/:issue_iid/subscribe ...@@ -528,7 +528,7 @@ POST /projects/:id/issues/:issue_iid/subscribe
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------| |-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project | | `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_iid` | integer | yes | The internal ID of a project's issue |
```bash ```bash
...@@ -583,7 +583,7 @@ POST /projects/:id/issues/:issue_iid/unsubscribe ...@@ -583,7 +583,7 @@ POST /projects/:id/issues/:issue_iid/unsubscribe
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------| |-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project | | `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_iid` | integer | yes | The internal ID of a project's issue |
```bash ```bash
...@@ -602,7 +602,7 @@ POST /projects/:id/issues/:issue_iid/todo ...@@ -602,7 +602,7 @@ POST /projects/:id/issues/:issue_iid/todo
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------| |-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project | | `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_iid` | integer | yes | The internal ID of a project's issue |
```bash ```bash
...@@ -693,7 +693,7 @@ POST /projects/:id/issues/:issue_iid/time_estimate ...@@ -693,7 +693,7 @@ POST /projects/:id/issues/:issue_iid/time_estimate
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|-------------|---------|----------|------------------------------------------| |-------------|---------|----------|------------------------------------------|
| `id` | integer | yes | The ID of a project | | `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_iid` | integer | yes | The internal ID of a project's issue |
| `duration` | string | yes | The duration in human format. e.g: 3h30m | | `duration` | string | yes | The duration in human format. e.g: 3h30m |
...@@ -722,7 +722,7 @@ POST /projects/:id/issues/:issue_iid/reset_time_estimate ...@@ -722,7 +722,7 @@ POST /projects/:id/issues/:issue_iid/reset_time_estimate
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------| |-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project | | `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_iid` | integer | yes | The internal ID of a project's issue |
```bash ```bash
...@@ -750,7 +750,7 @@ POST /projects/:id/issues/:issue_iid/add_spent_time ...@@ -750,7 +750,7 @@ POST /projects/:id/issues/:issue_iid/add_spent_time
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|-------------|---------|----------|------------------------------------------| |-------------|---------|----------|------------------------------------------|
| `id` | integer | yes | The ID of a project | | `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_iid` | integer | yes | The internal ID of a project's issue |
| `duration` | string | yes | The duration in human format. e.g: 3h30m | | `duration` | string | yes | The duration in human format. e.g: 3h30m |
...@@ -779,7 +779,7 @@ POST /projects/:id/issues/:issue_iid/reset_spent_time ...@@ -779,7 +779,7 @@ POST /projects/:id/issues/:issue_iid/reset_spent_time
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------| |-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project | | `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_iid` | integer | yes | The internal ID of a project's issue |
```bash ```bash
...@@ -805,7 +805,7 @@ GET /projects/:id/issues/:issue_iid/time_stats ...@@ -805,7 +805,7 @@ GET /projects/:id/issues/:issue_iid/time_stats
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------| |-------------|---------|----------|--------------------------------------|
| `id` | integer | yes | The ID of a project | | `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_iid` | integer | yes | The internal ID of a project's issue |
```bash ```bash
......
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