diff options
| author | Nikolay Samokhvalov <gitlab@samokhvalov.com> | 2019-06-04 02:46:29 +0300 |
|---|---|---|
| committer | Evan Read <eread@gitlab.com> | 2019-06-04 02:46:29 +0300 |
| commit | c4ef54a1b53843dc52097e0d1c1083ddf84918c3 (patch) | |
| tree | ed5a4b89f2c7171659f6e519589f377a19072b68 /doc/api/snippets.md | |
| parent | 3bce929fd1e4132520c9633a312cfdaffb25d230 (diff) | |
Update description of Snippets API, create and update methods
Currently, the field used to fill the contents is called "code".
Also "visibility" is now required.
Diffstat (limited to 'doc/api/snippets.md')
| -rw-r--r-- | doc/api/snippets.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/api/snippets.md b/doc/api/snippets.md index f90447e124e..1ce0b1e7a62 100644 --- a/doc/api/snippets.md +++ b/doc/api/snippets.md @@ -165,15 +165,15 @@ Parameters: |:--------------|:-------|:---------|:---------------------------------------------------| | `title` | string | yes | Title of a snippet. | | `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. | -| `visibility` | string | no | Snippet's [visibility](#snippet-visibility-level). | +| `visibility` | string | yes | Snippet's [visibility](#snippet-visibility-level). | Example request: ```sh 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 "PRIVATE-TOKEN: valid_api_token" \ https://gitlab.example.com/api/v4/snippets @@ -222,14 +222,14 @@ Parameters: | `title` | string | no | Title of a snippet. | | `file_name` | string | no | Name of a snippet file. | | `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). | Example request: ```sh curl --request PUT \ - --data '{"title": "foo", "content": "bar"}' \ + --data '{"title": "foo", "code": "bar"}' \ --header 'Content-Type: application/json' \ --header "PRIVATE-TOKEN: valid_api_token" \ https://gitlab.example.com/api/v4/snippets/1 |