From c015e5446dbeccfa4d63a4a6f46d06add74deb8b Mon Sep 17 00:00:00 2001 From: Bailey Pearson Date: Mon, 26 Jun 2023 08:23:47 -0600 Subject: [PATCH] feat(NODE-5319): mark search index api public (#3741) --- src/collection.ts | 12 ------------ src/cursor/list_search_indexes_cursor.ts | 4 ++-- src/operations/search_indexes/create.ts | 6 ++++-- 3 files changed, 6 insertions(+), 16 deletions(-) diff --git a/src/collection.ts b/src/collection.ts index e74e5bcb6e..941618f4e7 100644 --- a/src/collection.ts +++ b/src/collection.ts @@ -1050,8 +1050,6 @@ export class Collection { } /** - * @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 { */ 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 { } /** - * @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 { } /** - * @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 { } /** - * @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 { } /** - * @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 index 285af02ef3..bf5a0b5612 100644 --- 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 index cce926de88..c7260cedd5 100644 --- 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 */