fix: Allow to tag non-exhaustive union types

CHANGELOG.md

@@ -46,6 +46,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added `mapper_type` and `mapper_settings` to `IngestionSource` index settings ([#1155](https://github.com/opensearch-project/opensearch-api-specification/pull/1155))
 - Added `search` and `warm` node roles to `NodeRole`, and modeled the pre-3.0 `search` role (renamed to `warm` in 3.0) as a version-scoped branch ([#1006](https://github.com/opensearch-project/opensearch-api-specification/pull/1006))
 - Added `sltr` to query DSL schema  ([#1187](https://github.com/opensearch-project/opensearch-api-specification/pull/1187))
+- Added `x-non-exhaustive` vendor extension to mark plugin-extensible union types (`Property`, `Analyzer`, `TokenizerDefinition`, `TokenFilterDefinition`, `CharFilterDefinition`, `QueryContainer`, `SpanQuery`, `AggregationContainer`, `ProcessorContainer`, `FieldSuggester`)
 
 ### Deprecated
 - Marked the plural `_aliases` URL forms of `put_alias` and `delete_alias` as deprecated; the singular `_alias` form is the canonical path ([#1131](https://github.com/opensearch-project/opensearch-api-specification/pull/1131))

DEVELOPER_GUIDE.md

@@ -144,6 +144,7 @@ This repository includes several OpenAPI Specification Extensions to fill in any
 - `x-default`: Contains the default value of a parameter. This is often used to override the default value specified in the schema, or to avoid accidentally changing the default value when updating a shared schema.
 - `x-distributions-included`: Contains a list of distributions known to include the API.
 - `x-distributions-excluded`: Contains a list of distributions known to exclude the API.
+- `x-non-exhaustive`: Denotes that a discriminated union (tagged type) is non-exhaustive, meaning plugins can register additional variants at runtime. Code generators should treat these unions as open/extensible.
 
 Use `opensearch.org` for the official distribution in `x-distributions-*`, `amazon-managed` for Amazon Managed OpenSearch, and `amazon-serverless` for Amazon OpenSearch Serverless.
 

spec/schemas/_common.aggregations.yaml

@@ -1425,6 +1425,7 @@ components:
         - skewness
         - variance
     AggregationContainer:
+      x-non-exhaustive: true
       allOf:
         - $ref: '#/components/schemas/Aggregation'
         - type: object

spec/schemas/_common.analysis.yaml

@@ -8,6 +8,7 @@ components:
   schemas:
     Analyzer:
       type: object
+      x-non-exhaustive: true
       discriminator:
         propertyName: type
       oneOf:
@@ -401,6 +402,7 @@ components:
           $ref: '#/components/schemas/CharFilterDefinition'
     CharFilterDefinition:
       type: object
+      x-non-exhaustive: true
       discriminator:
         propertyName: type
       oneOf:
@@ -500,6 +502,7 @@ components:
           $ref: '#/components/schemas/TokenFilterDefinition'
     TokenFilterDefinition:
       type: object
+      x-non-exhaustive: true
       discriminator:
         propertyName: type
       oneOf:
@@ -1586,6 +1589,7 @@ components:
           $ref: '#/components/schemas/TokenizerDefinition'
     TokenizerDefinition:
       type: object
+      x-non-exhaustive: true
       discriminator:
         propertyName: type
       oneOf:

spec/schemas/_common.mapping.yaml

@@ -159,6 +159,7 @@ components:
         - xy_shape
     Property:
       type: object
+      x-non-exhaustive: true
       discriminator:
         propertyName: type
         x-default: object

spec/schemas/_common.query_dsl.yaml

@@ -17,6 +17,7 @@ components:
         # eslint-enable yml/sort-sequence-values
     QueryContainer:
       type: object
+      x-non-exhaustive: true
       properties:
         agentic:
           $ref: '#/components/schemas/AgenticQuery'
@@ -2011,6 +2012,7 @@ components:
             - little
     SpanQuery:
       type: object
+      x-non-exhaustive: true
       properties:
         span_containing:
           $ref: '#/components/schemas/SpanContainingQuery'

spec/schemas/_core.search.yaml

@@ -1039,6 +1039,7 @@ components:
         description: The named suggesters.
         $ref: '#/components/schemas/FieldSuggester'
     FieldSuggester:
+      x-non-exhaustive: true
       allOf:
         - type: object
           properties:

spec/schemas/ingest._common.yaml

@@ -30,6 +30,7 @@ components:
           $ref: '_common.yaml#/components/schemas/Metadata'
     ProcessorContainer:
       type: object
+      x-non-exhaustive: true
       properties:
         attachment:
           $ref: '#/components/schemas/AttachmentProcessor'

tools/src/linter/SchemasValidator.ts

@@ -24,7 +24,8 @@ const ADDITIONAL_KEYWORDS = [
   'x-protobuf-excluded',
   'x-protobuf-data-type',
   'x-protobuf-name',
-  'x-protobuf-required'
+  'x-protobuf-required',
+  'x-non-exhaustive'
 ]
 
 export default class SchemasValidator {

tools/src/tester/SchemaValidator.ts

@@ -27,7 +27,8 @@ const ADDITIONAL_KEYWORDS = [
   'x-protobuf-excluded',
   'x-protobuf-data-type',
   'x-protobuf-name',
-  'x-protobuf-required'
+  'x-protobuf-required',
+  'x-non-exhaustive'
 ]
 
 export default class SchemaValidator {