Add additional properties in error message (#92)

* add addtional properties in error message

* remove brackets from error message when error.keyword additionalProperties

fix typo

* remove typo

Author: kerenfi

src/inputValidationError.js

@@ -33,6 +33,10 @@ const buildMessage = function(error){
         return `${error.message} [${error.params.allowedValues.toString()}]`;
     }
 
+    if (error.keyword === 'additionalProperties') {
+        return `${error.message} '${error.params.additionalProperty.toString()}'`;
+    }
+
     if (error.validation) {
         return error.errors.message;
     }

test/openapi3/openapi3-test.js

@@ -306,6 +306,31 @@ describe('input-validation middleware tests', function () {
                     });
             });
         });
+        describe('additionalProperties flag false', function () {
+            it('invalid update when body contains properties which are not in schema', function (done) {
+                request(app)
+                    .put('/dog/1')
+                    .set('public-key', '1.0')
+                    .send({
+                        max_length: '10',
+                        min_length: '5',
+                        additional1: '1',
+                        additional2: '2'
+                    })
+                    .expect(400, function (err, res) {
+                        if (err) {
+                            throw err;
+                        }
+                        expect(res.body).to.eql({
+                            'more_info': JSON.stringify(
+                                [
+                                    "body should NOT have additional properties 'additional1'",
+                                    "body should NOT have additional properties 'additional2'"])
+                        });
+                        done();
+                    });
+            });
+        });
         describe.skip('discriminator pet type is not on the root, only on child', function () {
             // does not support wright now.
         });
@@ -334,5 +359,28 @@ describe('input-validation middleware tests', function () {
                     done();
                 });
         });
+        describe('additionalProperties flag false', function () {
+            it('invalid update when body contains properties which are not in schema', function (done) {
+                request(app)
+                    .put('/dog/1')
+                    .set('public-key', '1.0')
+                    .send({
+                        max_length: '10',
+                        min_length: '5',
+                        additional1: '1',
+                        additional2: '2'
+                    })
+                    .expect(400, function (err, res) {
+                        if (err) {
+                            throw err;
+                        }
+                        expect(res.body).to.eql({
+                            'more_info': JSON.stringify(
+                                "body should NOT have additional properties 'additional1'")
+                        });
+                        done();
+                    });
+            });
+        });
     });
 });

test/openapi3/pets.yaml

@@ -140,6 +140,77 @@ paths:
               $ref: '#/components/schemas/pet'
         description: Create pet
         required: true
+  /dog/{id}:
+    put:
+      summary: Create a Pet
+      security:
+        - public-key: []
+      description: >-
+      tags:
+        - pets
+      operationId: update-a-pet
+      parameters:
+        - $ref: '#/components/parameters/public-key'
+        - name: id
+          in: path
+          description: >
+            The identifier of the pet
+          required: true
+          example: 1
+          schema:
+            type: string
+      responses:
+        '200':
+          description: pet updated
+          headers:
+            x-zooz-request-id:
+              description: request id
+              schema:
+                type: string
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/small_dog'
+        '400':
+          description: Bad request
+          headers:
+            x-zooz-request-id:
+              description: request id
+              schema:
+                type: string
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_model'
+        '401':
+          description: Unauthorize
+          headers:
+            x-zooz-request-id:
+              description: request id
+              schema:
+                type: string
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_model'
+        '500':
+          description: Internal error
+          headers:
+            x-zooz-request-id:
+              description: request id
+              schema:
+                type: string
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_model'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/medium_dog'
+        description: Update pet
+        
   /pet-discriminator:
     post:
       summary: Create a pet
@@ -513,3 +584,15 @@ components:
       properties:
         min_length:
           type: string
+    medium_dog:
+      type: object
+      required:
+        - min_length
+        - max_length
+      additionalProperties: false
+      properties:
+        max_length:
+          type: string
+        min_length:
+          type: string
+

test/openapi3/test-server-pet.js

@@ -25,6 +25,9 @@ module.exports = function (options) {
     app.post('/pet', inputValidation.validate, function (req, res, next) {
         res.json({ result: 'OK' });
     });
+    app.put('/dog/:id', inputValidation.validate, function (req, res, next) {
+        res.json({ result: 'OK' });
+    });
     app.post('/pet-discriminator', inputValidation.validate, function (req, res, next) {
         res.json({ result: 'OK' });
     });