Merge branch '12910-snippets-description' into 'master'

Support descriptions for snippets

Closes #31894

See merge request !11071

2 files changed, 22 insertions, 14 deletions

diff --git a/doc/api/project_snippets.md b/doc/api/project_snippets.md
index ff379473961..92491de4daa 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,6 +71,7 @@ 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
 
@@ -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
 
diff --git a/doc/api/snippets.md b/doc/api/snippets.md
index fb8cf97896c..efaab712367 100644
--- a/doc/api/snippets.md
+++ b/doc/api/snippets.md
@@ -48,6 +48,7 @@ Example response:
   "id": 1,
   "title": "test",
   "file_name": "add.rb",
+  "description": "Ruby test snippet",
   "author": {
     "id": 1,
     "username": "john_smith",
@@ -73,16 +74,17 @@ POST /snippets
 
 Parameters:
 
-| Attribute          | Type    | Required | Description                |
-| ---------          | ----    | -------- | -----------                |
-| `title`            | String  | yes      | The title of a snippet     |
-| `file_name`        | String  | yes      | The name of a snippet file |
-| `content`          | String  | yes      | The content of a snippet   |
-| `visibility`       | String  | yes      | The snippet's visibility   |
+| Attribute          | Type    | Required | Description                  |
+| ---------          | ----    | -------- | -----------                  |
+| `title`            | String  | yes      | The title of a snippet       |
+| `file_name`        | String  | yes      | The name of a snippet file   |
+| `content`          | String  | yes      | The content of a snippet     |
+| `description`      | String  | no       | The description of a snippet |
+| `visibility`       | String  | no       | The snippet's visibility     |
 
 
 ``` bash
-curl --request POST --data '{"title": "This is a snippet", "content": "Hello world", "file_name": "test.txt", "visibility": "internal" }' --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/snippets
+curl --request POST --data '{"title": "This is a snippet", "content": "Hello world", "description": "Hello World snippet", "file_name": "test.txt", "visibility": "internal" }' --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/snippets
 ```
 
 Example response:
@@ -92,6 +94,7 @@ Example response:
   "id": 1,
   "title": "This is a snippet",
   "file_name": "test.txt",
+  "description": "Hello World snippet",
   "author": {
     "id": 1,
     "username": "john_smith",
@@ -117,13 +120,14 @@ PUT /snippets/:id
 
 Parameters:
 
-| Attribute          | Type    | Required | Description                |
-| ---------          | ----    | -------- | -----------                |
-| `id`               | Integer | yes      | The ID of a snippet        |
-| `title`            | String  | no       | The title of a snippet     |
-| `file_name`        | String  | no       | The name of a snippet file |
-| `content`          | String  | no       | The content of a snippet   |
-| `visibility`       | String  | no       | The snippet's visibility   |
+| Attribute          | Type    | Required | Description                  |
+| ---------          | ----    | -------- | -----------                  |
+| `id`               | Integer | yes      | The ID of a snippet          |
+| `title`            | String  | no       | The title of a snippet       |
+| `file_name`        | String  | no       | The name of a snippet file   |
+| `description`      | String  | no       | The description of a snippet |
+| `content`          | String  | no       | The content of a snippet     |
+| `visibility`       | String  | no       | The snippet's visibility     |
 
 
 ``` bash
@@ -137,6 +141,7 @@ Example response:
   "id": 1,
   "title": "test",
   "file_name": "add.rb",
+  "description": "description of snippet",
   "author": {
     "id": 1,
     "username": "john_smith",