Skip to content

G
gitlab-ce
Commit 329721f5 authored by Craig Norris's avatar Craig Norris Committed by Nourdin el Bacha
Browse files
Options

Apply 2 suggestion(s) to 1 file(s)

parent 7b2a5cd3
Hide whitespace changes
Inline Side-by-side
Showing with 6 additions and 6 deletions
doc/development/documentation/restful_api_styleguide.md
View file @ 329721f5
......@@ -33,8 +33,8 @@ In the Markdown doc for a resource (AKA endpoint):
## API topic template
The following can be used as a template to get started.
Ensure to list the required attributes on top:
Use the following template to help you get started. Be sure to list any
required attributes first in the table.
````markdown
## Descriptive title
......@@ -51,10 +51,10 @@ Supported attributes:
| Attribute | Type | Required | Description |
|:------------|:---------|:---------|:----------------------|
| `attribute` | datatype | yes | Detailed description. |
| `attribute` | datatype | no | Detailed description. |
| `attribute` | datatype | no | Detailed description. |
| `attribute` | datatype | no | Detailed description. |
| `attribute` | datatype | **{check-circle}** Yes | Detailed description. |
| `attribute` | datatype | **{dotted-circle}** No | Detailed description. |
| `attribute` | datatype | **{dotted-circle}** No | Detailed description. |
| `attribute` | datatype | **{dotted-circle}** No | Detailed description. |
Example request:
......
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