Skip to content

Commit db1bc79

Browse files
authored
docs: Document the 500-entry cap on PromQL pie and bar limits
1 parent fd664b3 commit db1bc79

2 files changed

Lines changed: 6 additions & 8 deletions

File tree

‎packages/api/openapi.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3217,7 +3217,7 @@
32173217
"limit": {
32183218
"type": "integer",
32193219
"minimum": 0,
3220-
"description": "Maximum number of slices (top-N by value). Omit to use the default cap, set 0 for unlimited, or a positive N to keep the top N.\n",
3220+
"description": "Maximum number of slices (top-N by value), at most 500. Omit or set 0 to show up to 500.\n",
32213221
"example": 10
32223222
}
32233223
}
@@ -3263,7 +3263,7 @@
32633263
"limit": {
32643264
"type": "integer",
32653265
"minimum": 0,
3266-
"description": "Maximum number of bars (top-N by value). Omit to use the default cap, set 0 for unlimited, or a positive N to keep the top N.\n",
3266+
"description": "Maximum number of bars (top-N by value), at most 500. Omit or set 0 to show up to 500.\n",
32673267
"example": 10
32683268
}
32693269
}

‎packages/api/src/routers/external-api/v2/dashboards.ts‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1799,9 +1799,8 @@ const EXTERNAL_DASHBOARD_PROJECTION = {
17991799
* type: integer
18001800
* minimum: 0
18011801
* description: >
1802-
* Maximum number of slices (top-N by value). Omit to use the
1803-
* default cap, set 0 for unlimited, or a positive N to keep the
1804-
* top N.
1802+
* Maximum number of slices (top-N by value), at most 500. Omit
1803+
* or set 0 to show up to 500.
18051804
* example: 10
18061805
*
18071806
* CategoricalBarPromqlChartConfig:
@@ -1838,9 +1837,8 @@ const EXTERNAL_DASHBOARD_PROJECTION = {
18381837
* type: integer
18391838
* minimum: 0
18401839
* description: >
1841-
* Maximum number of bars (top-N by value). Omit to use the
1842-
* default cap, set 0 for unlimited, or a positive N to keep the
1843-
* top N.
1840+
* Maximum number of bars (top-N by value), at most 500. Omit or
1841+
* set 0 to show up to 500.
18441842
* example: 10
18451843
*
18461844
* HeatmapPromqlChartConfig:

0 commit comments

Comments
 (0)