Commit 79fa2cd9 authored by Evan Read's avatar Evan Read

Merge branch 'nik-api-snippets-fix' into 'master'

Snippets API doc fixes: content->code; visibility is required

See merge request gitlab-org/gitlab-ce!28571
parents 3bce929f c4ef54a1
...@@ -165,15 +165,15 @@ Parameters: ...@@ -165,15 +165,15 @@ Parameters:
|:--------------|:-------|:---------|:---------------------------------------------------| |:--------------|:-------|:---------|:---------------------------------------------------|
| `title` | string | yes | Title of a snippet. | | `title` | string | yes | Title of a snippet. |
| `file_name` | string | yes | Name of a snippet file. | | `file_name` | string | yes | Name of a snippet file. |
| `content` | string | yes | Content of a snippet. | | `code` | string | yes | Content of a snippet. |
| `description` | string | no | Description of a snippet. | | `description` | string | no | Description of a snippet. |
| `visibility` | string | no | Snippet's [visibility](#snippet-visibility-level). | | `visibility` | string | yes | Snippet's [visibility](#snippet-visibility-level). |
Example request: Example request:
```sh ```sh
curl --request POST \ curl --request POST \
--data '{"title": "This is a snippet", "content": "Hello world", "description": "Hello World snippet", "file_name": "test.txt", "visibility": "internal" }' \ --data '{"title": "This is a snippet", "code": "Hello world", "description": "Hello World snippet", "file_name": "test.txt", "visibility": "internal" }' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--header "PRIVATE-TOKEN: valid_api_token" \ --header "PRIVATE-TOKEN: valid_api_token" \
https://gitlab.example.com/api/v4/snippets https://gitlab.example.com/api/v4/snippets
...@@ -222,14 +222,14 @@ Parameters: ...@@ -222,14 +222,14 @@ Parameters:
| `title` | string | no | Title of a snippet. | | `title` | string | no | Title of a snippet. |
| `file_name` | string | no | Name of a snippet file. | | `file_name` | string | no | Name of a snippet file. |
| `description` | string | no | Description of a snippet. | | `description` | string | no | Description of a snippet. |
| `content` | string | no | Content of a snippet. | | `code` | string | no | Content of a snippet. |
| `visibility` | string | no | Snippet's [visibility](#snippet-visibility-level). | | `visibility` | string | no | Snippet's [visibility](#snippet-visibility-level). |
Example request: Example request:
```sh ```sh
curl --request PUT \ curl --request PUT \
--data '{"title": "foo", "content": "bar"}' \ --data '{"title": "foo", "code": "bar"}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--header "PRIVATE-TOKEN: valid_api_token" \ --header "PRIVATE-TOKEN: valid_api_token" \
https://gitlab.example.com/api/v4/snippets/1 https://gitlab.example.com/api/v4/snippets/1
......
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