Start of fixes for core/search (#1947) (#1957)

Co-authored-by: Seth Michael Larson <[email protected]>

Author: swallez

output/schema/schema.json

@@ -29,18 +29,49 @@ import { QueryContainer } from '@_types/query_dsl/abstractions'
  */
 export interface Request extends RequestBase {
   path_parts: {
+    /**
+     * Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.
+     */
     index?: Indices
   }
   query_parameters: {
+    /**
+     * If false, the request returns an error if any wildcard expression, index alias,
+     * or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request
+     * targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar.
+     * @server_default true
+     */
     allow_no_indices?: boolean
+    /**
+     * Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.
+     * @server_default open
+     */
     expand_wildcards?: ExpandWildcards
-    fields: Fields
+    /**
+     * Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.
+     */
+    fields?: Fields
+    /**
+     * If `true`, missing or closed indices are not included in the response.
+     * @server_default false
+     */
     ignore_unavailable?: boolean
+    /**
+     * If true, unmapped fields are included in the response.
+     * @server_default false
+     */
     include_unmapped?: boolean
   }
   body: {
+    /**
+     * Allows to filter indices if the provided query rewrites to match_none on every shard.
+     */
     index_filter?: QueryContainer
-    /** @since 7.12.0 */
+    /**
+     * Defines ad-hoc runtime fields in the request similar to the way it is done in search requests.
+     * These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.
+     * @since 7.12.0
+     */
     runtime_mappings?: RuntimeFields
   }
 }

output/typescript/types.ts

@@ -22,6 +22,7 @@ import { Field, Fields } from '@_types/common'
 import { integer } from '@_types/Numeric'
 import { QueryContainer } from '@_types/query_dsl/abstractions'
 import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
+import { Analyzer } from '@_types/analysis/analyzers'
 
 export enum BoundaryScanner {
   chars = 0,
@@ -89,4 +90,5 @@ export enum BuiltinHighlighterType {
 export class HighlightField extends HighlightBase {
   fragment_offset?: integer
   matched_fields?: Fields
+  analyzer?: Analyzer
 }

specification/_global/field_caps/FieldCapabilitiesRequest.ts

@@ -40,6 +40,10 @@ import { Sort, SortResults } from '@_types/sort'
 
 export class Hit<TDocument> {
   _index: IndexName
+  /**
+   * @es_quirk '_id' is not available when using 'stored_fields: _none_'
+   * on a search request. Otherwise the field is always present on hits.
+   */
   _id: Id
 
   _score?: double

specification/_global/search/_types/highlighting.ts

@@ -147,6 +147,8 @@ export class FetchProfile {
 }
 
 export class FetchProfileBreakdown {
+  load_source?: integer
+  load_source_count?: integer
   load_stored_fields?: integer
   load_stored_fields_count?: integer
   next_reader?: integer

specification/_global/search/_types/hits.ts

@@ -41,12 +41,16 @@ export class NodeAttributes {
   /** The ephemeral ID of the node. */
   ephemeral_id: Id
   /** The unique identifier of the node. */
-  id?: Id
+  id?: NodeId
   /** The unique identifier of the node. */
   name: NodeName
   /** The host and port where transport HTTP connections are accepted. */
   transport_address: TransportAddress
   roles?: NodeRoles
+  /**
+   * @since 8.3.0
+   */
+  external_id: string
 }
 
 export class NodeShard {

specification/_global/search/_types/profile.ts

@@ -17,11 +17,11 @@
  * under the License.
  */
 
-import { Field } from './common'
+import { Field, Id } from './common'
 import { integer } from './Numeric'
 
 export class SlicedScroll {
   field?: Field
-  id: integer
+  id: Id
   max: integer
 }

specification/_types/Node.ts

@@ -561,9 +561,15 @@ export class AdjacencyMatrixBucket extends MultiBucketBase {
   key: string
 }
 
+export class SignificantTermsAggregateBase<
+  T
+> extends MultiBucketAggregateBase<T> {
+  bg_count: long
+}
+
 /** @variant name=siglterms */
 // ES: SignificantLongTerms & InternalSignificantTerms
-export class SignificantLongTermsAggregate extends MultiBucketAggregateBase<SignificantLongTermsBucket> {}
+export class SignificantLongTermsAggregate extends SignificantTermsAggregateBase<SignificantLongTermsBucket> {}
 
 export class SignificantTermsBucketBase extends MultiBucketBase {
   score: double
@@ -577,10 +583,7 @@ export class SignificantLongTermsBucket extends SignificantTermsBucketBase {
 
 /** @variant name=sigsterms */
 // ES: SignificantStringTerms & InternalSignificantTerms
-export class SignificantStringTermsAggregate extends MultiBucketAggregateBase<SignificantStringTermsBucket> {
-  bg_count?: long
-  doc_count?: long
-}
+export class SignificantStringTermsAggregate extends SignificantTermsAggregateBase<SignificantStringTermsBucket> {}
 
 export class SignificantStringTermsBucket extends SignificantTermsBucketBase {
   key: string
@@ -592,7 +595,7 @@ export class SignificantStringTermsBucket extends SignificantTermsBucketBase {
  */
 // ES: UnmappedSignificantTerms
 // See note in UnmappedTermsAggregate
-export class UnmappedSignificantTermsAggregate extends MultiBucketAggregateBase<Void> {}
+export class UnmappedSignificantTermsAggregate extends SignificantTermsAggregateBase<Void> {}
 
 /** @variant name=composite */
 // Note: no keyed variant

specification/_types/SlicedScroll.ts

@@ -18,8 +18,9 @@
  */
 
 import { AdditionalProperty } from '@spec_utils/behaviors'
+import { Dictionary } from '@spec_utils/Dictionary'
 import { Missing } from '@_types/aggregations/AggregationContainer'
-import { Field } from '@_types/common'
+import { Field, FieldValue } from '@_types/common'
 import { DistanceUnit, GeoDistanceType, GeoLocation } from '@_types/Geo'
 import { FieldType } from '@_types/mapping/Property'
 import { double, integer, long } from '@_types/Numeric'
@@ -74,7 +75,8 @@ export class ScriptSort {
 
 export enum ScriptSortType {
   string,
-  number
+  number,
+  version
 }
 
 /**
@@ -96,7 +98,7 @@ export type SortCombinations = Field | SortOptions
 
 export type Sort = SortCombinations | SortCombinations[]
 
-export type SortResults = Array<long | double | string | null>
+export type SortResults = FieldValue[]
 
 /**
  * Defines what values to pick in the case a document contains multiple values for a particular field.