failsafe-engineering#45 Minor improvement on object validation

rovellipaolo · Mar 25, 2024 · 459548c · 459548c
1 parent 3b5d91a
commit 459548c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 9 deletions.
diff --git a/src/generateDocumentation.js b/src/generateDocumentation.js
@@ -309,7 +309,7 @@ function generateModelSchema(templateSchema) {
       if (match) {
         field = `#/components/schemas/${match[1]}`;
       }
-    } else if (!Array.isArray(field) && typeof field === "object" && field) {
+    } else if (field.constructor === Object && field) {
       // NOTE: We are only interested in looping through "items" and "properties" fields (which are both objects)!
       field = generateModelSchema(field);
     }

diff --git a/src/generateDocumentation.spec.js b/src/generateDocumentation.spec.js
@@ -346,10 +346,11 @@ describe('ServerlessAWSDocumentation', function () {
       ${[{ name: 'AnyModel', schema: { type: 'any-type' } }]}                                        | ${{ 'AnyModel': { type: 'any-type' } }}
       ${[{ name: 'AnyModel', contentType: 'application/json', schema: { type: 'any-type' } }]}       | ${{ 'AnyModel': { type: 'any-type' } }}
       ${[{ name: 'AnyModel', schema: { type: 'any-type' } }, { name: 'AnyOtherModel', schema: {} }]} | ${{ 'AnyModel': { type: 'any-type' }, 'AnyOtherModel': {} }}
-      ${[{ name: 'AnyModel', schema: { type: 'array', items: { "$ref": "http://path/to/AnyOtherModel" } } }]}                                      | ${{ 'AnyModel': { type: 'array', items: { "$ref": "http://path/to/AnyOtherModel" } } }}
-      ${[{ name: 'AnyModel', schema: { type: 'array', items: { "$ref": "{{model: AnyOtherModel}}" } } }]}                                          | ${{ 'AnyModel': { type: 'array', items: { "$ref": "#/components/schemas/AnyOtherModel" } } }}
-      ${[{ name: 'AnyModel', schema: { type: 'object', required: ['id'], properties: { id: { "$ref": "{{model: AnyOtherModel}}" } } } }]}          | ${{ 'AnyModel': { type: 'object', required: ['id'], properties: { id: { "$ref": "#/components/schemas/AnyOtherModel" } } } }}
-      ${[{ name: 'AnyModel', schema: { type: 'object', properties: { ids: { type: 'array', items: { "$ref": "{{model: AnyOtherModel}}" } } } } }]} | ${{ 'AnyModel': { type: 'object', properties: { ids: { type: 'array', items: { "$ref": "#/components/schemas/AnyOtherModel" } } } } }}
+      ${[{ name: 'AnyModel', schema: { type: 'array', items: { '$ref': 'http://path/to/AnyOtherModel' } } }]}                                               | ${{ 'AnyModel': { type: 'array', items: { '$ref': 'http://path/to/AnyOtherModel' } } }}
+      ${[{ name: 'AnyModel', schema: { type: 'array', items: { '$ref': '{{model: AnyOtherModel}}' } } }]}                                                   | ${{ 'AnyModel': { type: 'array', items: { '$ref': '#/components/schemas/AnyOtherModel' } } }}
+      ${[{ name: 'AnyModel', schema: { type: 'object', required: ['id'], properties: { id: { type: 'integer', minimum: 1, exclusiveMinimum: false } } } }]} | ${{ 'AnyModel': { type: 'object', required: ['id'], properties: { id: { type: 'integer', minimum: 1, exclusiveMinimum: false } } } }}
+      ${[{ name: 'AnyModel', schema: { type: 'object', required: ['id'], properties: { id: { '$ref': '{{model: AnyOtherModel}}' } } } }]}                   | ${{ 'AnyModel': { type: 'object', required: ['id'], properties: { id: { '$ref': '#/components/schemas/AnyOtherModel' } } } }}
+      ${[{ name: 'AnyModel', schema: { type: 'object', properties: { ids: { type: 'array', items: { '$ref': '{{model: AnyOtherModel}}' } } } } }]}          | ${{ 'AnyModel': { type: 'object', properties: { ids: { type: 'array', items: { '$ref': '#/components/schemas/AnyOtherModel' } } } } }}
     `(
       'generates definitions field when exportType: swagger and models: $models',
       async ({
@@ -379,10 +380,11 @@ describe('ServerlessAWSDocumentation', function () {
       ${[{ name: 'AnyModel', schema: { type: 'any-type' } }]}                                        | ${{ schemas: { 'AnyModel': { type: 'any-type' } }, securitySchemes: {} }}
       ${[{ name: 'AnyModel', contentType: 'application/json', schema: { type: 'any-type' } }]}       | ${{ schemas: { 'AnyModel': { type: 'any-type' } }, securitySchemes: {} }}
       ${[{ name: 'AnyModel', schema: { type: 'any-type' } }, { name: 'AnyOtherModel', schema: {} }]} | ${{ schemas: { 'AnyModel': { type: 'any-type' }, 'AnyOtherModel': {} }, securitySchemes: {} }}
-      ${[{ name: 'AnyModel', schema: { type: 'array', items: { "$ref": "http://path/to/AnyOtherModel" } } }]}                                      | ${{ schemas: { 'AnyModel': { type: 'array', items: { "$ref": "http://path/to/AnyOtherModel" } } }, securitySchemes: {} }}
-      ${[{ name: 'AnyModel', schema: { type: 'array', items: { "$ref": "{{model: AnyOtherModel}}" } } }]}                                          | ${{ schemas: { 'AnyModel': { type: 'array', items: { "$ref": "#/components/schemas/AnyOtherModel" } } }, securitySchemes: {} }}
-      ${[{ name: 'AnyModel', schema: { type: 'object', required: ['id'], properties: { id: { "$ref": "{{model: AnyOtherModel}}" } } } }]}          | ${{ schemas: { 'AnyModel': { type: 'object', required: ['id'], properties: { id: { "$ref": "#/components/schemas/AnyOtherModel" } } } }, securitySchemes: {} }}
-      ${[{ name: 'AnyModel', schema: { type: 'object', properties: { ids: { type: 'array', items: { "$ref": "{{model: AnyOtherModel}}" } } } } }]} | ${{ schemas: { 'AnyModel': { type: 'object', properties: { ids: { type: 'array', items: { "$ref": "#/components/schemas/AnyOtherModel" } }} } }, securitySchemes: {} }}
+      ${[{ name: 'AnyModel', schema: { type: 'array', items: { '$ref': 'http://path/to/AnyOtherModel' } } }]}                                               | ${{ schemas: { 'AnyModel': { type: 'array', items: { '$ref': 'http://path/to/AnyOtherModel' } } }, securitySchemes: {} }}
+      ${[{ name: 'AnyModel', schema: { type: 'array', items: { '$ref': '{{model: AnyOtherModel}}' } } }]}                                                   | ${{ schemas: { 'AnyModel': { type: 'array', items: { '$ref': '#/components/schemas/AnyOtherModel' } } }, securitySchemes: {} }}
+      ${[{ name: 'AnyModel', schema: { type: 'object', required: ['id'], properties: { id: { type: 'integer', minimum: 1, exclusiveMinimum: false } } } }]} | ${{ schemas: { 'AnyModel': { type: 'object', required: ['id'], properties: { id: { type: 'integer', minimum: 1, exclusiveMinimum: false } } } }, securitySchemes: {} }}
+      ${[{ name: 'AnyModel', schema: { type: 'object', required: ['id'], properties: { id: { '$ref': '{{model: AnyOtherModel}}' } } } }]}                   | ${{ schemas: { 'AnyModel': { type: 'object', required: ['id'], properties: { id: { '$ref': '#/components/schemas/AnyOtherModel' } } } }, securitySchemes: {} }}
+      ${[{ name: 'AnyModel', schema: { type: 'object', properties: { ids: { type: 'array', items: { '$ref': '{{model: AnyOtherModel}}' } } } } }]}          | ${{ schemas: { 'AnyModel': { type: 'object', properties: { ids: { type: 'array', items: { '$ref': '#/components/schemas/AnyOtherModel' } }} } }, securitySchemes: {} }}
     `(
       'generates components.schemas field when exportType: oas30 and models: $models',
       async ({