diff options
| author | Rémy Coutable <remy@rymai.me> | 2016-08-01 16:52:51 +0300 |
|---|---|---|
| committer | Rémy Coutable <remy@rymai.me> | 2016-08-01 16:52:51 +0300 |
| commit | 8bcdc4b185d70bfb2a50d22ec99a26c2c463a2f8 (patch) | |
| tree | 5f16d1b05e94c8db29f4424ccbfcf81684f375c3 /doc/development/doc_styleguide.md | |
| parent | ab3dd9a106787b70c26e55e9f0dc7fe6c34b0769 (diff) | |
API methods should be documented using Grape's DSL
See https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2397#note_13491048
Diffstat (limited to 'doc/development/doc_styleguide.md')
| -rw-r--r-- | doc/development/doc_styleguide.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md index 6ee7b3cfeeb..3a3597bccaa 100644 --- a/doc/development/doc_styleguide.md +++ b/doc/development/doc_styleguide.md @@ -244,6 +244,12 @@ In this case: 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: ``` |