@groundcover/api-client 0.15.0 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -516,6 +516,12 @@ export type AssetListItem = {
516
516
  * Populated for monitors and dashboards only. Matches DataSourceItem.DatasourceName values.
517
517
  */
518
518
  missing_data_sources?: Array<string>;
519
+ /**
520
+ * Metric names used by this data source that are not currently live in groundcover.
521
+ * Populated for synthesized metrics items returned with dataSourceId. Null means
522
+ * coverage has not been computed because the migration predates this field.
523
+ */
524
+ missing_metrics?: Array<string> | null;
519
525
  /**
520
526
  * Missing requirements for full conversion.
521
527
  */
@@ -2258,8 +2264,8 @@ export type DashboardFiltersRequest = {
2258
2264
  */
2259
2265
  query?: string;
2260
2266
  /**
2261
- * Optional list of facet keys (owner, tags, source) that must appear in the
2262
- * response even when the filtered set produces no values for them — each such
2267
+ * Optional list of facet keys (owner, tags, source, favorites) that must
2268
+ * appear in the response even when the filtered set produces no values for them — each such
2263
2269
  * key comes back as an empty list instead of being omitted from the map. This
2264
2270
  * only guarantees presence: every facet is computed regardless of what is listed
2265
2271
  * here. Keys outside the supported facet set are rejected with a 400 rather than
@@ -9104,7 +9110,7 @@ export type GetDashboardsData = {
9104
9110
  */
9105
9111
  source?: 'gc-catalog' | 'terraform' | 'regular';
9106
9112
  /**
9107
- * gcQL filter query (filters only, no pipes). Supported keys: name, tags, owner, source, description, team. `status` is also accepted but intentionally not suggested by the filter-bar autocomplete — the status selector owns it via the top-level status param, and the two are ANDed, so a query status that contradicts the param yields an empty list. Unkeyed terms are free text, matched as a case-insensitive substring across name, description, owner and tags.
9113
+ * gcQL filter query (filters only, no pipes). Supported keys: name, tags, owner, source, description, team. `status` and `favorites` (e.g. favorites:true, scoped to the authenticated member) are also accepted but intentionally not suggested by the filter-bar autocomplete — the status selector owns status via the top-level status param (the two are ANDed, so a query status that contradicts the param yields an empty list), and the facet panel owns favorites. Unkeyed terms are free text, matched as a case-insensitive substring across name, description, owner and tags.
9108
9114
  */
9109
9115
  query?: string;
9110
9116
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@groundcover/api-client",
3
- "version": "0.15.0",
3
+ "version": "0.17.0",
4
4
  "description": "groundcover TypeScript API Client",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -546,6 +546,12 @@ export type AssetListItem = {
546
546
  * Populated for monitors and dashboards only. Matches DataSourceItem.DatasourceName values.
547
547
  */
548
548
  missing_data_sources?: Array<string>;
549
+ /**
550
+ * Metric names used by this data source that are not currently live in groundcover.
551
+ * Populated for synthesized metrics items returned with dataSourceId. Null means
552
+ * coverage has not been computed because the migration predates this field.
553
+ */
554
+ missing_metrics?: Array<string> | null;
549
555
  /**
550
556
  * Missing requirements for full conversion.
551
557
  */
@@ -2409,8 +2415,8 @@ export type DashboardFiltersRequest = {
2409
2415
  */
2410
2416
  query?: string;
2411
2417
  /**
2412
- * Optional list of facet keys (owner, tags, source) that must appear in the
2413
- * response even when the filtered set produces no values for them — each such
2418
+ * Optional list of facet keys (owner, tags, source, favorites) that must
2419
+ * appear in the response even when the filtered set produces no values for them — each such
2414
2420
  * key comes back as an empty list instead of being omitted from the map. This
2415
2421
  * only guarantees presence: every facet is computed regardless of what is listed
2416
2422
  * here. Keys outside the supported facet set are rejected with a 400 rather than
@@ -9829,7 +9835,7 @@ export type GetDashboardsData = {
9829
9835
  */
9830
9836
  source?: 'gc-catalog' | 'terraform' | 'regular';
9831
9837
  /**
9832
- * gcQL filter query (filters only, no pipes). Supported keys: name, tags, owner, source, description, team. `status` is also accepted but intentionally not suggested by the filter-bar autocomplete — the status selector owns it via the top-level status param, and the two are ANDed, so a query status that contradicts the param yields an empty list. Unkeyed terms are free text, matched as a case-insensitive substring across name, description, owner and tags.
9838
+ * gcQL filter query (filters only, no pipes). Supported keys: name, tags, owner, source, description, team. `status` and `favorites` (e.g. favorites:true, scoped to the authenticated member) are also accepted but intentionally not suggested by the filter-bar autocomplete — the status selector owns status via the top-level status param (the two are ANDed, so a query status that contradicts the param yields an empty list), and the facet panel owns favorites. Unkeyed terms are free text, matched as a case-insensitive substring across name, description, owner and tags.
9833
9839
  */
9834
9840
  query?: string;
9835
9841
  };