Commit 39e3be47 authored by Craig Norris's avatar Craig Norris

Merge branch 'nelbacha-master-patch-93154' into 'master'

List required attributes on top

See merge request gitlab-org/gitlab!60625
parents ccca24aa 329721f5
...@@ -33,7 +33,8 @@ In the Markdown doc for a resource (AKA endpoint): ...@@ -33,7 +33,8 @@ 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: Use the following template to help you get started. Be sure to list any
required attributes first in the table.
````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 | **{check-circle}** Yes | Detailed description. |
| `attribute` | datatype | yes/no | 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: 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