Fix suggest results that are a typed-key union type (#1301) (#1310)

Author: swallez

output/schema/validation-errors.json

@@ -32,42 +32,43 @@ import { GeoHash, GeoHashPrecision, GeoLocation } from '@_types/Geo'
 import { double, float, integer, long } from '@_types/Numeric'
 import { AdditionalProperties } from '@spec_utils/behaviors'
 
-export class Suggest<T> {
+/**
+ * @variants external
+ */
+export type Suggest<TDocument> =
+  | CompletionSuggest<TDocument>
+  | PhraseSuggest
+  | TermSuggest
+
+export class SuggestBase {
   length: integer
   offset: integer
-  options: SuggestOption<T>[]
   text: string
 }
 
-export class Suggester implements AdditionalProperties<string, FieldSuggester> {
-  /** Global suggest text, to avoid repetition when the same text is used in several suggesters */
-  text?: string
+/**
+ * @variant name=completion
+ */
+export class CompletionSuggest<TDocument> extends SuggestBase {
+  options: CompletionSuggestOption<TDocument>[]
 }
 
 /**
- * @variants container
+ * @variant name=phrase
  */
-export class FieldSuggester {
-  completion?: CompletionSuggester
-  phrase?: PhraseSuggester
-  prefix?: string
-  regex?: string
-  term?: TermSuggester
-  text?: string
+export class PhraseSuggest extends SuggestBase {
+  options: PhraseSuggestOption
 }
 
-export class SuggesterBase {
-  field: Field
-  analyzer?: string
-  size?: integer
+/**
+ * @variant name=term
+ */
+export class TermSuggest extends SuggestBase {
+  options: TermSuggestOption
 }
 
-/** @codegen_names completion, phrase, term */
-export type SuggestOption<TDocument> =
-  | CompletionSuggestOption<TDocument>
-  | PhraseSuggestOption
-  | TermSuggestOption
-
+// In the ES code a nested Hit object is expanded inline. Not all Hit fields have been
+// added below as many do not make sense in the context of a suggestion.
 export class CompletionSuggestOption<TDocument> {
   collate_match?: boolean
   contexts?: Dictionary<string, Context[]>
@@ -76,8 +77,8 @@ export class CompletionSuggestOption<TDocument> {
   _index: IndexName
   _type?: Type
   _routing?: Routing
-  _score: double
-  _source: TDocument
+  _score?: double
+  _source?: TDocument
   text: string
 }
 
@@ -89,10 +90,33 @@ export class PhraseSuggestOption {
 
 export class TermSuggestOption {
   text: string
-  freq?: long
+  freq: long
   score: double
 }
 
+export class Suggester implements AdditionalProperties<string, FieldSuggester> {
+  /** Global suggest text, to avoid repetition when the same text is used in several suggesters */
+  text?: string
+}
+
+/**
+ * @variants container
+ */
+export class FieldSuggester {
+  completion?: CompletionSuggester
+  phrase?: PhraseSuggester
+  prefix?: string
+  regex?: string
+  term?: TermSuggester
+  text?: string
+}
+
+export class SuggesterBase {
+  field: Field
+  analyzer?: string
+  size?: integer
+}
+
 // completion suggester
 
 export class CompletionSuggester extends SuggesterBase {