Commit 3f4bbbaf authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'fix_snippet_api_doc' into 'master'

Add snippet visibilty as parameter to API doc, closes #1562

## Description

Snippet visibility level was added to API but was not to its documentation.

Related to following commit: 928fc94c

@axil Can you review?

See merge request !601
parents 187b4964 78aadc93
# Project snippets # Project snippets
### Snippet visibility level
Snippets in GitLab can be either private, internal or public.
You can set it with the `visibility_level` field in the snippet.
Constants for snippet visibility levels are:
| Visibility | visibility_level | Description |
| ---------- | ---------------- | ----------- |
| Private | `0` | The snippet is visible only the snippet creator |
| Internal | `10` | The snippet is visible for any logged in user |
| Public | `20` | The snippet can be accessed without any authentication |
## List snippets ## List snippets
Get a list of project snippets. Get a list of project snippets.
...@@ -58,6 +71,7 @@ Parameters: ...@@ -58,6 +71,7 @@ Parameters:
- `title` (required) - The title of a snippet - `title` (required) - The title of a snippet
- `file_name` (required) - The name of a snippet file - `file_name` (required) - The name of a snippet file
- `code` (required) - The content of a snippet - `code` (required) - The content of a snippet
- `visibility_level` (required) - The snippet's visibility
## Update snippet ## Update snippet
...@@ -74,6 +88,7 @@ Parameters: ...@@ -74,6 +88,7 @@ Parameters:
- `title` (optional) - The title of a snippet - `title` (optional) - The title of a snippet
- `file_name` (optional) - The name of a snippet file - `file_name` (optional) - The name of a snippet file
- `code` (optional) - The content of a snippet - `code` (optional) - The content of a snippet
- `visibility_level` (optional) - The snippet's visibility
## Delete snippet ## Delete snippet
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment