diff --git a/packages/catalog-client/api-report.md b/packages/catalog-client/api-report.md index f612407b1d..22afa0457e 100644 --- a/packages/catalog-client/api-report.md +++ b/packages/catalog-client/api-report.md @@ -188,6 +188,12 @@ export type EntityOrderQuery = order: 'asc' | 'desc'; }>; +// @public +export type EntitySortField = { + field: string; + order: 'asc' | 'desc'; +}; + // @public export interface GetEntitiesByRefsRequest { entityRefs: string[]; @@ -262,9 +268,8 @@ export type GetPaginatedEntitiesInitialRequest = fields?: string[]; limit?: number; filter?: EntitiesFilter; - sortField?: string; + sortFields?: EntitySortField[]; query?: string; - sortFieldOrder?: 'asc' | 'desc'; } | undefined; diff --git a/packages/catalog-client/src/types/api.ts b/packages/catalog-client/src/types/api.ts index d006a6877c..26c16af64d 100644 --- a/packages/catalog-client/src/types/api.ts +++ b/packages/catalog-client/src/types/api.ts @@ -368,6 +368,8 @@ export type EntitiesFilter = /** * Used for sorting the entities. + * + * @public */ export type EntitySortField = { field: string; order: 'asc' | 'desc' }; diff --git a/packages/catalog-client/src/types/index.ts b/packages/catalog-client/src/types/index.ts index e85b86f4af..61a993eb19 100644 --- a/packages/catalog-client/src/types/index.ts +++ b/packages/catalog-client/src/types/index.ts @@ -26,6 +26,7 @@ export type { GetEntitiesByRefsRequest, GetEntitiesByRefsResponse, EntitiesFilter, + EntitySortField, GetEntitiesRequest, GetEntitiesResponse, GetEntityAncestorsRequest,