diff --git a/packages/catalog-client/api-report.md b/packages/catalog-client/api-report.md index 47c6ff7f36..2e6b5b9203 100644 --- a/packages/catalog-client/api-report.md +++ b/packages/catalog-client/api-report.md @@ -58,7 +58,6 @@ export interface CatalogApi { locationRef: string, options?: CatalogRequestOptions, ): Promise; - // @alpha getPaginatedEntities?( request?: GetPaginatedEntitiesRequest, options?: CatalogRequestOptions, @@ -243,14 +242,14 @@ export interface GetEntityFacetsResponse { >; } -// @alpha +// @public export type GetPaginatedEntitiesCursorRequest = { fields?: string[]; limit?: number; cursor: string; }; -// @alpha +// @public export type GetPaginatedEntitiesInitialRequest = { fields?: string[]; limit?: number; @@ -259,12 +258,12 @@ export type GetPaginatedEntitiesInitialRequest = { query?: string; }; -// @alpha +// @public export type GetPaginatedEntitiesRequest = | GetPaginatedEntitiesInitialRequest | GetPaginatedEntitiesCursorRequest; -// @alpha +// @public export type GetPaginatedEntitiesResponse = { entities: Entity[]; totalItems: number; diff --git a/packages/catalog-client/src/CatalogClient.ts b/packages/catalog-client/src/CatalogClient.ts index 7347535ca6..dca46c3ab6 100644 --- a/packages/catalog-client/src/CatalogClient.ts +++ b/packages/catalog-client/src/CatalogClient.ts @@ -207,8 +207,6 @@ export class CatalogClient implements CatalogApi { /** * {@inheritdoc CatalogApi.getPaginatedEntities} - * - * @alpha */ async getPaginatedEntities?( request: GetPaginatedEntitiesRequest = {}, diff --git a/packages/catalog-client/src/types/api.ts b/packages/catalog-client/src/types/api.ts index 4e7f679072..0f0d0fe63c 100644 --- a/packages/catalog-client/src/types/api.ts +++ b/packages/catalog-client/src/types/api.ts @@ -380,7 +380,7 @@ export type ValidateEntityResponse = /** * The request type for {@link CatalogClient.getPaginatedEntities}. * - * @alpha + * @public */ export type GetPaginatedEntitiesRequest = | GetPaginatedEntitiesInitialRequest @@ -394,7 +394,7 @@ export type GetPaginatedEntitiesRequest = * The properties filter, sortField, query and sortFieldOrder, are going * to be immutable for the entire lifecycle of the following requests. * - * @alpha + * @public */ export type GetPaginatedEntitiesInitialRequest = { fields?: string[]; @@ -409,7 +409,7 @@ export type GetPaginatedEntitiesInitialRequest = { * The method takes this type in a pagination request, following * the initial request. * - * @alpha + * @public */ export type GetPaginatedEntitiesCursorRequest = { fields?: string[]; @@ -420,7 +420,7 @@ export type GetPaginatedEntitiesCursorRequest = { /** * The response type for {@link CatalogClient.getPaginatedEntities}. * - * @alpha + * @public */ export type GetPaginatedEntitiesResponse = { /* The list of entities for the current request */ @@ -503,7 +503,7 @@ export interface CatalogApi { * with a prev function useful for navigating backwards and a next function * in case more entities matching the filters of the first request are present in the catalog. * - * @alpha + * @public * * @param request - Request parameters * @param options - Additional options