update documentation

Azure · May 17, 2024 · b0e7808 · b0e7808
1 parent 8c83a8a
commit b0e7808
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/sdk/cosmosdb/cosmos/review/cosmos.api.md b/sdk/cosmosdb/cosmos/review/cosmos.api.md
@@ -1150,7 +1150,6 @@ export interface IndexingPolicy {
     indexingMode?: keyof typeof IndexingMode;
     // (undocumented)
     spatialIndexes?: SpatialIndex[];
-    // (undocumented)
     vectorIndexes?: VectorIndex[];
 }
 
@@ -1608,7 +1607,6 @@ export interface QueryInfo {
     groupByAliasToAggregateType: GroupByAliasToAggregateType;
     // (undocumented)
     groupByExpressions?: GroupByExpressions;
-    // (undocumented)
     hasNonStreamingOrderBy: boolean;
     // (undocumented)
     hasSelectValue: boolean;

diff --git a/sdk/cosmosdb/cosmos/src/documents/IndexingPolicy.ts b/sdk/cosmosdb/cosmos/src/documents/IndexingPolicy.ts
@@ -11,6 +11,7 @@ export interface IndexingPolicy {
   /** An array of {@link IncludedPath} represents the paths to be excluded for indexing. */
   excludedPaths?: IndexedPath[];
   spatialIndexes?: SpatialIndex[];
+  /** An array of {@link VectorIndex} represents the vector index paths to be included for indexing. */
   vectorIndexes?: VectorIndex[];
 }
 

diff --git a/sdk/cosmosdb/cosmos/src/request/ErrorResponse.ts b/sdk/cosmosdb/cosmos/src/request/ErrorResponse.ts
@@ -45,6 +45,9 @@ export interface QueryInfo {
   rewrittenQuery?: any;
   distinctType: string;
   hasSelectValue: boolean;
+  /**
+   * determines whether the query is of non streaming orderby type.
+   */
   hasNonStreamingOrderBy: boolean;
 }