Validate multiple occurrences of query parameters using json-schema and AJV

Question

I want to validate multiple occurrences of the same query parameter using AJV.

My OpenApi schema looks something like this:

...
/contacts:
  get:
    parameters:
      - name: user_id
        in: query
        schema:
          type: integer
...

I convert it to a valid json schema to be able to validate it with AJV:

{
  query: {
    properties: {
      user_id: { type: 'integer' }
    }
  }
}

Naturally, AJV validation works fine for one parameter of type integer.

I want to be able to validate multiple occurrences of user_id. For example: /contacts?user_id=1&user_id=2 is converted to { user_id: [1, 2] } and I want it to actually be valid.

At this point validation fails because it expects an integer but received an array. Is there any way to validate each items of the array independently ?

Thanks

Related (or duplicate): How to pass multi value query params in Swagger, Swagger UI not sending array correctly — Helen
– Helen, Commented Nov 5, 2018 at 15:44

customcommander · Accepted Answer · 2018-11-12 23:12:07Z

0

Perhaps the schema for user_id should use the anyOf compound keywords allowing you to define multiple schemas for a single property:

var ajv = new Ajv({
  allErrors: true
});

var schema = {
  "properties": {
    "user_id": {
      "anyOf": [{
          "type": "integer"
        },
        {
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
      ]
    },
  }
};

var validate = ajv.compile(schema);

function test(data) {
  var valid = validate(data);
  if (valid) console.log('Valid!');
  else console.log('Invalid: ' + ajv.errorsText(validate.errors));
}

test({
  "user_id": 1
});
test({
  "user_id": "foo"
});
test({
  "user_id": [1, 2]
});
test({
  "user_id": [1, "foo"]
});

<script src="https://cdnjs.cloudflare.com/ajax/libs/ajv/6.5.5/ajv.min.js"></script>

edited Nov 12, 2018 at 23:12

answered Nov 12, 2018 at 22:44

customcommander

19.3k6 gold badges70 silver badges96 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Validate multiple occurrences of query parameters using json-schema and AJV

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related