allOf required property not composing properly

[webron]

From @baynezy on July 3, 2017 13:46

If you take the following swagger definition:-

{
    "swagger": "2.0",
    "info": {
        "title": "An API Definition",
        "version": "0.1"
    },
    "paths": {
        "/users": {
            "post": {
                "operationId": "getUser",
                "produces": [
                    "application/json"
                ],
                "parameters": [{
                    "name": "newUser",
                    "in": "body",
                    "required": true,
                    "schema": {
                        "$ref": "#/definitions/newUser"
                    }
                }],
                "responses": {
                    "201": {
                        "description": "Details of the user"
                    }
                }
            }
        }
    },
    "definitions": {
        "user": {
            "type": "object",
            "required": ["username", "firstName", "lastName"],
            "properties": {
                "username": {
                    "type": "string"
                },
                "firstName": {
                    "type": "string"
                },
                "lastName": {
                    "type": "string"
                }
            }
        },
        "newUser": {
            "allOf": [{
                    "$ref": "#/definitions/user"
                },
                {
                    "type": "object",
                    "required": ["email", "roles"],
                    "properties": {
                        "email": {
                            "type": "string"
                        },
                        "roles": {
                            "type": "array",
                            "items": {
                                "type": "string"
                            }
                        }
                    }
                }
            ]
        }
    }
}

Then newUser is a composite of user and the additional properties defined on newUser. In the Swagger Editor the UI shows this correctly.

However, it should also compose the required property which it is failing to do. user states that username, firstName, and lastName are required, and newUser states that email, and roles are required. However, it is only marking those on newUser as required.

This should be a super-set of these.

6.26. allOf

This keyword's value MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema.

An instance validates successfully against this keyword if it validates successfully against all schemas defined by this keyword's value.

Copied from original issue: swagger-api/swagger-editor#1390

[owenconti]

I have a fix for this issue in the swagger-js repository. You can track the PR here: swagger-api/swagger-js#1101

[baynezy]

@webron and @owenconti - thanks for the quick response. How often do you guys release to production?

[webron]

We try to every Friday, meaning the fix is already included in the release. However, I'm still seeing the issue. @owenconti?

[owenconti]

@webron The PR in the swagger-js repo was merged just last night. It should be in the upcoming release then, shouldn't it?

[webron]

Oh! I thought it was merged last week, my bad. @baynezy expect the fix to be live this upcoming Friday.

[baynezy]

Perfect thanks.

[webron]

@baynezy mind testing with the latest version?

[baynezy]

@webron - that works as I had hoped. Thank you very much.

[webron]

Thanks for verifying! Closing.