Commit c3d9d46f authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'docs-improve-restful-api-template' into 'master'

Docs: Add version history note to API template

See merge request gitlab-org/gitlab!47785
parents 88365615 f4c52296
...@@ -38,12 +38,16 @@ The following can be used as a template to get started: ...@@ -38,12 +38,16 @@ The following can be used as a template to get started:
````markdown ````markdown
## Descriptive title ## Descriptive title
> Version history note.
One or two sentence description of what endpoint does. One or two sentence description of what endpoint does.
```plaintext ```plaintext
METHOD /endpoint METHOD /endpoint
``` ```
Supported attributes:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|:------------|:---------|:---------|:----------------------| |:------------|:---------|:---------|:----------------------|
| `attribute` | datatype | yes/no | Detailed description. | | `attribute` | datatype | yes/no | Detailed description. |
...@@ -65,6 +69,9 @@ Example response: ...@@ -65,6 +69,9 @@ Example response:
``` ```
```` ````
Adjust the [version history note accordingly](styleguide/index.md#version-text-in-the-version-history)
to describe the GitLab release that introduced the API call.
## Method description ## Method description
Use the following table headers to describe the methods. Attributes should Use the following table headers to describe the methods. Attributes should
......
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