Commit 7c518a49 authored by Nourdin el Bacha's avatar Nourdin el Bacha

List required attributes on top

parent faeb6337
...@@ -34,6 +34,7 @@ In the Markdown doc for a resource (AKA endpoint): ...@@ -34,6 +34,7 @@ In the Markdown doc for a resource (AKA endpoint):
## API topic template ## API topic template
The following can be used as a template to get started: The following can be used as a template to get started:
Note: ensure to list the required attributes on top.
````markdown ````markdown
## Descriptive title ## Descriptive title
...@@ -50,8 +51,10 @@ Supported attributes: ...@@ -50,8 +51,10 @@ Supported attributes:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|:------------|:---------|:---------|:----------------------| |:------------|:---------|:---------|:----------------------|
| `attribute` | datatype | yes/no | Detailed description. | | `attribute` | datatype | yes | Detailed description. |
| `attribute` | datatype | yes/no | Detailed description. | | `attribute` | datatype | no | Detailed description. |
| `attribute` | datatype | no | Detailed description. |
| `attribute` | datatype | no | Detailed description. |
Example request: 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