Improve Analyzer definitions and fix various classes (#3215)

Author: flobernd

output/schema/schema.json

@@ -36,21 +36,42 @@ export class CustomAnalyzer {
 
 export class FingerprintAnalyzer {
   type: 'fingerprint'
+  /** @deprecated 7.14.0 */
   version?: VersionString
-  max_output_size: integer
-  preserve_original: boolean
-  separator: string
-  stopwords?: StopWords
+  /**
+   * The maximum token size to emit. Tokens larger than this size will be discarded.
+   * Defaults to `255`
+   *
+   * @server_default 255
+   */
+  max_output_size?: integer
+  /**
+   * The character to use to concatenate the terms.
+   * Defaults to a space.
+   */
+  separator?: string
+  /**
+   * A pre-defined stop words list like `_english_` or an array containing a list of stop words.
+   * Defaults to `_none_`.
+   *
+   * @server_default _none_
+   */
+  stopwords?: StopWords
+  /**
+   * The path to a file containing stop words.
+   */
   stopwords_path?: string
 }
 
 export class KeywordAnalyzer {
   type: 'keyword'
+  /** @deprecated 7.14.0 */
   version?: VersionString
 }
 
 export class LanguageAnalyzer {
   type: 'language'
+  /** @deprecated 7.14.0 */
   version?: VersionString
   language: Language
   stem_exclusion: string[]
@@ -311,6 +332,7 @@ export class ThaiAnalyzer {
 
 export class NoriAnalyzer {
   type: 'nori'
+  /** @deprecated 7.14.0 */
   version?: VersionString
   decompound_mode?: NoriDecompoundMode
   stoptags?: string[]
@@ -319,40 +341,96 @@ export class NoriAnalyzer {
 
 export class PatternAnalyzer {
   type: 'pattern'
+  /** @deprecated 7.14.0 */
   version?: VersionString
-  flags?: string
+  /**
+   * Java regular expression flags. Flags should be pipe-separated, eg "CASE_INSENSITIVE|COMMENTS".
+   */
+  flags?: string // TODO: Use PipeSeparatedFlags<T> and proper enum
+  /**
+   * Should terms be lowercased or not.
+   * Defaults to `true`.
+   *
+   * @server_default true
+   */
   lowercase?: boolean
-  pattern: string
-  stopwords?: StopWords
+  /**
+   * A Java regular expression.
+   * Defaults to `\W+`.
+   *
+   * @server_default \W+
+   */
+  pattern?: string
+  /**
+   * A pre-defined stop words list like `_english_` or an array containing a list of stop words.
+   * Defaults to `_none_`.
+   *
+   * @server_default _none_
+   */
+  stopwords?: StopWords
+  /**
+   * The path to a file containing stop words.
+   */
+  stopwords_path?: string
 }
 
 export class SimpleAnalyzer {
   type: 'simple'
+  /** @deprecated 7.14.0 */
   version?: VersionString
 }
 
+// TODO: This one seems undocumented!?
 export class SnowballAnalyzer {
   type: 'snowball'
+  /** @deprecated 7.14.0 */
   version?: VersionString
   language: SnowballLanguage
   stopwords?: StopWords
 }
 
 export class StandardAnalyzer {
   type: 'standard'
+  /**
+   * The maximum token length. If a token is seen that exceeds this length then it is split at `max_token_length` intervals.
+   * Defaults to `255`.
+   *
+   * @server_default 255
+   */
   max_token_length?: integer
+  /**
+   * A pre-defined stop words list like `_english_` or an array containing a list of stop words.
+   * Defaults to `_none_`.
+   *
+   * @server_default _none_
+   */
   stopwords?: StopWords
+  /**
+   * The path to a file containing stop words.
+   */
+  stopwords_path?: string
 }
 
 export class StopAnalyzer {
   type: 'stop'
+  /** @deprecated 7.14.0 */
   version?: VersionString
+  /**
+   * A pre-defined stop words list like `_english_` or an array containing a list of stop words.
+   * Defaults to `_none_`.
+   *
+   * @server_default _none_
+   */
   stopwords?: StopWords
+  /**
+   * The path to a file containing stop words.
+   */
   stopwords_path?: string
 }
 
 export class WhitespaceAnalyzer {
   type: 'whitespace'
+  /** @deprecated 7.14.0 */
   version?: VersionString
 }
 

output/typescript/types.ts

@@ -18,7 +18,7 @@
  */
 
 import { SingleKeyDictionary } from '@spec_utils/Dictionary'
-import { Field } from '@_types/common'
+import { Field, FieldValue } from '@_types/common'
 import { integer } from '@_types/Numeric'
 import { QueryBase, QueryContainer } from './abstractions'
 
@@ -136,7 +136,8 @@ export class SpanOrQuery extends QueryBase {
  * @ext_doc_id query-dsl-span-term-query
  */
 export class SpanTermQuery extends QueryBase {
-  value: string
+  /** @aliases term */
+  value: FieldValue
 }
 
 /**

specification/_types/analysis/analyzers.ts

@@ -274,7 +274,7 @@ export class PinnedDoc {
   /**
    * The index that contains the document.
    */
-  _index: IndexName
+  _index?: IndexName
 }
 
 export class RankFeatureFunction {}

specification/_types/query_dsl/span.ts

@@ -28,7 +28,7 @@ export class Hop {
   /**
    * An optional guiding query that constrains the Graph API as it explores connected terms.
    */
-  query: QueryContainer
+  query?: QueryContainer
   /**
    * Contains the fields you are interested in.
    */

specification/_types/query_dsl/specialized.ts

@@ -58,7 +58,8 @@ export class VertexDefinition {
   size?: integer
 }
 
+/** @shortcut_property term */
 export class VertexInclude {
-  boost: double
+  boost?: double
   term: string
 }

specification/graph/_types/Hop.ts

@@ -22,6 +22,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
 import { Field, Fields, GrokPattern, Id, Name } from '@_types/common'
 import { GeoShapeRelation } from '@_types/Geo'
 import { double, integer, long } from '@_types/Numeric'
+import { Script } from '@_types/Scripting'
 import { SortOrder } from '@_types/sort'
 
 /**
@@ -309,7 +310,7 @@ export class ProcessorBase {
   /**
    * Conditionally execute the processor.
    */
-  if?: string
+  if?: Script
   /**
    * Ignore failures for the processor.
    */
@@ -731,7 +732,7 @@ export class DateIndexNameProcessor extends ProcessorBase {
    * An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.
    * Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.
    */
-  date_formats: string[]
+  date_formats?: string[]
   /**
    * How to round the date when formatting the date into the index name. Valid values are:
    * `y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second).

specification/graph/_types/Vertex.ts

@@ -238,9 +238,9 @@ export class DataframeAnalysisClassification extends DataframeAnalysis {
 /** @shortcut_property includes */
 export class DataframeAnalysisAnalyzedFields {
   /** An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically. */
-  includes: string[]
+  includes?: string[]
   /** An array of strings that defines the fields that will be included in the analysis. */
-  excludes: string[]
+  excludes?: string[]
 }
 
 /** @variants container */

specification/ingest/_types/Processors.ts

@@ -46,7 +46,7 @@ export class AzureRepository extends RepositoryBase {
   /**
    * The repository settings.
    */
-  settings: AzureRepositorySettings
+  settings?: AzureRepositorySettings
 }
 
 export class GcsRepository extends RepositoryBase {