Fix simplifySingleMapSchema to generate named wrapper schemas

lucy66hw · lucy66hw · commit 8ff07a2e5a73 · 2026-02-27T06:33:25.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,7 +6,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Added
 
 ### Changed
-
+ - Fix simplifySingleMapSchema to generate named wrapper schemas
 ### Removed
 
 ### Fixed
diff --git a/tools/proto-convert/src/SchemaModifier.ts b/tools/proto-convert/src/SchemaModifier.ts
@@ -1,7 +1,7 @@
 import type {OpenAPIV3} from "openapi-types";
 import {traverse} from './utils/OpenApiTraverser';
 import isEqual from 'lodash.isequal';
-import {compressMultipleUnderscores, isPrimitiveType, resolveObj, isReferenceObject, isEmptyObjectSchema, is_simple_ref} from './utils/helper';
+import {compressMultipleUnderscores, isPrimitiveType, resolveObj, isReferenceObject, isEmptyObjectSchema, is_simple_ref, toSnakeCase} from './utils/helper';
 import logger from "./utils/logger";
 
 
@@ -21,7 +21,6 @@ export class SchemaModifier {
                 this.convertNullTypeToNullValue(schema)
                 this.deduplicateOneOfWithArrayType(schema)
                 this.collapseSingleItemComposite(schema);
-                this.removeArrayOfMapWrapper(schema)
             },
             onSchema: (schema, schemaName) => {
                 if (!schema || isReferenceObject(schema)) return;
@@ -33,7 +32,6 @@ export class SchemaModifier {
                 this.deduplicateOneOfWithArrayType(schema)
                 this.collapseSingleItemComposite(schema);
                 this.collapseOneOfObjectPropContainsTitleSchema(schema)
-                this.removeArrayOfMapWrapper(schema)
                 this.convertOneOfToMinMaxProperties(schema)
             },
         });
