From 3da9fef010a88810b6c260e294823b6cd262d86c Mon Sep 17 00:00:00 2001
From: colinleroy <colin@colino.net>
Date: Tue, 4 Dec 2018 03:20:31 +0000
Subject: Fix lack of documentation on how to fetch a snippet's content using
 API

---
 doc/api/snippets.md | 40 ++++++++++++++++++++++++++++++++--------
 1 file changed, 32 insertions(+), 8 deletions(-)

(limited to 'doc')

diff --git a/doc/api/snippets.md b/doc/api/snippets.md
index 7892866cd8e..e840e640377 100644
--- a/doc/api/snippets.md
+++ b/doc/api/snippets.md
@@ -37,13 +37,13 @@ Parameters:
 | ---------          | ----    | -------- | -----------                   |
 | `id`               | Integer | yes      | The ID of a snippet           |
 
-``` bash
+```bash
 curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/snippets/1
 ```
 
 Example response:
 
-``` json
+```json
 {
   "id": 1,
   "title": "test",
@@ -65,6 +65,30 @@ Example response:
 }
 ```
 
+## Single snippet contents
+
+Get a single snippet's raw contents.
+
+```
+GET /snippets/:id/raw
+```
+
+Parameters:
+
+| Attribute          | Type    | Required | Description                   |
+| ---------          | ----    | -------- | -----------                   |
+| `id`               | Integer | yes      | The ID of a snippet           |
+
+```bash
+curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/snippets/1/raw
+```
+
+Example response:
+
+```
+Hello World snippet
+```
+
 ## Create new snippet
 
 Creates a new snippet. The user must have permission to create new snippets.
@@ -84,7 +108,7 @@ Parameters:
 | `visibility`       | String  | no       | The snippet's visibility     |
 
 
-``` bash
+```bash
 curl --request POST \
      --data '{"title": "This is a snippet", "content": "Hello world", "description": "Hello World snippet", "file_name": "test.txt", "visibility": "internal" }' \
      --header 'Content-Type: application/json' \
@@ -94,7 +118,7 @@ curl --request POST \
 
 Example response:
 
-``` json
+```json
 {
   "id": 1,
   "title": "This is a snippet",
@@ -136,7 +160,7 @@ Parameters:
 | `visibility`       | String  | no       | The snippet's visibility     |
 
 
-``` bash
+```bash
 curl --request PUT \
      --data '{"title": "foo", "content": "bar"}' \
      --header 'Content-Type: application/json' \
@@ -146,7 +170,7 @@ curl --request PUT \
 
 Example response:
 
-``` json
+```json
 {
   "id": 1,
   "title": "test",
@@ -201,13 +225,13 @@ GET /snippets/public
 | `per_page` | Integer | no       | number of snippets to return per page |
 | `page`     | Integer | no       | the page to retrieve                  |
 
-``` bash
+```bash
 curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/snippets/public?per_page=2&page=1
 ```
 
 Example response:
 
-``` json
+```json
 [
     {
         "author": {
-- 
cgit v1.2.3