Commit c0b635d2 authored by Dmytro Zaporozhets's avatar Dmytro Zaporozhets Committed by Marcia Ramos

Fix doc api link to be relative

Signed-off-by: default avatarDmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
parent 3ec579fc
...@@ -11,6 +11,12 @@ to access them as we do in Rails views), local variables are fine. ...@@ -11,6 +11,12 @@ to access them as we do in Rails views), local variables are fine.
Always use an [Entity] to present the endpoint's payload. Always use an [Entity] to present the endpoint's payload.
## Documentation
API endpoints must come with [documentation](documentation/styleguide.md#api), unless it is internal or behind a feature flag.
The docs should be in the same merge request, or, if strictly necessary,
in a follow-up with the same milestone as the original merge request.
## Methods and parameters description ## Methods and parameters description
Every method must be described using the [Grape DSL](https://github.com/ruby-grape/grape#describing-methods) Every method must be described using the [Grape DSL](https://github.com/ruby-grape/grape#describing-methods)
......
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