diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-18 18:09:35 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-18 18:09:35 +0000 |
| commit | 5bfb8d1fad825eec90b0af688c7cd1b352c9056e (patch) | |
| tree | 385411919c4186d11a769385ad8dafeef6cc36a7 /doc/development/api_styleguide.md | |
| parent | aaf59610548d9b0fd01acfd50e831cbe519ecba2 (diff) | |
| download | gitlab-ce-5bfb8d1fad825eec90b0af688c7cd1b352c9056e.tar.gz | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/api_styleguide.md')
| -rw-r--r-- | doc/development/api_styleguide.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/development/api_styleguide.md b/doc/development/api_styleguide.md index bd5ea6ac506..8537c63a8b7 100644 --- a/doc/development/api_styleguide.md +++ b/doc/development/api_styleguide.md @@ -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. +## 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 Every method must be described using the [Grape DSL](https://github.com/ruby-grape/grape#describing-methods) |