Skip to content

G
gitlab-ce
Commit f4c52296 authored by Marcia Ramos's avatar Marcia Ramos
Browse files
Options

Add version history note to API template

parent 0d08ba3b
Hide whitespace changes
Inline Side-by-side
Showing with 7 additions and 0 deletions
doc/development/documentation/restful_api_styleguide.md
View file @ 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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7