Commit 8bcdc4b1 authored by Rémy Coutable's avatar Rémy Coutable

API methods should be documented using Grape's DSL

See https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2397#note_13491048
parent ab3dd9a1
...@@ -244,6 +244,12 @@ In this case: ...@@ -244,6 +244,12 @@ In this case:
Here is a list of must-have items. Use them in the exact order that appears Here is a list of must-have items. Use them in the exact order that appears
on this document. Further explanation is given below. 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: - Every method must have the REST API request. For example:
``` ```
......
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