Correct index settings types (#684)

* Correct index settings types Signed-off-by: Thomas Farr <[email protected]> * lint fix Signed-off-by: Thomas Farr <[email protected]> * Don't fail-fast on test spec Signed-off-by: Thomas Farr <[email protected]> * Fix tests Signed-off-by: Thomas Farr <[email protected]> * Fix tests Signed-off-by: Thomas Farr <[email protected]> * changelog Signed-off-by: Thomas Farr <[email protected]> --------- Signed-off-by: Thomas Farr <[email protected]>
opensearch-project · Nov 21, 2024 · 7e4e18e · 7e4e18e
1 parent e3dcb7a
commit 7e4e18e
Show file tree

Hide file tree

Showing 7 changed files with 281 additions and 104 deletions.
diff --git a/.github/workflows/test-spec.yml b/.github/workflows/test-spec.yml
@@ -21,6 +21,7 @@ on:
 jobs:
   test-opensearch-spec:
     strategy:
+      fail-fast: false
       matrix:
         entry:
           - version: 1.3.17

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -36,6 +36,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Fixed `ml._common.yaml#SearchModelsResponse` and `SearchModelsHitsHit` ([#672](https://github.com/opensearch-project/opensearch-api-specification/pull/672))
 - Fixed `refresh` options to allow `boolean` and `string` ([#673](https://github.com/opensearch-project/opensearch-api-specification/pull/673))
 - Fixed `value` type in `ExplanationDetail` and added `_type` to `explain@200` ([#685](https://github.com/opensearch-project/opensearch-api-specification/pull/685))
+- Fixed index settings types ([#684](https://github.com/opensearch-project/opensearch-api-specification/pull/684))
 
 ### Changed
 - Changed `tasks._common:TaskInfo` and `tasks._common:TaskGroup` to be composed of a `tasks._common:TaskInfoBase` ([#683](https://github.com/opensearch-project/opensearch-api-specification/pull/683))

diff --git a/spec/schemas/_common.analysis.yaml b/spec/schemas/_common.analysis.yaml
@@ -549,7 +549,7 @@ components:
               enum:
                 - asciifolding
             preserve_original:
-              $ref: '_common.yaml#/components/schemas/Stringifiedboolean'
+              $ref: '_common.yaml#/components/schemas/StringifiedBoolean'
           required:
             - type
     TokenFilterBase:
@@ -634,7 +634,7 @@ components:
             side:
               $ref: '#/components/schemas/EdgeNGramSide'
             preserve_original:
-              $ref: '_common.yaml#/components/schemas/Stringifiedboolean'
+              $ref: '_common.yaml#/components/schemas/StringifiedBoolean'
           required:
             - type
     EdgeNGramSide:
@@ -658,7 +658,7 @@ components:
             articles_path:
               type: string
             articles_case:
-              $ref: '_common.yaml#/components/schemas/Stringifiedboolean'
+              $ref: '_common.yaml#/components/schemas/StringifiedBoolean'
           required:
             - type
     FingerprintTokenFilter:
@@ -828,7 +828,7 @@ components:
             consume_all_tokens:
               type: boolean
             max_token_count:
-              $ref: '_common.yaml#/components/schemas/Stringifiedinteger'
+              $ref: '_common.yaml#/components/schemas/StringifiedInteger'
           required:
             - type
     LowercaseTokenFilter:
@@ -858,7 +858,7 @@ components:
               items:
                 type: string
             preserve_original:
-              $ref: '_common.yaml#/components/schemas/Stringifiedboolean'
+              $ref: '_common.yaml#/components/schemas/StringifiedBoolean'
           required:
             - filters
             - type
@@ -876,7 +876,7 @@ components:
             min_gram:
               type: integer
             preserve_original:
-              $ref: '_common.yaml#/components/schemas/Stringifiedboolean'
+              $ref: '_common.yaml#/components/schemas/StringifiedBoolean'
           required:
             - type
     NoriPartOfSpeechTokenFilter:
@@ -908,7 +908,7 @@ components:
               items:
                 type: string
             preserve_original:
-              $ref: '_common.yaml#/components/schemas/Stringifiedboolean'
+              $ref: '_common.yaml#/components/schemas/StringifiedBoolean'
           required:
             - patterns
             - type
@@ -1211,7 +1211,7 @@ components:
             ignore_keywords:
               type: boolean
             preserve_original:
-              $ref: '_common.yaml#/components/schemas/Stringifiedboolean'
+              $ref: '_common.yaml#/components/schemas/StringifiedBoolean'
             protected_words:
               type: array
               items:
@@ -1252,7 +1252,7 @@ components:
             generate_word_parts:
               type: boolean
             preserve_original:
-              $ref: '_common.yaml#/components/schemas/Stringifiedboolean'
+              $ref: '_common.yaml#/components/schemas/StringifiedBoolean'
             protected_words:
               type: array
               items:
@@ -1736,15 +1736,15 @@ components:
               enum:
                 - path_hierarchy
             buffer_size:
-              $ref: '_common.yaml#/components/schemas/Stringifiedinteger'
+              $ref: '_common.yaml#/components/schemas/StringifiedInteger'
             delimiter:
               type: string
             replacement:
               type: string
             reverse:
-              $ref: '_common.yaml#/components/schemas/Stringifiedboolean'
+              $ref: '_common.yaml#/components/schemas/StringifiedBoolean'
             skip:
-              $ref: '_common.yaml#/components/schemas/Stringifiedinteger'
+              $ref: '_common.yaml#/components/schemas/StringifiedInteger'
           required:
             - buffer_size
             - delimiter

diff --git a/spec/schemas/_common.yaml b/spec/schemas/_common.yaml
@@ -43,7 +43,7 @@ components:
       description: |-
         A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and
         `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-      pattern: ^([0-9\.]+)(?:d|h|m|s|ms|micros|nanos)$
+      pattern: ^(?:(-1)|([0-9\.]+)(?:d|h|m|s|ms|micros|nanos))$
       type: string
     Metadata:
       type: object
@@ -822,7 +822,7 @@ components:
       type: string
     HumanReadableByteCount:
       type: string
-      pattern: '\d+(\.\d+)?(b|kb|k|mb|m|gb|g|tb|t|pb|p)'
+      pattern: '(?:(-1)|(0)|\d+(\.\d+)?(b|kb|k|mb|m|gb|g|tb|t|pb|p))'
     ByteUnit:
       type: string
       enum:
@@ -921,7 +921,7 @@ components:
             $ref: '#/components/schemas/ScrollId'
     TransportAddress:
       type: string
-    Stringifiedinteger:
+    StringifiedInteger:
       description: |-
         Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures
         this behavior while keeping the semantics of the field type.
@@ -931,7 +931,17 @@ components:
       oneOf:
         - type: integer
         - type: string
-    Stringifiedboolean:
+    StringifiedLong:
+      oneOf:
+        - type: integer
+          format: int64
+        - type: string
+    StringifiedDouble:
+      oneOf:
+        - type: number
+          format: double
+        - type: string
+    StringifiedBoolean:
       description: |-
         Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures
         this behavior while keeping the semantics of the field type.