Skip to content

Commit dca7e08

Browse files
feat(data-fabric): mark query API as experimental
Add @experimental JSDoc tag and preview warning to all new query types, enums, and methods following the pattern from PR #328. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent b08a5c3 commit dca7e08

3 files changed

Lines changed: 98 additions & 0 deletions

File tree

src/models/data-fabric/entities.models.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -465,6 +465,13 @@ export interface EntityServiceModel {
465465
deleteAttachment(entityId: string, recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
466466

467467
/**
468+
*
469+
* @experimental
470+
*
471+
* /// warning
472+
Preview: This method is experimental and may change or be removed in future releases.
473+
///
474+
*
468475
* Queries an entity by name with support for joins, aggregates, filters, grouping, and sorting
469476
*
470477
* @param entityName - Name of the entity to query
@@ -626,6 +633,13 @@ export interface EntityMethods {
626633
deleteAttachment(recordId: string, fieldName: string): Promise<EntityDeleteAttachmentResponse>;
627634

628635
/**
636+
*
637+
* @experimental
638+
*
639+
* /// warning
640+
Preview: This method is experimental and may change or be removed in future releases.
641+
///
642+
*
629643
* Queries this entity with support for joins, aggregates, filters, grouping, and sorting
630644
*
631645
* @param options - Query options

src/models/data-fabric/entities.types.ts

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,13 @@ export interface EntityUpdateResponse extends EntityOperationResponse {}
192192
export interface EntityDeleteResponse extends EntityOperationResponse {}
193193

194194
/**
195+
*
196+
* @experimental
197+
*
198+
* /// warning
199+
Preview: This type is experimental and may change or be removed in future releases.
200+
///
201+
*
195202
* Aggregate function types for query operations
196203
*/
197204
export enum QueryAggregateFunction {
@@ -203,6 +210,13 @@ export enum QueryAggregateFunction {
203210
}
204211

205212
/**
213+
*
214+
* @experimental
215+
*
216+
* /// warning
217+
Preview: This type is experimental and may change or be removed in future releases.
218+
///
219+
*
206220
* Join types for cross-entity query operations
207221
*/
208222
export enum QueryJoinType {
@@ -213,6 +227,13 @@ export enum QueryJoinType {
213227
}
214228

215229
/**
230+
*
231+
* @experimental
232+
*
233+
* /// warning
234+
Preview: This type is experimental and may change or be removed in future releases.
235+
///
236+
*
216237
* Logical operators for combining query filters
217238
*/
218239
export enum QueryLogicalOperator {
@@ -221,6 +242,13 @@ export enum QueryLogicalOperator {
221242
}
222243

223244
/**
245+
*
246+
* @experimental
247+
*
248+
* /// warning
249+
Preview: This type is experimental and may change or be removed in future releases.
250+
///
251+
*
224252
* An aggregate operation in a query
225253
*/
226254
export interface QueryAggregate {
@@ -233,6 +261,13 @@ export interface QueryAggregate {
233261
}
234262

235263
/**
264+
*
265+
* @experimental
266+
*
267+
* /// warning
268+
Preview: This type is experimental and may change or be removed in future releases.
269+
///
270+
*
236271
* A join condition for cross-entity queries
237272
*/
238273
export interface QueryJoinCondition {
@@ -243,6 +278,13 @@ export interface QueryJoinCondition {
243278
}
244279

245280
/**
281+
*
282+
* @experimental
283+
*
284+
* /// warning
285+
Preview: This type is experimental and may change or be removed in future releases.
286+
///
287+
*
246288
* A join clause for cross-entity queries
247289
*/
248290
export interface QueryJoin {
@@ -255,6 +297,13 @@ export interface QueryJoin {
255297
}
256298

257299
/**
300+
*
301+
* @experimental
302+
*
303+
* /// warning
304+
Preview: This type is experimental and may change or be removed in future releases.
305+
///
306+
*
258307
* A single query filter condition
259308
*/
260309
export interface QueryFilter {
@@ -267,6 +316,13 @@ export interface QueryFilter {
267316
}
268317

269318
/**
319+
*
320+
* @experimental
321+
*
322+
* /// warning
323+
Preview: This type is experimental and may change or be removed in future releases.
324+
///
325+
*
270326
* A group of query filters combined with a logical operator
271327
*/
272328
export interface QueryFilterGroup {
@@ -279,6 +335,13 @@ export interface QueryFilterGroup {
279335
}
280336

281337
/**
338+
*
339+
* @experimental
340+
*
341+
* /// warning
342+
Preview: This type is experimental and may change or be removed in future releases.
343+
///
344+
*
282345
* Sort option for query results
283346
*/
284347
export interface QuerySortOption {
@@ -289,6 +352,13 @@ export interface QuerySortOption {
289352
}
290353

291354
/**
355+
*
356+
* @experimental
357+
*
358+
* /// warning
359+
Preview: This type is experimental and may change or be removed in future releases.
360+
///
361+
*
292362
* Options for querying an entity with joins, aggregates, and filters
293363
*/
294364
export interface EntityQueryOptions {
@@ -311,6 +381,13 @@ export interface EntityQueryOptions {
311381
}
312382

313383
/**
384+
*
385+
* @experimental
386+
*
387+
* /// warning
388+
Preview: This type is experimental and may change or be removed in future releases.
389+
///
390+
*
314391
* Response from a query operation
315392
*/
316393
export interface EntityQueryResponse {

src/services/data-fabric/entities.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -577,6 +577,13 @@ export class EntityService extends BaseService implements EntityServiceModel {
577577
}
578578

579579
/**
580+
*
581+
* @experimental
582+
*
583+
* /// warning
584+
Preview: This method is experimental and may change or be removed in future releases.
585+
///
586+
*
580587
* Queries an entity by name with support for joins, aggregates, filters, grouping, and sorting
581588
*
582589
* @param entityName - Name of the entity to query

0 commit comments

Comments
 (0)