From 88740bed619452c57853fe13ee5d2c041a187f10 Mon Sep 17 00:00:00 2001
From: Vincenzo Scamporlino <vincenzos@spotify.com>
Date: Fri, 3 Feb 2023 14:05:49 +0100
Subject: [PATCH] catalog-client: improve queryEntities example

Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
---
 packages/catalog-client/src/types/api.ts | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/packages/catalog-client/src/types/api.ts b/packages/catalog-client/src/types/api.ts
index 963e0521a0..ee6579efca 100644
--- a/packages/catalog-client/src/types/api.ts
+++ b/packages/catalog-client/src/types/api.ts
@@ -477,14 +477,16 @@ export interface CatalogApi {
    *
    * @remarks
    *
-   * Example:
+   * @example
    *
    * ```
    * const response = await catalogClient.queryEntities({
    *   filter: [{ kind: 'group' }],
    *   limit: 20,
-   *   query: 'A',
-   *   sortFields: { field: 'metadata.name' order: 'asc' },
+   *   fullTextFilter: {
+   *     term: 'A',
+   *   }
+   *   orderFields: { field: 'metadata.name' order: 'asc' },
    * });
    * ```
    *