@@ -280,50 +278,70 @@ export class SchemaModifier {
     }
 
     /**
-     * Transforms SchemaObject that single-key maps (`minProperties = 1` and `maxProperties = 1`) into standard schema by reconstructing
-     * the additional property definitions.
+     * Extracts type name from $ref or title
+     * Note: Schema names have already been sanitized by Sanitizer, so '___' prefixes are already removed
+     **/
+    private getTypeName(schema: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject): string | null {
+        if ('$ref' in schema) {
+            const parts = schema.$ref.split('/');
+            return parts[parts.length - 1];
+        }
+        if ('title' in schema && schema.title) {
+            return schema.title;
+        }
+        return null;
+    }
+
+    /**
+     * Transforms SchemaObject that single-key maps (`minProperties = 1` and `maxProperties = 1`) into a new wrapper schema.
+     *
+     *
      * Example:
      *  Input:
      * {
      *   type: "object",
      *   additionalProperties: {
-     *     - ref: "#/components/schemas/Model"
+     *     $ref: "#/components/schemas/SortOrder"
      *   },
      *   minProperties: 1,
      *   maxProperties: 1,
-     * };
-     * Model:
-     *  properties: {
-     *      properties1: string
-     *      properties2: string
-     *  }
-     *
+     * }
      *
-     *Output:
-     *  {
-     *    ref: "#/components/schemas/Example
-     *  }
-     *
-     *  Model:
-     *  properties: {
-     *      field: string
-     *      properties1: string
-     *      properties2: string
-     *  }
+     * Output:
+     * {
+     *   type: "object",
+     *   title: "SortOrderMap",
+     *   properties: {
+     *     field: { type: "string" },
+     *     sort_order: { $ref: "#/components/schemas/SortOrder" }
+     *   },
+     *   required: ["field", "sort_order"]
+     * }
      *
      **/
     simplifySingleMapSchema(schema: OpenAPIV3.SchemaObject, visit: Set<any>): void {
         if (schema.type === 'object' && typeof schema.additionalProperties === 'object' &&
             !Array.isArray(schema.additionalProperties) && schema.minProperties === 1 && schema.maxProperties === 1){
 
-            const reconstructAdditionalPropertySchema = this.reconstructAdditionalPropertySchema(schema.additionalProperties, visit);
+            const valueSchema = schema.additionalProperties;
+            const typeName = this.getTypeName(valueSchema) || 'Value'; // Use 'Value' as fallback
 
-            Object.assign(schema, reconstructAdditionalPropertySchema)
+            // Create new wrapper schema
+            // Avoid collision with the reserved 'field' key property name
+            const rawPropertyName = toSnakeCase(typeName);
+            const valuePropertyName = rawPropertyName === 'field' ? `${rawPropertyName}_value` : rawPropertyName;
+            const wrapperTitle = schema.title || `${typeName}Map`;
+
+            schema.title = wrapperTitle;
+            schema.properties = {
+                field: { type: 'string' as const },
+                [valuePropertyName]: valueSchema
+            };
+            schema.required = ['field', valuePropertyName];
 
             delete schema.additionalProperties;
             delete schema.minProperties;
             delete schema.maxProperties;
-            delete schema.type
             if ('propertyNames' in schema) {
                 delete schema.propertyNames;
             }
@@ -449,44 +467,6 @@ export class SchemaModifier {
         logger.info(`Converted additionalProperties to named property '${propertyName}' with type: object`);
     }
 
-    /**
-     * Removes the array wrapper if the schema is an array of maps (additionalProperties).
-     * Converts array of objects with only additionalProperties into just the additionalProperties schema.
-     *
-     * Example:
-     *   Input:
-     *   {
-     *     type: "array",
-     *     items: {
-     *       type: "object",
-     *       additionalProperties: {
-     *         $ref: "#/components/schemas/Value"
-     *       }
-     *     }
-     *   }
-     *
-     *   Output:
-     *   {
-     *     type: "object",
-     *     additionalProperties: {
-     *       $ref: "#/components/schemas/Value"
-     *     }
-     *   }
-     **/
-    removeArrayOfMapWrapper(schema: OpenAPIV3.SchemaObject): void {
-        if (schema.type === 'array' && schema.items && typeof schema.items === 'object' && !('$ref' in schema.items)) {
-            const items = schema.items as OpenAPIV3.SchemaObject;
-
-            if (items.type === 'object' && items.additionalProperties && !items.properties) {
-                (schema as any).type = 'object';
-                schema.additionalProperties = items.additionalProperties;
-                delete (schema as any).items;
-
-                logger.info(`Removed array wrapper from array of maps schema`);
-            }
-        }
-    }
-
     /**
      * Converts oneOf pattern with single-property objects into minProperties/maxProperties pattern.
      * For AggregationContainer
diff --git a/tools/proto-convert/src/config/spec-filter.yaml b/tools/proto-convert/src/config/spec-filter.yaml
@@ -1,41 +1,129 @@
-# Target operation groups to include in proto generation
-x-operation-groups:
-  - bulk
-  - search
-
 # Schemas to exclude from proto generation
 # These schemas and their nested dependencies will not be included
 excluded_schemas:
-  - AggregationContainer
-  - Aggregate
   - Suggester
   - Suggest
   - DisMaxQuery
-  - QueryStringQuery
-  - IntervalsQuery
-  - ScriptScoreQuery
-  - CommonTermsQuery
-  - CombinedFieldsQuery
-  - DistanceFeatureQuery
-  - GeoPolygonQuery
-  - GeoShapeQuery
-  - HasChildQuery
-  - HasParentQuery
-  - MoreLikeThisQuery
-  - NeuralQuery
-  - ParentIdQuery
-  - PercolateQuery
-  - RankFeatureQuery
-  - SpanContainingQuery
-  - SpanFieldMaskingQuery
-  - SpanFirstQuery
-  - SpanMultiTermQuery
-  - SpanNearQuery
-  - SpanNotQuery
-  - SpanOrQuery
-  - SpanTermQuery
-  - SpanWithinQuery
-  - ObjectMap
   - TypeQuery
   - WrapperQuery
   - XyShapeQuery
+
+  # AggregationContainer - exclude all except TermsAggregation
+  - AdjacencyMatrixAggregation
+  - AutoDateHistogramAggregation
+  - AverageAggregation
+  - AverageBucketAggregation
+  - BoxplotAggregation
+  - BucketScriptAggregation
+  - BucketSelectorAggregation
+  - BucketSortAggregation
+  - CardinalityAggregation
+  - ChildrenAggregation
+  - CompositeAggregation
+  - CumulativeCardinalityAggregation
+  - CumulativeSumAggregation
+  - DateHistogramAggregation
+  - DateRangeAggregation
+  - DerivativeAggregation
+  - DiversifiedSamplerAggregation
+  - ExtendedStatsAggregation
+  - ExtendedStatsBucketAggregation
+  - FiltersAggregation
+  - GeoBoundsAggregation
+  - GeoCentroidAggregation
+  - GeoDistanceAggregation
+  - GeoHashGridAggregation
+  - GeoTileGridAggregation
+  - GlobalAggregation
+  - HistogramAggregation
+  - IpRangeAggregation
+  - MatrixStatsAggregation
+  - MaxBucketAggregation
+  - MedianAbsoluteDeviationAggregation
+  - MinBucketAggregation
+  - MissingAggregation
+  - MovingAverageAggregation
+  - MovingFunctionAggregation
+  - MovingPercentilesAggregation
+  - MultiTermsAggregation
+  - NestedAggregation
+  - NormalizeAggregation
+  - ParentAggregation
+  - PercentileRanksAggregation
+  - PercentilesAggregation
+  - PercentilesBucketAggregation
+  - RangeAggregation
+  - RareTermsAggregation
+  - RateAggregation
+  - ReverseNestedAggregation
+  - SamplerAggregation
+  - ScriptedMetricAggregation
+  - SerialDifferencingAggregation
+  - SignificantTermsAggregation
+  - SignificantTextAggregation
+  - StatsAggregation
+  - StatsBucketAggregation
+  - SumAggregation
+  - SumBucketAggregation
+  - TopHitsAggregation
+  - TTestAggregation
+  - ValueCountAggregation
+  - VariableWidthHistogramAggregation
+  - WeightedAverageAggregation
+
+  # Aggregate - exclude all except TermsAggregate variants (DoubleTerms, LongTerms, StringTerms, UnmappedTerms)
+  - AdjacencyMatrixAggregate
+  - AutoDateHistogramAggregate
+  - AvgAggregate
+  - BoxPlotAggregate
+  - BucketMetricValueAggregate
+  - CardinalityAggregate
+  - ChildrenAggregate
+  - CompositeAggregate
+  - CumulativeCardinalityAggregate
+  - DateHistogramAggregate
+  - DateRangeAggregate
+  - DerivativeAggregate
+  - ExtendedStatsAggregate
+  - ExtendedStatsBucketAggregate
+  - FilterAggregate
+  - FiltersAggregate
+  - GeoBoundsAggregate
+  - GeoCentroidAggregate
+  - GeoDistanceAggregate
+  - GeoHashGridAggregate
+  - GeoTileGridAggregate
+  - GlobalAggregate
+  - HdrPercentileRanksAggregate
+  - HdrPercentilesAggregate
+  - HistogramAggregate
+  - IpRangeAggregate
+  - LongRareTermsAggregate
+  - MatrixStatsAggregate
+  - MedianAbsoluteDeviationAggregate
+  - MissingAggregate
+  - MultiTermsAggregate
+  - NestedAggregate
+  - ParentAggregate
+  - PercentilesBucketAggregate
+  - RangeAggregate
+  - RateAggregate
+  - ReverseNestedAggregate
+  - SamplerAggregate
+  - ScriptedMetricAggregate
+  - SignificantLongTermsAggregate
+  - SignificantStringTermsAggregate
+  - SimpleValueAggregate
+  - StatsAggregate
+  - StatsBucketAggregate
+  - StringRareTermsAggregate
+  - SumAggregate
+  - TDigestPercentileRanksAggregate
+  - TDigestPercentilesAggregate
+  - TopHitsAggregate
+  - TTestAggregate
+  - UnmappedRareTermsAggregate
+  - UnmappedSignificantTermsAggregate
+  - ValueCountAggregate
+  - VariableWidthHistogramAggregate
+  - WeightedAvgAggregate
diff --git a/tools/proto-convert/src/utils/helper.ts b/tools/proto-convert/src/utils/helper.ts
@@ -55,6 +55,19 @@ export function compressMultipleUnderscores(str: string): string {
     return str.replace(/_+/g, '_');
 }
 
+/**
+ * Converts PascalCase or camelCase string to snake_case
+ * Consecutive capitals are treated as a single word.
+ * Example: "SortOrder" -> "sort_order", "APIResponse" -> "api_response", "HTTPSConnection" -> "https_connection"
+ */
+export function toSnakeCase(str: string): string {
+    return str
+        .replace(/([A-Z]+)([A-Z][a-z])/g, '$1_$2') // e.g. "HTTPSCo" -> "HTTPS_Co"
+        .replace(/([a-z\d])([A-Z])/g, '$1_$2')      // e.g. "sortOrder" -> "sort_Order"
+        .toLowerCase()
+        .replace(/^_/, '');
+}
+
 export function resolveObj(
     obj: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject | undefined,
     root: OpenAPIV3.Document
diff --git a/tools/proto-convert/test/SchemaModifier.test.ts b/tools/proto-convert/test/SchemaModifier.test.ts
diff --git a/tools/proto-convert/test/utils/helper.test.ts b/tools/proto-convert/test/utils/helper.test.ts
