gitlab-org--gitlab-foss/doc/api/project_snippets.md

122 lines
3.3 KiB
Markdown
Raw Normal View History

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