spec: replace nullable value with null type (opensearch-project#436)

* spec: replace nullable value with null type Signed-off-by: Jakob Hahn <[email protected]> * spec: please the linter Signed-off-by: Jakob Hahn <[email protected]> * ajv set allowUnionTypes Signed-off-by: Jakob Hahn <[email protected]> --------- Signed-off-by: Jakob Hahn <[email protected]>
dblock · Jul 19, 2024 · bf2772a · bf2772a
1 parent e1cd369
commit bf2772a
Show file tree

Hide file tree

Showing 14 changed files with 75 additions and 237 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -60,6 +60,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Replaced the deprecated fs.rmdirSync with fs.rmSync ([#359](https://github.com/opensearch-project/opensearch-api-specification/pull/359))
 - Tester tool now provides better context for non-2XX responses when --verbose is used ([#359](https://github.com/opensearch-project/opensearch-api-specification/pull/359))
 - Lock testing for next release of OpenSearch to a specific SHA ([#431](https://github.com/opensearch-project/opensearch-api-specification/pull/431))
+- Replace nullable with null type ([#436](https://github.com/opensearch-project/opensearch-api-specification/pull/436))
 
 ### Deprecated
 

diff --git a/spec/schemas/_common.aggregations.yaml b/spec/schemas/_common.aggregations.yaml
@@ -113,21 +113,14 @@ components:
     KeyedPercentiles:
       type: object
       additionalProperties:
-        oneOf:
-          - type: string
-          - type: number
-          - nullable: true
-            type: string
+        type: ['null', number, string]
     ArrayPercentilesItem:
       type: object
       properties:
         key:
           type: string
         value:
-          oneOf:
-            - type: number
-            - nullable: true
-              type: string
+          type: ['null', number, string]
         value_as_string:
           type: string
       required:
@@ -162,10 +155,7 @@ components:
               description: |-
                 The metric value. A missing value generally means that there was no data to aggregate,
                 unless specified otherwise.
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             value_as_string:
               type: string
           required:
@@ -226,20 +216,11 @@ components:
             count:
               type: number
             min:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             max:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             avg:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             sum:
               type: number
             min_as_string:
@@ -266,40 +247,19 @@ components:
         - type: object
           properties:
             sum_of_squares:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             variance:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             variance_population:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             variance_sampling:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             std_deviation:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             std_deviation_population:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             std_deviation_sampling:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             std_deviation_bounds:
               $ref: '#/components/schemas/StandardDeviationBounds'
             sum_of_squares_as_string:
@@ -326,35 +286,17 @@ components:
       type: object
       properties:
         upper:
-          oneOf:
-            - type: number
-            - nullable: true
-              type: string
+          type: ['null', number, string]
         lower:
-          oneOf:
-            - type: number
-            - nullable: true
-              type: string
+          type: ['null', number, string]
         upper_population:
-          oneOf:
-            - type: number
-            - nullable: true
-              type: string
+          type: ['null', number, string]
         lower_population:
-          oneOf:
-            - type: number
-            - nullable: true
-              type: string
+          type: ['null', number, string]
         upper_sampling:
-          oneOf:
-            - type: number
-            - nullable: true
-              type: string
+          type: ['null', number, string]
         lower_sampling:
-          oneOf:
-            - type: number
-            - nullable: true
-              type: string
+          type: ['null', number, string]
       required:
         - lower
         - lower_population
@@ -1426,32 +1368,20 @@ components:
             count:
               type: number
             min_length:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             max_length:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             avg_length:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             entropy:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             distribution:
               oneOf:
+                - type: 'null'
                 - type: object
                   additionalProperties:
                     type: number
-                - nullable: true
-                  type: string
+                - type: string
             min_length_as_string:
               type: string
             max_length_as_string:
@@ -1522,17 +1452,11 @@ components:
         sort:
           type: array
           items:
-            oneOf:
-              - $ref: '_common.yaml#/components/schemas/FieldValue'
-              - nullable: true
-                type: string
+            $ref: '_common.yaml#/components/schemas/FieldValue'
         metrics:
           type: object
           additionalProperties:
-            oneOf:
-              - $ref: '_common.yaml#/components/schemas/FieldValue'
-              - nullable: true
-                type: string
+            $ref: '_common.yaml#/components/schemas/FieldValue'
       required:
         - metrics
         - sort
@@ -1542,10 +1466,7 @@ components:
         - type: object
           properties:
             value:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             value_as_string:
               type: string
           required:
@@ -2544,21 +2465,13 @@ components:
       properties:
         from:
           description: Start of the range (inclusive).
-          oneOf:
-            - type: number
-            - type: string
-            - nullable: true
-              type: string
+          type: ['null', number, string]
         key:
           description: Custom key to return the range with.
           type: string
         to:
           description: End of the range (exclusive).
-          oneOf:
-            - type: number
-            - type: string
-            - nullable: true
-              type: string
+          type: ['null', number, string]
     GeoHashGridAggregation:
       allOf:
         - $ref: '#/components/schemas/BucketAggregationBase'
@@ -2726,19 +2639,13 @@ components:
       properties:
         from:
           description: Start of the range.
-          oneOf:
-            - type: string
-            - nullable: true
-              type: string
+          type: ['null', string]
         mask:
           description: IP range defined as a CIDR mask.
           type: string
         to:
           description: End of the range.
-          oneOf:
-            - type: string
-            - nullable: true
-              type: string
+          type: ['null', string]
     IpPrefixAggregation:
       allOf:
         - $ref: '#/components/schemas/BucketAggregationBase'
@@ -3113,8 +3020,8 @@ components:
                 - type: array
                   items:
                     type: number
-                - nullable: true
-                  type: string
+                - type: 'null'
+                - type: string
             hdr:
               $ref: '#/components/schemas/HdrMethod'
             tdigest:

diff --git a/spec/schemas/_common.query_dsl.yaml b/spec/schemas/_common.query_dsl.yaml
@@ -1417,13 +1417,11 @@ components:
             from:
               oneOf:
                 - $ref: '_common.yaml#/components/schemas/DateMath'
-                - nullable: true
-                  type: string
+                - type: 'null'
             to:
               oneOf:
                 - $ref: '_common.yaml#/components/schemas/DateMath'
-                - nullable: true
-                  type: string
+                - type: 'null'
             format:
               $ref: '_common.yaml#/components/schemas/DateFormat'
             time_zone:
@@ -1459,15 +1457,9 @@ components:
               description: Less than or equal to.
               type: number
             from:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
             to:
-              oneOf:
-                - type: number
-                - nullable: true
-                  type: string
+              type: ['null', number, string]
     RankFeatureQuery:
       allOf:
         - $ref: '#/components/schemas/QueryBase'

diff --git a/spec/schemas/_common.yaml b/spec/schemas/_common.yaml
@@ -146,14 +146,12 @@ components:
       type: string
     FieldValue:
       description: A field value.
-      oneOf:
-        - type: number
-        - type: number
-        - type: string
-        - type: boolean
-        - nullable: true
-          type: string
-        - type: object
+      type: 
+        - boolean
+        - 'null'
+        - number
+        - object
+        - string
     Void:
       description: |-
         The absence of any type. This is commonly used in APIs that don't return a body.
@@ -1282,8 +1280,7 @@ components:
         licensed:
           type: boolean
         custom_foldername:
-          nullable: true
-          type: string
+          type: ['null', string]
         opensearch_version:
           $ref: '#/components/schemas/VersionString'
       required:
@@ -2014,8 +2011,7 @@ components:
         relocating_node:
           oneOf:
             - $ref: '#/components/schemas/NodeId'
-            - nullable: true
-              type: string
+            - type: 'null'
         relocation_failure_info:
           $ref: '#/components/schemas/RelocationFailureInfo'
       required:

diff --git a/spec/schemas/_core.bulk.yaml b/spec/schemas/_core.bulk.yaml
@@ -116,10 +116,7 @@ components:
           x-version-removed: '2.0'
         _id:
           description: The document ID associated with the operation.
-          anyOf:
-            - type: string
-            - nullable: true
-              type: string
+          type: ['null', string]
         _index:
           description: |-
             Name of the index associated with the operation.

diff --git a/spec/schemas/_core.rank_eval.yaml b/spec/schemas/_core.rank_eval.yaml
@@ -156,10 +156,7 @@ components:
         hit:
           $ref: '#/components/schemas/RankEvalHit'
         rating:
-          oneOf:
-            - type: number
-            - nullable: true
-              type: string
+          type: ['null', number, string]
       required:
         - hit
     RankEvalHit: