From 4671cb7836d9269bd965be946dd9d62fc7e1ddef Mon Sep 17 00:00:00 2001
From: Evan Read <eread@gitlab.com>
Date: Fri, 2 Nov 2018 11:28:37 +1000
Subject: Add API topic template

---
 doc/development/documentation/styleguide.md | 35 +++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md
index e2c29ced517..a18c21d921a 100644
--- a/doc/development/documentation/styleguide.md
+++ b/doc/development/documentation/styleguide.md
@@ -588,6 +588,41 @@ on this document. Further explanation is given below.
 - Every method must have a cURL example.
 - Every method must have a response body (in JSON format).
 
+### API topic template
+
+The following can be used as a template to get started:
+
+```md
+## Descriptive title
+
+One or two sentence description of what endpoint does.
+
+```
+METHOD /endpoint
+```
+
+| Attribute   | Type     | Required | Description           |
+|:------------|:---------|:---------|:----------------------|
+| `attribute` | datatype | yes/no   | Detailed description. |
+| `attribute` | datatype | yes/no   | Detailed description. |
+
+Example request:
+
+```sh
+curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" 'https://gitlab.example.com/api/v4/endpoint?parameters'
+```
+
+Example response:
+
+```json
+[
+  {
+  }
+]
+```
+
+```
+
 ### Fake tokens
 
 There may be times where a token is needed to demonstrate an API call using
-- 
cgit v1.2.1