summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Lopez <james@jameslopez.es>2017-07-07 15:18:01 +0200
committerJames Lopez <james@jameslopez.es>2017-07-07 15:18:01 +0200
commit5173955fd49ab9748a9878203b691732198091aa (patch)
treeb0ef166bda4600f84b796b7ef507f16d9b076908
parent2aa95aa0185c94aefd6e51a35c62650d75d3c8b6 (diff)
downloadgitlab-ce-5173955fd49ab9748a9878203b691732198091aa.tar.gz
update docs
-rw-r--r--doc/api/project_snippets.md31
-rw-r--r--doc/api/snippets.md5
2 files changed, 36 insertions, 0 deletions
diff --git a/doc/api/project_snippets.md b/doc/api/project_snippets.md
index 92491de4daa..cd64631ca4f 100644
--- a/doc/api/project_snippets.md
+++ b/doc/api/project_snippets.md
@@ -119,3 +119,34 @@ Parameters:
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
- `snippet_id` (required) - The ID of a project's snippet
+
+## Get user agent details
+
+> **Notes:**
+> [Introduced][ce-29508] in GitLab 9.4.
+
+
+Available only for admins.
+
+```
+GET /projects/:id/snippets/:snippet_id/user_agent_detail
+```
+
+| Attribute | Type | Required | Description |
+|-------------|---------|----------|--------------------------------------|
+| `id` | Integer | yes | The ID of a snippet |
+
+```bash
+curl --request GET --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/snippets/1/user_agent_detail
+```
+
+Example response:
+
+```json
+{
+ "user_agent": "AppleWebKit/537.36",
+ "ip_address": "127.0.0.1",
+ "akismet_submitted": false
+}
+```
+[ce-[ce-29508]: https://gitlab.com/gitlab-org/gitlab-ce/issues/29508]: https://gitlab.com/gitlab-org/gitlab-ce/issues/29508
diff --git a/doc/api/snippets.md b/doc/api/snippets.md
index ea66aa552a7..798b80a5b11 100644
--- a/doc/api/snippets.md
+++ b/doc/api/snippets.md
@@ -237,6 +237,10 @@ Example response:
## Get user agent details
+> **Notes:**
+> [Introduced][ce-29508] in GitLab 9.4.
+
+
Available only for admins.
```
@@ -260,3 +264,4 @@ Example response:
"akismet_submitted": false
}
```
+[ce-[ce-29508]: https://gitlab.com/gitlab-org/gitlab-ce/issues/29508]: https://gitlab.com/gitlab-org/gitlab-ce/issues/29508