Support schema validation for root-level arrays

[Almad]

See http://stackoverflow.com/questions/25027328/apiary-blueprint-markdown-for-an-array-response-body for issue description.

[netmilk]

According to the meta schema, items property should accept both an array of schemas or schema object but gavel (tv4 validator) accepts only array when validating schema from blueprint against meta schema. It seems that $ref reference in meta schema to root in items schema property declaration is not working.

As a workaround you can define items schema property as an array and it works:

# My Api

# GET /message

+ Response 200
  + Schema
        {
          "$schema": "http://json-schema.org/draft-03/schema",
          "type": "array",
            "items": [
              {
                  "type": "string"
              }
            ]
        }

[tu1ly]

no workaround needed
578d1e2#diff-2df9ad4288603cce25ab4f3a772dc6feR34

[rafaelkelly]

Hi @netmilk. I've also experienced this issue and I don't think the workaround you suggest has the correct result. As seen in https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.5:

When this attribute value is an array of schemas and the instance value is an array, each position in the instance array MUST conform to the schema in the corresponding position for this array.

So you would end up validating each position in the array and not all possible items.
Switching to v4 works fine but it's a problem for existing schemas written in draft 3.

[ApiaryBot]

🎉 This issue has been resolved in version 8.2.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[artem-zakharchenko]

Root-level arrays validation is supported by both explicit JSON Schema and implicit expected body. Please refer to the regression tests below for the example of usage.

Using JSON Schema

• https://github.com/apiaryio/gavel.js/blob/03991995ce0018523170035a6a77afdc7eacb693/test/regression/json-root-array.test.js

Using inferred schema from expected body

• https://github.com/apiaryio/gavel.js/blob/03991995ce0018523170035a6a77afdc7eacb693/test/regression/json-inferred-array.test.js