Merge pull request #59 from cdimascio/additional-prop-info

Missing list of additional properties, when additionalProperties error is thrown #58

Author: cdimascio

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "express-openapi-validator",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Automatically validate API requests using an OpenAPI 3 and Express.",
   "main": "dist/index.js",
   "scripts": {

package.json

@@ -39,8 +39,13 @@ export function ajvErrorsToValidatorError(status, errors) {
         e.params &&
         e.params.missingProperty &&
         e.dataPath + '.' + e.params.missingProperty;
+      const additionalProperty =
+        e.params &&
+        e.params.additionalProperty &&
+        e.dataPath + '.' + e.params.additionalProperty;
+      const path = required || additionalProperty || e.dataPath || e.schemaPath;
       return {
-        path: required || e.dataPath || e.schemaPath,
+        path,
         message: e.message,
         errorCode: `${e.keyword}.openapi.validation`,
       };

src/middlewares/util.ts

@@ -50,4 +50,28 @@ describe(packageJson.name, () => {
         testProperty: 'abc',
       })
       .expect(200));
+
+  it('should return 400 if an additional property is encountered', async () =>
+    request(app)
+      .post(`${basePath}/request_bodies_ref`)
+      .send({
+        testProperty: 'abc',
+        invalidProperty: 'abc',
+        invalidProperty2: 'abc',
+      })
+      .expect(400)
+      .then(r => {
+        const errors = r.body.errors;
+        expect(errors)
+          .to.be.an('array')
+          .with.length(2);
+        expect(errors[0].path).to.equal('.body.invalidProperty');
+        expect(errors[0].message).to.equal(
+          'should NOT have additional properties',
+        );
+        expect(errors[1].path).to.equal('.body.invalidProperty2');
+        expect(errors[1].message).to.equal(
+          'should NOT have additional properties',
+        );
+      }));
 });

test/request.bodies.ref.spec.ts

@@ -26,6 +26,7 @@ components:
         application/json:
           schema:
             type: object
+            additionalProperties: false
             properties:
               testProperty:
                 type: string