feat: Add min/maxItems annotation support

CHANGELOG.md

@@ -7,6 +7,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 ## [Unreleased]
 
 ### Added
+- Support `@Validation.MinItems` and `@Validation.MaxItems` annotations on collection-typed properties and action parameters to emit `minItems`/`maxItems` in the generated OpenAPI schema
 ### Changed
 ### Deprecated
 ### Removed

lib/compile/csdl.js

@@ -14,7 +14,7 @@ const CDS_TERMS = Object.freeze({
     Core: ['AcceptableMediaTypes', 'Computed', 'ComputedDefaultValue', 'DefaultNamespace', 'Description', 'Example', 'Immutable', 'LongDescription',
         'MediaType', 'OptionalParameter', 'Permissions', 'SchemaVersion'],
     JSON: ['Schema'],
-    Validation: ['AllowedValues', 'Exclusive', 'Maximum', 'Minimum', 'Pattern']
+    Validation: ['AllowedValues', 'Exclusive', 'Maximum', 'MaxItems', 'Minimum', 'MinItems', 'Pattern']
 })
 
 /**

lib/compile/csdl2openapi.js

@@ -90,7 +90,7 @@
  * @param {{ url?: string, servers?: object, odataVersion?: string, scheme?: string, host?: string, basePath?: string, diagram?: boolean, maxLevels?: number, shortActionPaths?: boolean }} options Optional parameters
  * @return {object} OpenAPI description
  */
 module.exports.csdl2openapi = function (
     csdl,
     {
         url: serviceRoot,
@@ -472,7 +472,7 @@
      * @param {number} options.level Number of navigation segments so far
      * @param {string} options.navigationPath Path for finding navigation restrictions
      */
     function pathItems({ paths, prefix, prefixParameters, element, root, sourceName, targetName, target, level, navigationPath }) {
         const name = prefix.substring(prefix.lastIndexOf('/') + 1);
         const type = meta.modelElement(element.$Type);
         const pathItem = {};
@@ -750,7 +750,7 @@
      * @param {boolean} options.byKey Read by key
      * @param {array} options.nonExpandable Non-expandable navigation properties
      */
     function operationRead({ pathItem, element, name, sourceName, targetName, target, level, restrictions, byKey, nonExpandable }) {
         const targetRestrictions = target?.[meta.voc.Capabilities.ReadRestrictions];
         const readRestrictions = restrictions.ReadRestrictions || targetRestrictions || {};
         const readByKeyRestrictions = readRestrictions.ReadByKeyRestrictions;
@@ -1220,7 +1220,7 @@
      * @param {object} options.restrictions Navigation property restrictions of navigation segment
      * @param {boolean} [options.byKey=false] Update by key
      */
     function operationUpdate({ pathItem, element, name, sourceName, target, level, restrictions, byKey = false }) {
         const updateRestrictions = restrictions.UpdateRestrictions || target?.[meta.voc.Capabilities.UpdateRestrictions] || {};
         const countRestrictions = target?.[meta.voc.Capabilities.CountRestrictions]?.Countable === false;
         if (updateRestrictions.Updatable !== false && !element[meta.voc.Core.Immutable]) {
@@ -1311,7 +1311,7 @@
      */
     function pathItemsForMediaStream({ paths, prefix, prefixParameters, type, name, sourceName }) {
         if (type.$HasStream) {
             const mediaTypes = type[meta.voc.Core.AcceptableMediaTypes]?.map(t => t['$EnumMember'] ?? t) ?? [];
             const contentTypes = mediaTypes.length > 0 ? mediaTypes : ['*/*'];
             const mediaContent = Object.fromEntries(contentTypes.map(ct => [ct, { schema: { type: 'string', format: 'binary' } }]));
             const lname = splitName(name);
@@ -1641,7 +1641,7 @@
      * @param {string} options.sourceName Name of path source
      * @param {object} [options.actionImport={}] Action import
      */
     function pathItemAction({ paths, prefix, prefixParameters, actionName, overload, sourceName, actionImport = {} }) {
         const name = actionName.indexOf('.') === -1 ? actionName : nameParts(actionName).name;
         const pathItem = {
             post: {
@@ -1731,7 +1731,7 @@
      * @param {string} options.sourceName Name of path source
      * @param {object} [options.functionImport={}] Function Import
      */
     function pathItemFunction({ paths, prefix, prefixParameters, functionName, overload, sourceName, functionImport = {} }) {
         const name = functionName.indexOf('.') === -1 ? functionName : nameParts(functionName).name;
         let parameters = overload.$Parameter || [];
         if (overload.$IsBound) parameters = parameters.slice(1);
@@ -1740,7 +1740,7 @@
 
         const implicitAliases = csdl.$Version > '4.0' || parameters.some(p => p[meta.voc.Core.OptionalParameter]);
 
         parameters.forEach(p => {
             const description = getDescriptionWithFallback(p);
             /** @type {Parameter} */
             const param = {
@@ -2120,7 +2120,7 @@
      * @param {string} options.suffix Suffix for read/create/update
      * @return {object} Map of Schemas Objects
      */
     function schemasForStructuredType({ schemas, qualifier, name, type, suffix }) {
         const schemaName = `${qualifier}.${name}${suffix}`;
         const baseName = `${qualifier}.${name}`;
         const isKey = keyMap(type);
@@ -2136,7 +2136,7 @@
         const properties = propertiesOfStructuredType(type);
         const expandRestrictions = type[meta.voc.Capabilities.ExpandRestrictions] ?? {};
         const nonExpandableProperties = expandRestrictions.NonExpandableProperties ?? [];
         Object.keys(properties).forEach(iName => {
             if (nonExpandableProperties.includes(iName)) {
                 return;
             }
@@ -2574,7 +2574,7 @@
             }
         }
 
-        if (element[meta.voc.Validation.Maximum] != undefined) {
+        if (element[meta.voc.Validation.Maximum] !== undefined) {
             if (s.$ref) s = { allOf: [s] };
             if (isAnyOfSchema(s) && isNumberSchema(s.anyOf[0])) {
                 s.anyOf[0].maximum = element[meta.voc.Validation.Maximum];
@@ -2584,7 +2584,7 @@
             if (element[meta.voc.Validation.Maximum + meta.voc.Validation.Exclusive]) s.exclusiveMaximum = true;
         }
 
-        if (element[meta.voc.Validation.Minimum] != undefined) {
+        if (element[meta.voc.Validation.Minimum] !== undefined) {
             if (s.$ref) s = { allOf: [s] };
             if (isAnyOfSchema(s) && isNumberSchema(s.anyOf[0])) {
                 s.anyOf[0].minimum = element[meta.voc.Validation.Minimum];
@@ -2599,6 +2599,10 @@
                 type: 'array',
                 items: s
             };
+            if (element[meta.voc.Validation.MinItems] !== undefined)
+                s.minItems = element[meta.voc.Validation.MinItems];
+            if (element[meta.voc.Validation.MaxItems] !== undefined)
+                s.maxItems = element[meta.voc.Validation.MaxItems];
         }
 
         const description = forParameter ? undefined : (element[meta.voc.Core.LongDescription] || element[meta.voc.Core.Description]);

lib/compile/types.d.ts

@@ -23,7 +23,9 @@ type BooleanSchema = {
 
 type ArraySchema = {
     type: 'array',
-    items: Schema
+    items: Schema,
+    minItems?: number,
+    maxItems?: number
 }
 
 type ObjectSchema = {

test/lib/compile/data/annotations.json

@@ -90,6 +90,15 @@
                 "$Type": "Edm.Decimal",
                 "$Scale": 5
             },
+            "MinMaxItems": {
+                "$Collection": true,
+                "@Validation.MinItems": 1,
+                "@Validation.MaxItems": 5
+            },
+            "MinItems": {
+                "$Collection": true,
+                "@Validation.MinItems": 2
+            },
             "Example": {
                 "$Nullable": true,
                 "@Core.Example": {

test/lib/compile/data/annotations.openapi3.json

@@ -113,6 +113,10 @@
                   "Minimum desc",
                   "MinimumExt",
                   "MinimumExt desc",
+                  "MinMaxItems",
+                  "MinMaxItems desc",
+                  "MinItems",
+                  "MinItems desc",
                   "ExampleExt",
                   "ExampleExt desc",
                   "Computed",
@@ -149,6 +153,8 @@
                   "MaximumExt",
                   "Minimum",
                   "MinimumExt",
+                  "MinMaxItems",
+                  "MinItems",
                   "Example",
                   "ExampleExt",
                   "Computed",
@@ -250,6 +256,8 @@
                   "MaximumExt",
                   "Minimum",
                   "MinimumExt",
+                  "MinMaxItems",
+                  "MinItems",
                   "Example",
                   "ExampleExt",
                   "Computed",
@@ -566,6 +574,8 @@
                   "MaximumExt",
                   "Minimum",
                   "MinimumExt",
+                  "MinMaxItems",
+                  "MinItems",
                   "Example",
                   "ExampleExt",
                   "Computed",
@@ -867,6 +877,10 @@
                   "Minimum desc",
                   "MinimumExt",
                   "MinimumExt desc",
+                  "MinMaxItems",
+                  "MinMaxItems desc",
+                  "MinItems",
+                  "MinItems desc",
                   "Example",
                   "Example desc",
                   "ExampleExt",
@@ -905,6 +919,8 @@
                   "MaximumExt",
                   "Minimum",
                   "MinimumExt",
+                  "MinMaxItems",
+                  "MinItems",
                   "Example",
                   "ExampleExt",
                   "Computed",
@@ -1006,6 +1022,8 @@
                   "MaximumExt",
                   "Minimum",
                   "MinimumExt",
+                  "MinMaxItems",
+                  "MinItems",
                   "Example",
                   "ExampleExt",
                   "Computed",
@@ -1113,6 +1131,10 @@
                   "Minimum desc",
                   "MinimumExt",
                   "MinimumExt desc",
+                  "MinMaxItems",
+                  "MinMaxItems desc",
+                  "MinItems",
+                  "MinItems desc",
                   "Example",
                   "Example desc",
                   "ExampleExt",
@@ -1151,6 +1173,8 @@
                   "MaximumExt",
                   "Minimum",
                   "MinimumExt",
+                  "MinMaxItems",
+                  "MinItems",
                   "Example",
                   "ExampleExt",
                   "Computed",
@@ -1252,6 +1276,8 @@
                   "MaximumExt",
                   "Minimum",
                   "MinimumExt",
+                  "MinMaxItems",
+                  "MinItems",
                   "Example",
                   "ExampleExt",
                   "Computed",
@@ -2351,6 +2377,21 @@
             "x-sap-scale": 5,
             "exclusiveMinimum": true
           },
+          "MinMaxItems": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "minItems": 1,
+            "maxItems": 5
+          },
+          "MinItems": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "minItems": 2
+          },
           "Example": {
             "type": "string",
             "nullable": true,