routing.md 2.01 KB
Newer Older
1 2 3 4 5 6 7 8 9
# Routing

The GitLab backend is written primarily with Rails so it uses [Rails
routing](https://guides.rubyonrails.org/routing.html). Beside Rails best
practices, there are few rules unique to the GitLab application. To
support subgroups, GitLab project and group routes use the wildcard
character to match project and group routes. For example, we might have
a path such as:

10 11 12
```
/gitlab-com/customer-success/north-america/west/customerA
```
13 14 15

However, paths can be ambiguous. Consider the following example:

16 17 18
```
/gitlab-com/edit
```
19 20 21 22 23 24 25 26 27 28 29 30 31

It's ambiguous whether there is a subgroup named `edit` or whether
this is a special endpoint to edit the `gitlab-com` group.

To eliminate the ambiguity and to make the backend easier to maintain,
we introduced the `/-/` scope. The purpose of it is to separate group or
project paths from the rest of the routes. Also it helps to reduce the
number of [reserved names](../user/reserved_names.md).

## Global routes

We have a number of global routes. For example:

32 33 34 35
```
/-/health
/-/metrics
```
36 37 38 39 40 41 42

## Group routes

Every group route must be under the `/-/` scope.

Examples:

43 44 45 46 47 48
```
gitlab-org/-/edit
gitlab-org/-/activity
gitlab-org/-/security/dashboard
gitlab-org/serverless/-/activity
```
49 50 51 52 53 54 55 56 57 58

To achieve that, use the `scope '-'` method.

## Project routes

Every project route must be under the `/-/` scope, except cases where a Git
client or other software requires something different.

Examples:

59
```
60 61 62
gitlab-org/gitlab/-/activity
gitlab-org/gitlab/-/jobs/123
gitlab-org/gitlab/-/settings/repository
63 64
gitlab-org/serverless/runtimes/-/settings/repository
```
65 66 67 68 69 70 71 72

Currently, only some project routes are placed under the `/-/` scope. However,
you can help us migrate more of them! To migrate project routes:

1. Modify existing routes by adding `-` scope.
1. Add redirects for legacy routes by using `Gitlab::Routing.redirect_legacy_paths`.
1. Create a technical debt issue to remove deprecated routes in later releases.

73
To get started, see an [example merge request](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/28435).