Skip to content

Commit

Permalink
Docs: Fix bad links in the API section (#6688)
Browse files Browse the repository at this point in the history
* Docs: Fix a bad link in the API section

* Fix 2 more of the same bad link
  • Loading branch information
KMiller-Grafana authored Jul 15, 2022
1 parent 0e28452 commit 5b432e3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
11 changes: 8 additions & 3 deletions docs/sources/api/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: HTTP API
menuTitle: "HTTP API"
description: "Loki exposes REST endpoints for operating on a Loki cluster. This section details the endpoints."
weight: 900
---

Expand Down Expand Up @@ -1024,7 +1026,8 @@ POST /loki/api/v1/delete
PUT /loki/api/v1/delete
```

Create a new delete request for the authenticated tenant. More details can be found in the [logs deletion documentation](../operations/storage/logs-deletion.md#request-log-entry-deletion).
Create a new delete request for the authenticated tenant.
The [log entry deletion](../operations/storage/logs-deletion/) documentation has configuration details.

Log entry deletion is supported _only_ when the BoltDB Shipper is configured for the index store.

Expand Down Expand Up @@ -1062,7 +1065,8 @@ curl -u "Tenant1:$API_TOKEN" \
GET /loki/api/v1/delete
```

List the existing delete requests for the authenticated tenant. More details can be found in the [logs deletion documentation](../operations/storage/logs-deletion.md#list-delete-requests).
List the existing delete requests for the authenticated tenant.
The [log entry deletion](../operations/storage/logs-deletion/) documentation has configuration details.

Log entry deletion is supported _only_ when the BoltDB Shipper is configured for the index store.

Expand Down Expand Up @@ -1098,7 +1102,8 @@ curl -u "Tenant1:$API_TOKEN" \
DELETE /loki/api/v1/delete
```

Remove a delete request for the authenticated tenant. More details can be found in the [logs deletion documentation](../operations/storage/logs-deletion.md#request-cancellation-of-a-delete-request).
Remove a delete request for the authenticated tenant.
The [log entry deletion](../operations/storage/logs-deletion/) documentation has configuration details.

Loki allows cancellation of delete requests until the requests are picked up for processing. It is controlled by the `delete_request_cancel_period` YAML configuration or the equivalent command line option when invoking Loki.

Expand Down
6 changes: 4 additions & 2 deletions docs/sources/operations/storage/logs-deletion.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: Log Entry Deletion
title: Log entry deletion
menuTitle: "Log entry deletion"
description: "Log entries from a specified stream may be deleted."
weight: 60
---
# Log Entry Deletion
# Log entry deletion

Grafana Loki supports the deletion of log entries from a specified stream.
Log entries that fall within a specified time window and match an optional line filter are those that will be deleted.
Expand Down

0 comments on commit 5b432e3

Please sign in to comment.