Make index beta

firebase · Aug 5, 2022 · 49a1d12 · 49a1d12
1 parent a80e29c
commit 49a1d12
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/packages/firestore/src/api/index_configuration.ts b/packages/firestore/src/api/index_configuration.ts
@@ -35,8 +35,6 @@ export {
   EmulatorMockTokenOptions
 } from '../lite-api/database';
 
-// TODO(indexing): Remove "@internal" from the API.
-
 /**
  * A single field element in an index configuration.
  */
@@ -64,6 +62,7 @@ export interface IndexField {
 /**
  * The SDK definition of a Firestore index.
  */
+/** @beta */
 export interface Index {
   /** The ID of the collection to index. */
   readonly collectionGroup: string;
@@ -79,6 +78,7 @@ export interface Index {
  * See {@link https://firebase.google.com/docs/reference/firestore/indexes/#json_format | JSON Format}
  * for a description of the format of the index definition.
  */
+/** @beta */
 export interface IndexConfiguration {
   /** A list of all Firestore indexes. */
   readonly indexes?: Index[];
@@ -107,6 +107,7 @@ export interface IndexConfiguration {
  * @returns A `Promise` that resolves once all indices are successfully
  * configured.
  */
+/** @beta */
 export function setIndexConfiguration(
   firestore: Firestore,
   configuration: IndexConfiguration
@@ -137,6 +138,7 @@ export function setIndexConfiguration(
  * @returns A `Promise` that resolves once all indices are successfully
  * configured.
  */
+/** @beta */
 export function setIndexConfiguration(
   firestore: Firestore,
   json: string