Skip to content

Commit 96e5867

Browse files
authored
Merge 49a1d12 into a80e29c
2 parents a80e29c + 49a1d12 commit 96e5867

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

packages/firestore/src/api/index_configuration.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,6 @@ export {
3535
EmulatorMockTokenOptions
3636
} from '../lite-api/database';
3737

38-
// TODO(indexing): Remove "@internal" from the API.
39-
4038
/**
4139
* A single field element in an index configuration.
4240
*/
@@ -64,6 +62,7 @@ export interface IndexField {
6462
/**
6563
* The SDK definition of a Firestore index.
6664
*/
65+
/** @beta */
6766
export interface Index {
6867
/** The ID of the collection to index. */
6968
readonly collectionGroup: string;
@@ -79,6 +78,7 @@ export interface Index {
7978
* See {@link https://firebase.google.com/docs/reference/firestore/indexes/#json_format | JSON Format}
8079
* for a description of the format of the index definition.
8180
*/
81+
/** @beta */
8282
export interface IndexConfiguration {
8383
/** A list of all Firestore indexes. */
8484
readonly indexes?: Index[];
@@ -107,6 +107,7 @@ export interface IndexConfiguration {
107107
* @returns A `Promise` that resolves once all indices are successfully
108108
* configured.
109109
*/
110+
/** @beta */
110111
export function setIndexConfiguration(
111112
firestore: Firestore,
112113
configuration: IndexConfiguration
@@ -137,6 +138,7 @@ export function setIndexConfiguration(
137138
* @returns A `Promise` that resolves once all indices are successfully
138139
* configured.
139140
*/
141+
/** @beta */
140142
export function setIndexConfiguration(
141143
firestore: Firestore,
142144
json: string

0 commit comments

Comments
 (0)