[dsch] removing minIteams on the required arrays

DScheglov · Oct 12, 2024 · ebecfd7 · ebecfd7
1 parent e6ad49f
commit ebecfd7
Show file tree

Hide file tree

Showing 9 changed files with 4 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -378,6 +378,7 @@ newSchemaType.prototype.jsonSchema = function() {
 - version 2.1.0 - Support for <[email protected]> and Node v14.x, v16.x, v18.x
 - version 2.2.0 - Support for <[email protected]> and Node v20.x. Node v14.x is no longer supported (use v2.1.0 of the lib)
 - version 2.2.1 - fix for `required` fields: if `required` is a function, it is not considered as required field
+- version 3.0.0 - breaking changes on Array with `required`: the `minItems` constraint is removed from JSON schema
 
 ## Supported versions
 

diff --git a/lib/types.js b/lib/types.js
@@ -99,10 +99,6 @@ function array_jsonSchema(name) {
     result.items = this.caster.jsonSchema(itemName);
   }
 
-  if (result.items.__required || this.schemaOptions && this.schemaOptions.required) {
-    result.minItems = 1;
-  }
-
   __processOptions(result, extendOptions(this));
   delete result.items.__required;
 

diff --git a/test/suites/ajv-validation.test.js b/test/suites/ajv-validation.test.js
@@ -215,7 +215,6 @@ describe('Validation: schema.jsonSchema()', () => {
         a: {
           type: 'array',
           items: { type: 'number' },
-          minItems: 1,
         },
         _id: { type: 'string', pattern: '^[0-9a-fA-F]{24}$' },
       },
@@ -227,7 +226,7 @@ describe('Validation: schema.jsonSchema()', () => {
     assert.ok(isValid({ a: [0, 1] }));
     assert.ok(isValid({ a: [0] }));
     assert.ok(isValid({ }));
-    assert.ok(!isValid({ a: [] }));
+    assert.ok(isValid({ a: [] }));
     assert.ok(!isValid({ a: [0, 1, 'a'] }));
   });
 

diff --git a/test/suites/nullable-types.test.js b/test/suites/nullable-types.test.js
@@ -64,7 +64,6 @@ describe('nullable: schema.jsonSchema', () => {
             ...(isV6pl ? { _id: { type: 'string', pattern: '^[0-9a-fA-F]{24}$' } } : undefined),
             x: {
               type: 'array',
-              minItems: 1,
               items: {
                 type: 'object',
                 title: 'itemOf_x',

diff --git a/test/suites/population.test.js b/test/suites/population.test.js
@@ -78,7 +78,6 @@ describe('Population: Model.jsonSchema()', () => {
             'x-ref': 'Person',
             description: 'Refers to Person',
           },
-          minItems: 1,
         },
         _id: { type: 'string', pattern: '^[0-9a-fA-F]{24}$' },
       },
@@ -108,7 +107,6 @@ describe('Population: Model.jsonSchema()', () => {
             'x-ref': 'Person',
             description: 'Refers to Person',
           },
-          minItems: 1,
         },
         _id: { type: 'string', pattern: '^[0-9a-fA-F]{24}$' },
       },
@@ -176,7 +174,6 @@ describe('Population: Model.jsonSchema()', () => {
             'x-ref': 'Person',
             description: 'Refers to Person',
           },
-          minItems: 1,
         },
         _id: { type: 'string', pattern: '^[0-9a-fA-F]{24}$' },
       },
@@ -203,7 +200,6 @@ describe('Population: Model.jsonSchema()', () => {
             description: 'Refers to Person',
             pattern: '^[0-9a-fA-F]{24}$',
           },
-          minItems: 1,
         },
         comment: {
           type: 'array',

diff --git a/test/suites/queries.test.js b/test/suites/queries.test.js
@@ -24,7 +24,6 @@ describe('Queries: query.jsonSchema()', () => {
 
               pattern: '^[0-9a-fA-F]{24}$',
             },
-            minItems: 1,
           },
           comment: {
             type: 'array',
@@ -87,7 +86,6 @@ describe('Queries: query.jsonSchema()', () => {
 
               pattern: '^[0-9a-fA-F]{24}$',
             },
-            minItems: 1,
           },
           _id: { type: 'string', pattern: '^[0-9a-fA-F]{24}$' },
         },
@@ -124,7 +122,6 @@ describe('Queries: query.jsonSchema()', () => {
               'x-ref': 'Person',
               description: 'Refers to Person',
             },
-            minItems: 1,
           },
           _id: { type: 'string', pattern: '^[0-9a-fA-F]{24}$' },
         },

diff --git a/test/suites/readonly.test.js b/test/suites/readonly.test.js
@@ -101,7 +101,6 @@ describe('readonly: model.jsonSchema', () => {
             description: 'Refers to Person',
             pattern: '^[0-9a-fA-F]{24}$',
           },
-          minItems: 1,
         },
         comment: {
           type: 'array',

diff --git a/test/suites/translation.test.js b/test/suites/translation.test.js
@@ -501,7 +501,6 @@ describe('schema.jsonSchema', () => {
             ...(isV6pl ? { _id: { type: 'string', pattern: '^[0-9a-fA-F]{24}$' } } : undefined),
             x: {
               type: 'array',
-              minItems: 1,
               items: {
                 type: 'object',
                 title: 'itemOf_x',

diff --git a/test/suites/validation.test.js b/test/suites/validation.test.js
@@ -222,7 +222,7 @@ describe('Validation: schema.jsonSchema()', () => {
     assert.equal(errors.length, 0);
   });
 
-  it('should build schema and validate arrays with minItems constraint', () => {
+  it('should build schema and validate arrays with**out** minItems constraint', () => {
     const mSchema = mongoose.Schema({
       a: [{
         type: Number,
@@ -238,7 +238,6 @@ describe('Validation: schema.jsonSchema()', () => {
         a: {
           type: 'array',
           items: { type: 'number' },
-          minItems: 1,
         },
         _id: { type: 'string', pattern: '^[0-9a-fA-F]{24}$' },
       },
@@ -255,7 +254,7 @@ describe('Validation: schema.jsonSchema()', () => {
     assert.equal(errors.length, 0);
 
     errors = validate({ a: [] }, jsonSchema).errors;
-    assert.equal(errors.length, 1);
+    assert.equal(errors.length, 0);
 
     errors = validate({ a: [0, 1, 'a'] }, jsonSchema).errors;
     assert.equal(errors.length, 1);