diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-09-16 15:06:26 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-09-16 15:06:26 +0000 |
| commit | 84727c8209a4412e21111a07f99b0438b03232de (patch) | |
| tree | 1fcfa02b01548c3cdc561186870a1c807f227f0b /doc/development/api_styleguide.md | |
| parent | d2798d607e11e0ebae83ae909404834388733428 (diff) | |
| download | gitlab-ce-84727c8209a4412e21111a07f99b0438b03232de.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 | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/development/api_styleguide.md b/doc/development/api_styleguide.md index 61576236c96..3f81440791e 100644 --- a/doc/development/api_styleguide.md +++ b/doc/development/api_styleguide.md @@ -92,5 +92,18 @@ For instance: Model.create(foo: params[:foo]) ``` +## Using API path helpers in GitLab Rails codebase + +Because we support [installing GitLab under a relative URL], one must take this +into account when using API path helpers generated by Grape. Any such API path +helper usage must be in wrapped into the `expose_path` helper call. + +For instance: + +```haml +- endpoint = expose_path(api_v4_projects_issues_related_merge_requests_path(id: @project.id, issue_iid: @issue.iid)) +``` + [Entity]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/api/entities.rb [validation, and coercion of the parameters]: https://github.com/ruby-grape/grape#parameter-validation-and-coercion +[installing GitLab under a relative URL]: https://docs.gitlab.com/ee/install/relative_url.html |