@groundcover/api-client 0.15.0 → 0.16.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.
@@ -2258,8 +2258,8 @@ export type DashboardFiltersRequest = {
2258
2258
  */
2259
2259
  query?: string;
2260
2260
  /**
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
2261
+ * Optional list of facet keys (owner, tags, source, favorites) that must
2262
+ * appear in the response even when the filtered set produces no values for them — each such
2263
2263
  * key comes back as an empty list instead of being omitted from the map. This
2264
2264
  * only guarantees presence: every facet is computed regardless of what is listed
2265
2265
  * here. Keys outside the supported facet set are rejected with a 400 rather than
@@ -9104,7 +9104,7 @@ export type GetDashboardsData = {
9104
9104
  */
9105
9105
  source?: 'gc-catalog' | 'terraform' | 'regular';
9106
9106
  /**
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.
9107
+ * 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
9108
  */
9109
9109
  query?: string;
9110
9110
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@groundcover/api-client",
3
- "version": "0.15.0",
3
+ "version": "0.16.0",
4
4
  "description": "groundcover TypeScript API Client",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -2409,8 +2409,8 @@ export type DashboardFiltersRequest = {
2409
2409
  */
2410
2410
  query?: string;
2411
2411
  /**
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
2412
+ * Optional list of facet keys (owner, tags, source, favorites) that must
2413
+ * appear in the response even when the filtered set produces no values for them — each such
2414
2414
  * key comes back as an empty list instead of being omitted from the map. This
2415
2415
  * only guarantees presence: every facet is computed regardless of what is listed
2416
2416
  * here. Keys outside the supported facet set are rejected with a 400 rather than
@@ -9829,7 +9829,7 @@ export type GetDashboardsData = {
9829
9829
  */
9830
9830
  source?: 'gc-catalog' | 'terraform' | 'regular';
9831
9831
  /**
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.
9832
+ * 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
9833
  */
9834
9834
  query?: string;
9835
9835
  };