diff options
| author | Jarka Kadlecova <jarka@gitlab.com> | 2017-05-03 17:26:49 +0200 |
|---|---|---|
| committer | Jarka Kadlecova <jarka@gitlab.com> | 2017-05-31 07:17:03 +0200 |
| commit | 4464c22d6d23d893494682d309aec3fb31c11ae3 (patch) | |
| tree | cb7490034185f79c88db472650b87afdcdbafa3f /doc/api/project_snippets.md | |
| parent | 8039b9c3c6caedc19e0e44d086a007e8975134b7 (diff) | |
| download | gitlab-ce-4464c22d6d23d893494682d309aec3fb31c11ae3.tar.gz | |
Support descriptions for snippets
Diffstat (limited to 'doc/api/project_snippets.md')
| -rw-r--r-- | doc/api/project_snippets.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/api/project_snippets.md b/doc/api/project_snippets.md index ff379473961..80c4b5f1c34 100644 --- a/doc/api/project_snippets.md +++ b/doc/api/project_snippets.md @@ -43,6 +43,7 @@ Parameters: "id": 1, "title": "test", "file_name": "add.rb", + "description": "Ruby test snippet", "author": { "id": 1, "username": "john_smith", @@ -70,8 +71,9 @@ Parameters: - `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user - `title` (required) - The title of a snippet - `file_name` (required) - The name of a snippet file +- `description` (optional) - The description of a snippet - `code` (required) - The content of a snippet -- `visibility` (required) - The snippet's visibility +- `visibility` (optional) - The snippet's visibility ## Update snippet @@ -87,6 +89,7 @@ Parameters: - `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 +- `description` (optional) - The description of a snippet - `code` (optional) - The content of a snippet - `visibility` (optional) - The snippet's visibility |