PR remarks

elastic · Aug 14, 2023 · d7d5476 · d7d5476
1 parent 5195b1f
commit d7d5476
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 6 deletions.
diff --git a/specification/_spec_utils/FlagsEnum.ts → ...ication/_spec_utils/PipeSeparatedFlags.ts b/specification/_spec_utils/FlagsEnum.ts → ...ication/_spec_utils/PipeSeparatedFlags.ts
@@ -18,10 +18,10 @@
  */
 
 /**
- * This type type marks the underlaying enum as a "flags enum". Individual members of flags enums
- * are combined using the pipe separator ("A|B|C|...").
+ * A set of flags that can be represented as a single enum value or a set of values that are encoded
+ * as a pipe-separated string
  *
  * Depending on the target language, code generators can use this hint to generate language specific
  * flags enum constructs and the corresponding (de-)serialization code.
  */
-export type FlagsEnum<T> = T
+export type PipeSeparatedFlags<T> = T | string
diff --git a/specification/_types/query_dsl/fulltext.ts b/specification/_types/query_dsl/fulltext.ts
@@ -29,7 +29,7 @@ import { Script } from '@_types/Scripting'
 import { QueryBase } from './abstractions'
 import { Operator } from './Operator'
 import { DateMath, TimeZone } from '@_types/Time'
-import { FlagsEnum } from '@spec_utils/FlagsEnum'
+import { FlagsEnum, PipeSeparatedFlags } from '@spec_utils/PipeSeparatedFlags'
 
 /**
  * @shortcut_property query
@@ -703,7 +703,7 @@ export class QueryStringQuery extends QueryBase {
  * Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`
  * @doc_id supported-flags
  */
-export type SimpleQueryStringFlags = FlagsEnum<SimpleQueryStringFlag[]>
+export type SimpleQueryStringFlags = PipeSeparatedFlags<SimpleQueryStringFlag>
 
 export enum SimpleQueryStringFlag {
   /**
@@ -722,7 +722,6 @@ export enum SimpleQueryStringFlag {
    * Enables the `\|` OR operator.
    */
   OR = 1 << 2,
-
   /**
    * Enables the `*` prefix operator.
    */