Skip to content

Commit 3ef425d

Browse files
authored
Micro fixes to CHANGELOG and API doc (#3184)
* Micro fixes to CHANGELOG and API doc Signed-off-by: Marco Pracucci <[email protected]> * Renamed function in e2e tests client Signed-off-by: Marco Pracucci <[email protected]>
1 parent 8de3830 commit 3ef425d

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
## master / unreleased
44

5-
* [CHANGE] Cassandra backend support is now GA (stable).
6-
* [CHANGE] Blocks storage is now GA (stable). The `-experimental` prefix has been removed from all CLI flags related to the blocks storage (no YAML config changes).
5+
* [CHANGE] Cassandra backend support is now GA (stable). #3180
6+
* [CHANGE] Blocks storage is now GA (stable). The `-experimental` prefix has been removed from all CLI flags related to the blocks storage (no YAML config changes). #3180
77
- `-experimental.blocks-storage.*` flags renamed to `-blocks-storage.*`
88
- `-experimental.store-gateway.*` flags renamed to `-store-gateway.*`
99
- `-experimental.querier.store-gateway-client.*` flags renamed to `-querier.store-gateway-client.*`

docs/api/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -555,6 +555,10 @@ DELETE <legacy-http-prefix>/rules/{namespace}/{groupName}
555555

556556
Deletes a rule group by namespace and group name. This endpoints returns `202` on success.
557557

558+
_This experimental endpoint is disabled by default and can be enabled via the `-experimental.ruler.enable-api` CLI flag (or its respective YAML config option)._
559+
560+
_Requires [authentication](#authentication)._
561+
558562
### Delete namespace
559563

560564
```

integration/e2ecortex/client.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -338,8 +338,8 @@ func (c *Client) DeleteRuleGroup(namespace string, groupName string) error {
338338
return nil
339339
}
340340

341-
// DeleteNamespace deletes all the rule groups (and the namespace itself).
342-
func (c *Client) DeleteNamespace(namespace string) error {
341+
// DeleteRuleNamespace deletes all the rule groups (and the namespace itself).
342+
func (c *Client) DeleteRuleNamespace(namespace string) error {
343343
// Create HTTP request
344344
req, err := http.NewRequest("DELETE", fmt.Sprintf("http://%s/api/prom/rules/%s", c.rulerAddress, url.PathEscape(namespace)), nil)
345345
if err != nil {

integration/ruler_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ func TestRulerAPI(t *testing.T) {
7777

7878
// Delete the set rule groups
7979
require.NoError(t, c.DeleteRuleGroup(namespaceOne, ruleGroup.Name))
80-
require.NoError(t, c.DeleteNamespace(namespaceTwo))
80+
require.NoError(t, c.DeleteRuleNamespace(namespaceTwo))
8181

8282
// Wait until the users manager has been terminated
8383
require.NoError(t, ruler.WaitSumMetrics(e2e.Equals(0), "cortex_ruler_managers_total"))

0 commit comments

Comments
 (0)