mirror of
https://github.com/hyperdxio/hyperdx
synced 2026-04-21 13:37:15 +00:00
chore: Format OpenAPI Docs (#1555)
This PR commits automated formatting updates to the OpenAPI Docs.
This commit is contained in:
Drew Davis
GitHub
parent
3b71fecb79
commit
ac1a2f7768
2 changed files with 155 additions and 42 deletions
5
.changeset/grumpy-tigers-judge.md
Normal file
5
.changeset/grumpy-tigers-judge.md
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
"@hyperdx/api": patch
|
||||
---
|
||||
|
||||
chore: Format OpenAPI docs
|
||||
|
|
@ -63,12 +63,18 @@
|
|||
},
|
||||
"thresholdType": {
|
||||
"type": "string",
|
||||
"enum": ["above", "below"],
|
||||
"enum": [
|
||||
"above",
|
||||
"below"
|
||||
],
|
||||
"example": "above"
|
||||
},
|
||||
"source": {
|
||||
"type": "string",
|
||||
"enum": ["tile", "search"],
|
||||
"enum": [
|
||||
"tile",
|
||||
"search"
|
||||
],
|
||||
"example": "tile"
|
||||
},
|
||||
"state": {
|
||||
|
|
@ -152,12 +158,18 @@
|
|||
},
|
||||
"source": {
|
||||
"type": "string",
|
||||
"enum": ["tile", "search"],
|
||||
"enum": [
|
||||
"tile",
|
||||
"search"
|
||||
],
|
||||
"example": "tile"
|
||||
},
|
||||
"thresholdType": {
|
||||
"type": "string",
|
||||
"enum": ["above", "below"],
|
||||
"enum": [
|
||||
"above",
|
||||
"below"
|
||||
],
|
||||
"example": "above"
|
||||
},
|
||||
"channel": {
|
||||
|
|
@ -196,12 +208,18 @@
|
|||
},
|
||||
"thresholdType": {
|
||||
"type": "string",
|
||||
"enum": ["above", "below"],
|
||||
"enum": [
|
||||
"above",
|
||||
"below"
|
||||
],
|
||||
"example": "above"
|
||||
},
|
||||
"source": {
|
||||
"type": "string",
|
||||
"enum": ["tile", "search"],
|
||||
"enum": [
|
||||
"tile",
|
||||
"search"
|
||||
],
|
||||
"example": "tile"
|
||||
},
|
||||
"dashboardId": {
|
||||
|
|
@ -260,7 +278,12 @@
|
|||
},
|
||||
"ChartSeries": {
|
||||
"type": "object",
|
||||
"required": ["sourceId", "aggFn", "where", "groupBy"],
|
||||
"required": [
|
||||
"sourceId",
|
||||
"aggFn",
|
||||
"where",
|
||||
"groupBy"
|
||||
],
|
||||
"properties": {
|
||||
"sourceId": {
|
||||
"type": "string",
|
||||
|
|
@ -295,7 +318,10 @@
|
|||
"whereLanguage": {
|
||||
"type": "string",
|
||||
"description": "Query language used in the where clause",
|
||||
"enum": ["lucene", "sql"],
|
||||
"enum": [
|
||||
"lucene",
|
||||
"sql"
|
||||
],
|
||||
"example": "lucene"
|
||||
},
|
||||
"groupBy": {
|
||||
|
|
@ -304,7 +330,10 @@
|
|||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"example": ["service", "host"]
|
||||
"example": [
|
||||
"service",
|
||||
"host"
|
||||
]
|
||||
},
|
||||
"metricName": {
|
||||
"type": "string",
|
||||
|
|
@ -314,7 +343,11 @@
|
|||
"metricDataType": {
|
||||
"type": "string",
|
||||
"description": "Type of metric data",
|
||||
"enum": ["sum", "gauge", "histogram"],
|
||||
"enum": [
|
||||
"sum",
|
||||
"gauge",
|
||||
"histogram"
|
||||
],
|
||||
"example": "gauge"
|
||||
},
|
||||
"type": {
|
||||
|
|
@ -331,14 +364,21 @@
|
|||
},
|
||||
"dataSource": {
|
||||
"type": "string",
|
||||
"enum": ["events", "metrics"],
|
||||
"enum": [
|
||||
"events",
|
||||
"metrics"
|
||||
],
|
||||
"example": "events"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SeriesQueryRequest": {
|
||||
"type": "object",
|
||||
"required": ["series", "startTime", "endTime"],
|
||||
"required": [
|
||||
"series",
|
||||
"startTime",
|
||||
"endTime"
|
||||
],
|
||||
"properties": {
|
||||
"series": {
|
||||
"type": "array",
|
||||
|
|
@ -384,7 +424,10 @@
|
|||
"seriesReturnType": {
|
||||
"type": "string",
|
||||
"description": "Format of the returned data",
|
||||
"enum": ["ratio", "column"],
|
||||
"enum": [
|
||||
"ratio",
|
||||
"column"
|
||||
],
|
||||
"example": "column"
|
||||
}
|
||||
}
|
||||
|
|
@ -413,7 +456,10 @@
|
|||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"example": ["api", "prod-host-1"]
|
||||
"example": [
|
||||
"api",
|
||||
"prod-host-1"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -489,13 +535,18 @@
|
|||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"example": ["production", "monitoring"]
|
||||
"example": [
|
||||
"production",
|
||||
"monitoring"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateDashboardRequest": {
|
||||
"type": "object",
|
||||
"required": ["name"],
|
||||
"required": [
|
||||
"name"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
|
|
@ -512,7 +563,9 @@
|
|||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"example": ["development"]
|
||||
"example": [
|
||||
"development"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -534,7 +587,10 @@
|
|||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"example": ["production", "updated"]
|
||||
"example": [
|
||||
"production",
|
||||
"updated"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -570,7 +626,9 @@
|
|||
"summary": "Get Alert",
|
||||
"description": "Retrieves a specific alert by ID",
|
||||
"operationId": "getAlert",
|
||||
"tags": ["Alerts"],
|
||||
"tags": [
|
||||
"Alerts"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "id",
|
||||
|
|
@ -646,7 +704,9 @@
|
|||
"summary": "Update Alert",
|
||||
"description": "Updates an existing alert",
|
||||
"operationId": "updateAlert",
|
||||
"tags": ["Alerts"],
|
||||
"tags": [
|
||||
"Alerts"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "id",
|
||||
|
|
@ -735,7 +795,9 @@
|
|||
"summary": "Delete Alert",
|
||||
"description": "Deletes an alert",
|
||||
"operationId": "deleteAlert",
|
||||
"tags": ["Alerts"],
|
||||
"tags": [
|
||||
"Alerts"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "id",
|
||||
|
|
@ -788,7 +850,9 @@
|
|||
"summary": "List Alerts",
|
||||
"description": "Retrieves a list of all alerts for the authenticated team",
|
||||
"operationId": "listAlerts",
|
||||
"tags": ["Alerts"],
|
||||
"tags": [
|
||||
"Alerts"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successfully retrieved alerts",
|
||||
|
|
@ -847,7 +911,9 @@
|
|||
"summary": "Create Alert",
|
||||
"description": "Creates a new alert",
|
||||
"operationId": "createAlert",
|
||||
"tags": ["Alerts"],
|
||||
"tags": [
|
||||
"Alerts"
|
||||
],
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
|
|
@ -916,7 +982,9 @@
|
|||
"summary": "Query Chart Series Data",
|
||||
"description": "Retrieves time series data based on configured series parameters",
|
||||
"operationId": "queryChartSeries",
|
||||
"tags": ["Charts"],
|
||||
"tags": [
|
||||
"Charts"
|
||||
],
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
|
|
@ -952,14 +1020,18 @@
|
|||
"sourceId": "65f5e4a3b9e77c001a123456",
|
||||
"aggFn": "count",
|
||||
"where": "SeverityText:error",
|
||||
"groupBy": ["service"]
|
||||
"groupBy": [
|
||||
"service"
|
||||
]
|
||||
},
|
||||
{
|
||||
"sourceId": "65f5e4a3b9e77c001a123456",
|
||||
"aggFn": "avg",
|
||||
"field": "duration",
|
||||
"where": "SeverityText:error",
|
||||
"groupBy": ["service"]
|
||||
"groupBy": [
|
||||
"service"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -1045,17 +1117,23 @@
|
|||
{
|
||||
"ts_bucket": 1647014400000,
|
||||
"series_0.data": 15,
|
||||
"group": ["api"]
|
||||
"group": [
|
||||
"api"
|
||||
]
|
||||
},
|
||||
{
|
||||
"ts_bucket": 1647014400000,
|
||||
"series_0.data": 8,
|
||||
"group": ["frontend"]
|
||||
"group": [
|
||||
"frontend"
|
||||
]
|
||||
},
|
||||
{
|
||||
"ts_bucket": 1647018000000,
|
||||
"series_0.data": 22,
|
||||
"group": ["api"]
|
||||
"group": [
|
||||
"api"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -1153,7 +1231,9 @@
|
|||
"summary": "List Dashboards",
|
||||
"description": "Retrieves a list of all dashboards for the authenticated team",
|
||||
"operationId": "listDashboards",
|
||||
"tags": ["Dashboards"],
|
||||
"tags": [
|
||||
"Dashboards"
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successfully retrieved dashboards",
|
||||
|
|
@ -1174,7 +1254,9 @@
|
|||
"summary": "Create Dashboard",
|
||||
"description": "Creates a new dashboard",
|
||||
"operationId": "createDashboard",
|
||||
"tags": ["Dashboards"],
|
||||
"tags": [
|
||||
"Dashboards"
|
||||
],
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
|
|
@ -1206,7 +1288,10 @@
|
|||
]
|
||||
}
|
||||
],
|
||||
"tags": ["api", "monitoring"]
|
||||
"tags": [
|
||||
"api",
|
||||
"monitoring"
|
||||
]
|
||||
}
|
||||
},
|
||||
"complexDashboard": {
|
||||
|
|
@ -1244,13 +1329,18 @@
|
|||
"dataSource": "events",
|
||||
"aggFn": "count",
|
||||
"where": "level:error",
|
||||
"groupBy": ["errorType"],
|
||||
"groupBy": [
|
||||
"errorType"
|
||||
],
|
||||
"sortOrder": "desc"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"tags": ["service-health", "production"]
|
||||
"tags": [
|
||||
"service-health",
|
||||
"production"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1292,7 +1382,10 @@
|
|||
]
|
||||
}
|
||||
],
|
||||
"tags": ["api", "monitoring"]
|
||||
"tags": [
|
||||
"api",
|
||||
"monitoring"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1334,7 +1427,9 @@
|
|||
"summary": "Get Dashboard",
|
||||
"description": "Retrieves a specific dashboard by ID",
|
||||
"operationId": "getDashboard",
|
||||
"tags": ["Dashboards"],
|
||||
"tags": [
|
||||
"Dashboards"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "id",
|
||||
|
|
@ -1402,7 +1497,10 @@
|
|||
]
|
||||
}
|
||||
],
|
||||
"tags": ["infrastructure", "monitoring"]
|
||||
"tags": [
|
||||
"infrastructure",
|
||||
"monitoring"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1442,7 +1540,9 @@
|
|||
"summary": "Update Dashboard",
|
||||
"description": "Updates an existing dashboard",
|
||||
"operationId": "updateDashboard",
|
||||
"tags": ["Dashboards"],
|
||||
"tags": [
|
||||
"Dashboards"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "id",
|
||||
|
|
@ -1503,7 +1603,10 @@
|
|||
]
|
||||
}
|
||||
],
|
||||
"tags": ["production", "updated"]
|
||||
"tags": [
|
||||
"production",
|
||||
"updated"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1562,7 +1665,10 @@
|
|||
]
|
||||
}
|
||||
],
|
||||
"tags": ["production", "updated"]
|
||||
"tags": [
|
||||
"production",
|
||||
"updated"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1615,7 +1721,9 @@
|
|||
"summary": "Delete Dashboard",
|
||||
"description": "Deletes a dashboard",
|
||||
"operationId": "deleteDashboard",
|
||||
"tags": ["Dashboards"],
|
||||
"tags": [
|
||||
"Dashboards"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "id",
|
||||
|
|
@ -1670,4 +1778,4 @@
|
|||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue