Skip to content

Commit beb38df

Browse files
jtlisipracucci
authored andcommitted
update endpoints and add style note about underscores
Signed-off-by: Jacob Lisi <[email protected]>
1 parent df7c23f commit beb38df

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

docs/proposals/api_design.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,19 @@ Under this path prefix, Cortex will act as a Alertmanager web server. In this ca
4646

4747
A number of endpoints currently exist that are not under the `/api/prom` prefix that provide basic web interfaces and trigger operations for cortex services. These endpoints will all be placed under a url with their service name as a prefix if it is applicable.
4848

49-
| Current | Proposed |
50-
| ----------------- | ----------------------------- |
51-
| `/config` | `/config` |
52-
| `/ring` | `/distributor/ring` |
53-
| `/ruler_ring` | `/ruler/ring` |
54-
| `/compactor_ring` | `/compactor/ring` |
55-
| `/ha-tracker` | `/distributor/ring` |
56-
| `/all_user_stats` | `/distributor/all_user_stats` |
57-
| `/user_stats` | `/distributor/user_stats` |
58-
| `/flush` | `/ingester/flush` |
59-
| `/shutdown` | `/ingester/shutdown` |
49+
| Current | Proposed |
50+
| --------------------- | ---------------------------------- |
51+
| `/status` | `/multitenant-alertmanager/status` |
52+
| `/config` | `/config` |
53+
| `/ring` | `/ingester/ring` |
54+
| `/ruler_ring` | `/ruler/ring` |
55+
| `/compactor/ring` | `/compactor/ring` |
56+
| `/store-gateway/ring` | `/store-gateway/ring` |
57+
| `/ha-tracker` | `/distributor/ha_tracker` |
58+
| `/all_user_stats` | `/distributor/all_user_stats` |
59+
| `/user_stats` | `/distributor/user_stats` |
60+
| `/flush` | `/ingester/flush` |
61+
| `/shutdown` | `/ingester/shutdown` |
6062

6163
### Path Versioning
6264

@@ -70,4 +72,8 @@ In cases where Cortex is run as a single binary, the Alertmanager module will on
7072

7173
### Implementation
7274

73-
This will be implemented by adding an API module to the Cortex service. This module will handle setting up all the required HTTP routes with Cortex. It will be designed around a set of interfaces required to fulfill the API. This is similar to how the `v1` Prometheus API is implemented.
75+
This will be implemented by adding an API module to the Cortex service. This module will handle setting up all the required HTTP routes with Cortex. It will be designed around a set of interfaces required to fulfill the API. This is similar to how the `v1` Prometheus API is implemented.
76+
77+
### Style
78+
79+
* All new paths will utilize `_` instead of `-` for their url to conform with Prometheus and its use of the underscore in the `query_range` endpoint. This applies to all operations endpoints. Component names in the path can still contain dashes. For example: `/store-gateway/ring`.

0 commit comments

Comments
 (0)