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

238 lines
6.6 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 |
NOTE: **Note:**
From July 2019, the `Internal` visibility setting is disabled for new projects, groups,
and snippets on GitLab.com. Existing projects, groups, and snippets using the `Internal`
visibility setting keep this setting. You can read more about the change in the
[relevant issue](https://gitlab.com/gitlab-org/gitlab/-/issues/12388).
2012-08-25 12:21:11 -04:00
## List snippets
2012-10-08 05:13:53 -04:00
Get a list of project snippets.
```plaintext
2012-10-08 05:13:53 -04:00
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
```plaintext
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",
"project_id": 1,
"web_url": "http://example.com/example/example/snippets/1",
"raw_url": "http://example.com/example/example/snippets/1/raw"
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
```plaintext
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
- `content` (required) - The content of a snippet
- `visibility` (required) - The snippet's visibility
2012-08-25 12:21:11 -04:00
2019-08-27 13:23:14 -04:00
Example request:
```shell
curl --request POST "https://gitlab.com/api/v4/projects/:id/snippets" \
2019-08-27 13:23:14 -04:00
--header "PRIVATE-TOKEN: <your access token>" \
--header "Content-Type: application/json" \
-d @snippet.json
2019-08-27 13:23:14 -04:00
```
`snippet.json` used in the above example request:
```json
{
"title" : "Example Snippet Title",
"description" : "More verbose snippet description",
"file_name" : "example.txt",
"content" : "source code \n with multiple lines\n",
2019-08-27 13:23:14 -04:00
"visibility" : "private"
}
```
## 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
```plaintext
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
- `content` (optional) - The content of a snippet
- `visibility` (optional) - The snippet's visibility
2012-08-25 12:21:11 -04:00
2019-08-27 13:23:14 -04:00
Example request:
```shell
curl --request PUT "https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id" \
2019-08-27 13:23:14 -04:00
--header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-Type: application/json" \
-d @snippet.json
2019-08-27 13:23:14 -04:00
```
`snippet.json` used in the above example request:
```json
{
"title" : "Updated Snippet Title",
"description" : "More verbose snippet description",
"file_name" : "new_filename.txt",
"content" : "updated source code \n with multiple lines\n",
2019-08-27 13:23:14 -04:00
"visibility" : "private"
}
```
2012-08-25 12:21:11 -04:00
## Delete snippet
2017-09-06 03:15:34 -04:00
Deletes an existing project snippet. This returns a `204 No Content` status code if the operation was successfully or `404` if the resource was not found.
2012-08-25 12:21:11 -04:00
```plaintext
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
2019-08-27 13:23:14 -04:00
Example request:
```shell
curl --request DELETE "https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id" \
2019-08-27 13:23:14 -04:00
--header "PRIVATE-TOKEN: <your_access_token>"
```
## Snippet content
Returns the raw project snippet as plain text.
```plaintext
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
2017-07-07 09:18:01 -04:00
2019-08-27 13:23:14 -04:00
Example request:
```shell
curl "https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id/raw" \
2019-08-27 13:23:14 -04:00
--header "PRIVATE-TOKEN: <your_access_token>"
```
## Snippet repository file content
Returns the raw file content as plain text.
```plaintext
GET /projects/:id/snippets/:snippet_id/files/:ref/:file_path/raw
```
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
- `ref` (required) - The name of a branch, tag or commit e.g. master
- `file_path` (required) - The URL-encoded path to the file, e.g. snippet%2Erb
Example request:
```shell
curl "https://gitlab.com/api/v4/projects/1/snippets/2/files/master/snippet%2Erb/raw" \
--header "PRIVATE-TOKEN: <your_access_token>"
```
2017-07-07 09:18:01 -04:00
## Get user agent details
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/29508) in GitLab 9.4.
2017-07-07 09:18:01 -04:00
Available only for admins.
```plaintext
2017-07-07 09:18:01 -04:00
GET /projects/:id/snippets/:snippet_id/user_agent_detail
```
| Attribute | Type | Required | Description |
|---------------|---------|----------|--------------------------------------|
| `id` | Integer | yes | The ID of a project |
| `snippet_id` | Integer | yes | The ID of a snippet |
2017-07-07 09:18:01 -04:00
2019-08-27 13:23:14 -04:00
Example request:
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/snippets/2/user_agent_detail"
2017-07-07 09:18:01 -04:00
```
Example response:
```json
{
"user_agent": "AppleWebKit/537.36",
"ip_address": "127.0.0.1",
"akismet_submitted": false
}
```