diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-09-18 14:14:39 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-09-18 14:14:39 +0000 |
| commit | 1eb82b65c554f21d83447f895a6208905fabe112 (patch) | |
| tree | ab12f01b3dc46f11c02afea1e470a78f06ca70c2 /doc/development/api_styleguide.md | |
| parent | 4ab54c2233e91f60a80e5b6fa2181e6899fdcc3e (diff) | |
| download | gitlab-ce-stable-branch-foss-test.tar.gz | |
Add latest changes from gitlab-org/gitlab@12-3-auto-deploy-20190916stable-branch-foss-test
Diffstat (limited to 'doc/development/api_styleguide.md')
| -rw-r--r-- | doc/development/api_styleguide.md | 13 |
1 files changed, 0 insertions, 13 deletions
diff --git a/doc/development/api_styleguide.md b/doc/development/api_styleguide.md index 3f81440791e..61576236c96 100644 --- a/doc/development/api_styleguide.md +++ b/doc/development/api_styleguide.md @@ -92,18 +92,5 @@ 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 |