From 6fcecacd438094817803f034034a8e83b2baa4e3 Mon Sep 17 00:00:00 2001 From: "opensearch-trigger-bot[bot]" <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Date: Tue, 31 Oct 2023 13:13:21 -0700 Subject: [PATCH] fixtable (#5399) (#5405) (#5418) (cherry picked from commit 3098c99f2dbc48d1c4b9c46aa58d986903661d7f) (cherry picked from commit d60ef587de5afc232cbcd60730455fa0d32be2a4) Signed-off-by: Heather Halter Signed-off-by: github-actions[bot] Co-authored-by: github-actions[bot] --- _observing-your-data/alerting/api.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/_observing-your-data/alerting/api.md b/_observing-your-data/alerting/api.md index 945b1e5800..a122679687 100644 --- a/_observing-your-data/alerting/api.md +++ b/_observing-your-data/alerting/api.md @@ -1270,19 +1270,21 @@ Introduced 1.0 Returns an array of all alerts. -**Path parameters** +#### Path parameters + The following table lists the available path parameters. All path parameters are optional. -Parameter | Data type | Description -:--- | :--- | :--- -`sortString` | String | Determines how to sort the results. Defaults to `monitor_name.keyword`. -`sortOrder` | String | Determines the order of the results. Options are `asc` or `desc`. Defaults to `asc`. -`missing` | String | Optional. -`size` | String | Determines the size of the request to be returned. Defaults to `20`. -`startIndex` | String | The index to start from. Used for paginating results. Defaults to `0`. -`searchString` | String | A search string used to look for a specific alert. Defaults to an empty string. -`severityLevel` | String | The severity level to filter for. Defaults to `ALL`. -`alertState` | String | The alert state to filter for. Defaults to `ALL`. -`monitorId` | String | Filters by monitor ID. + +| Parameter | Data type | Description +| :--- | :--- | :--- +| `sortString` | String | Determines how to sort the results. Defaults to `monitor_name.keyword`. +| `sortOrder` | String | Determines the order of the results. Options are `asc` or `desc`. Defaults to `asc`. +| `missing` | String | Optional. +| `size` | String | Determines the size of the request to be returned. Defaults to `20`. +| `startIndex` | String | The index to start from. Used for paginating results. Defaults to `0`. +| `searchString` | String | A search string used to look for a specific alert. Defaults to an empty string. +| `severityLevel` | String | The severity level to filter for. Defaults to `ALL`. +| `alertState` | String | The alert state to filter for. Defaults to `ALL`. +| `monitorId` | String | Filters by monitor ID. #### Request