feat(NODE-5319): mark search index api public (#3741)

mongodb · Jun 26, 2023 · c015e54 · c015e54
1 parent d8a5271
commit c015e54
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 16 deletions.
diff --git a/src/collection.ts b/src/collection.ts
@@ -1050,8 +1050,6 @@ export class Collection<TSchema extends Document = Document> {
   }
 
   /**
-   * @internal
-   *
    * Returns all search indexes for the current collection.
    *
    * @param options - The options for the list indexes operation.
@@ -1060,8 +1058,6 @@ export class Collection<TSchema extends Document = Document> {
    */
   listSearchIndexes(options?: ListSearchIndexesOptions): ListSearchIndexesCursor;
   /**
-   * @internal
-   *
    * Returns all search indexes for the current collection.
    *
    * @param name - The name of the index to search for.  Only indexes with matching index names will be returned.
@@ -1087,8 +1083,6 @@ export class Collection<TSchema extends Document = Document> {
   }
 
   /**
-   * @internal
-   *
    * Creates a single search index for the collection.
    *
    * @param description - The index description for the new search index.
@@ -1102,8 +1096,6 @@ export class Collection<TSchema extends Document = Document> {
   }
 
   /**
-   * @internal
-   *
    * Creates multiple search indexes for the current collection.
    *
    * @param descriptions - An array of `SearchIndexDescription`s for the new search indexes.
@@ -1120,8 +1112,6 @@ export class Collection<TSchema extends Document = Document> {
   }
 
   /**
-   * @internal
-   *
    * Deletes a search index by index name.
    *
    * @param name - The name of the search index to be deleted.
@@ -1136,8 +1126,6 @@ export class Collection<TSchema extends Document = Document> {
   }
 
   /**
-   * @internal
-   *
    * Updates a search index by replacing the existing index definition with the provided definition.
    *
    * @param name - The name of the search index to update.

diff --git a/src/cursor/list_search_indexes_cursor.ts b/src/cursor/list_search_indexes_cursor.ts
@@ -2,10 +2,10 @@ import type { Collection } from '../collection';
 import type { AggregateOptions } from '../operations/aggregate';
 import { AggregationCursor } from './aggregation_cursor';
 
-/** @internal */
+/** @public */
 export type ListSearchIndexesOptions = AggregateOptions;
 
-/** @internal */
+/** @public */
 export class ListSearchIndexesCursor extends AggregationCursor<{ name: string }> {
   /** @internal */
   constructor(

diff --git a/src/operations/search_indexes/create.ts b/src/operations/search_indexes/create.ts
@@ -6,13 +6,15 @@ import type { ClientSession } from '../../sessions';
 import type { Callback } from '../../utils';
 import { AbstractOperation } from '../operation';
 
-/** @internal */
+/**
+ * @public
+ */
 export interface SearchIndexDescription {
   /** The name of the index. */
   name?: string;
 
   /** The index definition. */
-  description: Document;
+  definition: Document;
 }
 
 /** @internal */