Commit 7695867f authored by Marcin Sedlak-Jakubowski's avatar Marcin Sedlak-Jakubowski

Merge branch 'jh-issues-api-auth-docs' into 'master'

Improve docs on issues API authentication

See merge request gitlab-org/gitlab!34940
parents d9fb5e92 3c3eca81
......@@ -6,8 +6,6 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Issues API
Every API call to issues must be authenticated.
If a user is not a member of a project and the project is private, a `GET`
request on that project will result in a `404` status code.
......@@ -188,6 +186,9 @@ the `weight` parameter:
Get a list of a group's issues.
If the group is private, credentials will need to be provided for authorization.
The preferred way to do this, is by using [personal access tokens](../user/profile/personal_access_tokens.md).
```plaintext
GET /groups/:id/issues
GET /groups/:id/issues?state=opened
......@@ -343,6 +344,9 @@ the `weight` parameter:
Get a list of a project's issues.
If the project is private, credentials will need to be provided for authorization.
The preferred way to do this, is by using [personal access tokens](../user/profile/personal_access_tokens.md).
```plaintext
GET /projects/:id/issues
GET /projects/:id/issues?state=opened
......@@ -504,6 +508,9 @@ the `weight` parameter:
Get a single project issue.
If the project is private or the issue is confidential, credentials will need to be provided for authorization.
The preferred way to do this, is by using [personal access tokens](../user/profile/personal_access_tokens.md).
```plaintext
GET /projects/:id/issues/:issue_iid
```
......@@ -1413,6 +1420,9 @@ Example response:
## Get time tracking stats
If the project is private or the issue is confidential, credentials will need to be provided for authorization.
The preferred way to do this, is by using [personal access tokens](../user/profile/personal_access_tokens.md).
```plaintext
GET /projects/:id/issues/:issue_iid/time_stats
```
......@@ -1441,6 +1451,9 @@ Example response:
Get all the merge requests that are related to the issue.
If the project is private or the issue is confidential, credentials will need to be provided for authorization.
The preferred way to do this, is by using [personal access tokens](../user/profile/personal_access_tokens.md).
```plaintext
GET /projects/:id/issues/:issue_id/related_merge_requests
```
......@@ -1597,6 +1610,9 @@ Example response:
Get all the merge requests that will close issue when merged.
If the project is private or the issue is confidential, credentials will need to be provided for authorization.
The preferred way to do this, is by using [personal access tokens](../user/profile/personal_access_tokens.md).
```plaintext
GET /projects/:id/issues/:issue_iid/closed_by
```
......@@ -1670,6 +1686,9 @@ Example response:
## Participants on issues
If the project is private or the issue is confidential, credentials will need to be provided for authorization.
The preferred way to do this, is by using [personal access tokens](../user/profile/personal_access_tokens.md).
```plaintext
GET /projects/:id/issues/:issue_iid/participants
```
......
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