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