catalog-client: improve queryEntities example

Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2023-02-03 14:05:49 +01:00
parent 8c030b1826
commit 88740bed61
1 changed files with 5 additions and 3 deletions
@@ -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' },
   * });
   * ```
   *