diff options
| author | Robert Speicher <robert@gitlab.com> | 2016-10-25 18:12:43 +0300 |
|---|---|---|
| committer | Robert Speicher <robert@gitlab.com> | 2016-10-25 18:12:43 +0300 |
| commit | 65d86e0d118bbbad99493a07d09c9675d3e41ec0 (patch) | |
| tree | b56676284c71dcd101cbed36c53838e6a235590c /doc/development/doc_styleguide.md | |
| parent | b33e04f9b278c2a0dcca4aa31fea557d6bb6394e (diff) | |
| parent | 11e40c0e26e07d153cd2712bf23b5d679b54615c (diff) | |
Merge branch 'improve-grape-dsl-rules' into 'master'
Add an API styleguide
This adds a styleguide for API development. Spinned-of from https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6860#note_16922017.
[ci skip]
See merge request !6864
Diffstat (limited to 'doc/development/doc_styleguide.md')
| -rw-r--r-- | doc/development/doc_styleguide.md | 6 |
1 files changed, 0 insertions, 6 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md index f07d2c9af2d..4cc581dd991 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: ``` |