debian-mirror-gitlab/doc/api/project_snippets.md

154 lines
4.1 KiB
Markdown
Raw Normal View History

2014-09-02 18:07:02 +05:30
# Project snippets
2015-09-11 14:41:01 +05:30
### Snippet visibility level
Snippets in GitLab can be either private, internal or public.
2017-08-17 22:00:37 +05:30
You can set it with the `visibility` field in the snippet.
2015-09-11 14:41:01 +05:30
Constants for snippet visibility levels are:
2017-08-17 22:00:37 +05:30
| visibility | Description |
| ---------- | ----------- |
| `private` | The snippet is visible only the snippet creator |
| `internal` | The snippet is visible for any logged in user |
| `public` | The snippet can be accessed without any authentication |
2015-09-11 14:41:01 +05:30
2014-09-02 18:07:02 +05:30
## List snippets
Get a list of project snippets.
```
GET /projects/:id/snippets
```
Parameters:
2017-08-17 22:00:37 +05:30
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
2014-09-02 18:07:02 +05:30
## Single snippet
Get a single project snippet.
```
GET /projects/:id/snippets/:snippet_id
```
Parameters:
2017-08-17 22:00:37 +05:30
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
2014-09-02 18:07:02 +05:30
- `snippet_id` (required) - The ID of a project's snippet
```json
{
"id": 1,
"title": "test",
"file_name": "add.rb",
2017-09-10 17:25:29 +05:30
"description": "Ruby test snippet",
2014-09-02 18:07:02 +05:30
"author": {
"id": 1,
"username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"state": "active",
"created_at": "2012-05-23T08:00:58Z"
},
"updated_at": "2012-06-28T10:52:04Z",
2016-09-29 09:46:39 +05:30
"created_at": "2012-06-28T10:52:04Z",
"web_url": "http://example.com/example/example/snippets/1"
2014-09-02 18:07:02 +05:30
}
```
## Create new snippet
Creates a new project snippet. The user must have permission to create new snippets.
```
POST /projects/:id/snippets
```
Parameters:
2017-08-17 22:00:37 +05:30
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
2014-09-02 18:07:02 +05:30
- `title` (required) - The title of a snippet
- `file_name` (required) - The name of a snippet file
2017-09-10 17:25:29 +05:30
- `description` (optional) - The description of a snippet
2014-09-02 18:07:02 +05:30
- `code` (required) - The content of a snippet
2017-08-17 22:00:37 +05:30
- `visibility` (required) - The snippet's visibility
2014-09-02 18:07:02 +05:30
## Update snippet
Updates an existing project snippet. The user must have permission to change an existing snippet.
```
PUT /projects/:id/snippets/:snippet_id
```
Parameters:
2017-08-17 22:00:37 +05:30
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
2014-09-02 18:07:02 +05:30
- `snippet_id` (required) - The ID of a project's snippet
- `title` (optional) - The title of a snippet
- `file_name` (optional) - The name of a snippet file
2017-09-10 17:25:29 +05:30
- `description` (optional) - The description of a snippet
2014-09-02 18:07:02 +05:30
- `code` (optional) - The content of a snippet
2017-08-17 22:00:37 +05:30
- `visibility` (optional) - The snippet's visibility
2014-09-02 18:07:02 +05:30
## Delete snippet
Deletes an existing project snippet. This is an idempotent function and deleting a non-existent
snippet still returns a `200 OK` status code.
```
DELETE /projects/:id/snippets/:snippet_id
```
Parameters:
2017-08-17 22:00:37 +05:30
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
2014-09-02 18:07:02 +05:30
- `snippet_id` (required) - The ID of a project's snippet
## Snippet content
Returns the raw project snippet as plain text.
```
GET /projects/:id/snippets/:snippet_id/raw
```
Parameters:
2017-08-17 22:00:37 +05:30
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
2014-09-02 18:07:02 +05:30
- `snippet_id` (required) - The ID of a project's snippet
2017-09-10 17:25:29 +05:30
## 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