Dredd/Gavel incorrectly validates response body as valid when a JSON schema contains definitions and $ref

[jessedc]

I have noticed that dredd incorrectly marks my API responses as valid if I supply a JSON Schema that uses "definitions" as outlined here.

My server is returning the following JSON for a simple GET request:

{
    "address": {
        "street": "123 Test Street",
        "postcode": "12345"
    }
}

My API Blueprint has two test cases, one that validates the above JSON against a JSON Schema expecting the "address" object to contain three fields. The second request uses a JSON Schema that extracts the "address" object into a definition and references this with a JSON Pointer.

As expected the first request is failing with message body: At '/address/country' Missing required property: country. But the second request is happily passing.

# Test Endpoint [/api.php]

Tests the validity of server responses against json-schema.

## Schema with no definitions [GET]

+ Response 200 (application/json; charset=utf-8)

    + Schema

            {
                "$schema": "http://json-schema.org/draft-04/schema",
                "id": "schema-no-definitions",
                "type": "object",
                "properties": {
                    "address": {
                        "type": "object",
                        "properties": {
                            "street": {
                                "type": "string",
                                "minLength": 1
                            },
                            "postcode": {
                                "type": "string",
                                "minLength": 1
                            },
                            "country": {
                                "type": "string",
                                "minLength": 1
                            }
                        },
                        "required": [
                            "street", "postcode", "country"
                        ]
                    }
                },
                "required" : [
                    "address"
                ]
            }

## Test schema with definitions [GET]

+ Response 200 (application/json; charset=utf-8)

    + Schema

            {
                "$schema": "http://json-schema.org/draft-04/schema",
                "id": "schema-definitions",
                "definitions": {
                    "addressItem": {
                        "type": "object",
                        "properties": {
                            "street": {
                                "type": "string",
                                "minLength": 1
                            },
                            "postcode": {
                                "type": "string",
                                "minLength": 1
                            },
                            "country": {
                                "type": "string",
                                "minLength": 1
                            }
                        },
                        "required": [
                            "street", "postcode", "country"
                        ]
                    }
                },
                "properties": {
                    "address": {
                        "$ref": "#/definitions/addressItem"
                    }
                },
                "required" : [
                    "address"
                ]
            }

Should dredd/Gavel be supporting these JSON Schema features?

[stianborgesen]

+1

[netmilk]

Hi @jessedc @stianborgesen,

this should work, Dredd/Gavel should support both Json Schema v3 and v4. This is a v4 feature, but the functionality in Dredd depends on underlaying JSON schema validator. I suspect it's a bug or feature of this validator. I'll investigate further...

[joaosa]

@netmilk I am also experiencing this. Any news? :)

[honzajavorek]

@joaosa this is the issue we're solving in apiaryio/gavel.js#25, right?

[joaosa]

@honzajavorek yes that seems to be the case. Must've mixed the issues

[honzajavorek]

No problem, just linking it together

…

On Thu, 9 Mar 2017 at 07:35, João Sousa Andrade ***@***.***> wrote: @honzajavorek <https://github.com/honzajavorek> yes that seems to be the case. Must've mixed the issues — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#254 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AARTMWDxr6imULAeayWzRffS2Doqe1I6ks5rj52agaJpZM4Fe3kT> .

[honzajavorek]

I think this should be fixed by #767 and will be in the next Dredd release, thanks to @joaosa's work on Gavel.js!

[mrname]

Does #767 also address this issue for swagger specifications? I would assume so, since I am using swagger 2.0 which utilizes json schema draft 4.

Only asking because I just installed from master and seem to be having this problem still.

EDIT: Scratch that, it was an error on my end where the dredd CLI command was still looking at the build installed from npm. Master seems to be working fine, thank you!

[honzajavorek]

@mrname Good! I'm glad it works.

[honzajavorek]

Should be fixed in Dredd v3.4.2.