From c1dd1795ed57c9481a1a9cab81daef39dd218346 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9my=20Coutable?= <remy@rymai.me>
Date: Thu, 13 Oct 2016 19:35:57 +0200
Subject: Move the Grape DSL part from Doc styleguide to API styleguide
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Also improve API styleguide

Signed-off-by: Rémy Coutable <remy@rymai.me>
---
 doc/development/api_styleguide.md | 48 +++++++++++++++++++++++++++++++++++----
 doc/development/doc_styleguide.md |  6 -----
 2 files changed, 43 insertions(+), 11 deletions(-)

diff --git a/doc/development/api_styleguide.md b/doc/development/api_styleguide.md
index ee5e7ad3988..be303fc6d39 100644
--- a/doc/development/api_styleguide.md
+++ b/doc/development/api_styleguide.md
@@ -2,6 +2,47 @@
 
 This styleguide recommends best practices for the API development.
 
+## Instance variables
+
+Please do not use instance variables, there is no need for them (we don't need
+to access them as we do in Rails views), local variables are fine.
+
+## Entities
+
+Always use an [Entity] to present the endpoint's payload.
+
+## Methods and parameters description
+
+Every method must be described using the [Grape DSL](https://github.com/ruby-grape/grape#describing-methods)
+(see https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/api/environments.rb
+for a good example):
+
+- `desc` for the method summary. You should pass it a block for additional
+  details such as:
+  - The GitLab version when the endpoint was added
+  - If the endpoint is deprecated, and if yes when will it be removed
+
+- `params` for the method params. This acts as description, validation, and
+  coercion of the parameters
+
+A good example is as follows:
+
+```ruby
+desc 'Get all broadcast messages' do
+  detail 'This feature was introduced in GitLab 8.12.'
+  success Entities::BroadcastMessage
+end
+params do
+  optional :page,     type: Integer, desc: 'Current page number'
+  optional :per_page, type: Integer, desc: 'Number of messages per page'
+end
+get do
+  messages = BroadcastMessage.all
+
+  present paginate(messages), with: Entities::BroadcastMessage
+end
+```
+
 ## Declared params
 
 > Grape allows you to access only the parameters that have been declared by your
@@ -10,7 +51,7 @@ allowed.
 
 – https://github.com/ruby-grape/grape#declared
 
-### Exclude params from parent namespaces
+### Exclude params from parent namespaces!
 
 > By default `declared(params) `includes parameters that were defined in all
 parent namespaces.
@@ -51,8 +92,5 @@ For instance:
 Model.create(foo: params[:foo])
 ```
 
->**Note:**
-Since you [should use Grape's DSL to declare params](doc_styleguide.md#method-description), [parameters validation and
-coercion] comes for free!
-
+[Entity]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/api/entities.rb
 [parameters validation and coercion]: https://github.com/ruby-grape/grape#parameter-validation-and-coercion
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md
index 0b725cf200c..882da2a6562 100644
--- a/doc/development/doc_styleguide.md
+++ b/doc/development/doc_styleguide.md
@@ -342,12 +342,6 @@ You can use the following fake tokens as examples.
 Here is a list of must-have items. Use them in the exact order that appears
 on this document. Further explanation is given below.
 
-- Every method must be described using [Grape's DSL](https://github.com/ruby-grape/grape/tree/v0.13.0#describing-methods)
-  (see https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/api/environments.rb
-  for a good example):
-  - `desc` for the method summary (you can pass it a block for additional details)
-  - `params` for the method params (this acts as description **and** validation
-    of the params)
 - Every method must have the REST API request. For example:
 
     ```
-- 
cgit v1.2.1