Commit 13851f12 authored by Marcia Ramos's avatar Marcia Ramos

Merge branch 'dz-api-dev-doc' into 'master'

Add doc requirement for API development

See merge request gitlab-org/gitlab!27383
parents 7d105219 c0b635d2
...@@ -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