Response with array different then 200 doesn't show.

[marcinskubala]

Hi, ui doesn't show the model shema.

"responses": {
    "200": {
        "description": "media response",
        "schema": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/Media"
            }
        }
    },
    "default": {
        "description": "unexpected error",
        "schema": {
            "$ref": "#\/definitions\/Error"
        }
    },
    "422": {
        "description": "validation error",
        "schema": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/ValidationError"
            }
        }
    }
}

[webron]

You mean it doesn't display it for default and 422?

[marcinskubala]

The model schemes for 200 and default are fine, but the 422 is an array of ValidationError and the "Model" and the "Model Scheme" tabs in UI are empty.

[webron]

Is there actually a ValidationError model in the definition? It would help if you shared your whole Swagger definition for testing.

[marcinskubala]

{
    "swagger": "2.0",
    "info": {
        "title": "XXX",
        "version": "XXX"
    },
    "host": "XXX",
    "basePath": "XXX",
    "schemes": [
        "http"
    ],
    "consumes": [
        "application\/x-www-form-urlencoded"
    ],
    "produces": [
        "application\/json",
        "application\/xml"
    ],
    "paths": {
        "\/media": {
            "post": {
                "tags": [
                    "Media Operations"
                ],
                "summary": "Create a new media",
                "parameters": [
                    {
                        "name": "title",
                        "in": "formData",
                        "description": "Media title",
                        "required": false,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Media Response",
                        "schema": {
                            "$ref": "#\/definitions\/Media"
                        }
                    },
                    "Default": {
                        "description": "Default Error",
                        "schema": {
                            "$ref": "#\/definitions\/Error"
                        }
                    },
                    "422": {
                        "description": "Validation Error",
                        "schema": {
                            "type": "array",
                            "items": {
                                "$ref": "#\/definitions\/ValidationError"
                            }
                        }
                    }
                }
            }
        }
    },
    "definitions": {
        "Media": {
            "required": [
                "id"
            ],
            "properties": {
                "id": {
                    "type": "integer"
                },
                "title": {
                    "type": "string"
                }
            }
        },
        "Error": {
            "required": [
                "code"
            ],
            "properties": {
                "code": {
                    "type": "integer"
                }
            }
        },
        "ValidationError": {
            "required": [
                "field"
            ],
            "properties": {
                "field": {
                    "type": "string"
                }
            }
        }
    }
}

[webron]

Which library produced that spec?

[marcinskubala]

zircote/swagger-php v2.x

[webron]

I believe this is related to swagger-api/swagger-js#270.

[webron]

@marcinskubala - do you mind if I use the Swagger definition you shared here to open an issue on swagger-php? There are three problems with it they should solve.

[marcinskubala]

@webron - fill free to share this code, thanks

[webron]

@marcinskubala - thanks.

@mohsen1 - can you please confirm this is the same issue?

[tlbdk]

Have the same issue, with this schema where the response model is missing for everything but 200:

{
    "swagger": "2.0",
    "info": {
        "version": "1.0.0",
        "title": "Test sample showing swagger error",
        "description": "Show that response headers are not rendered",
        "contact": {
            "name": "Troels Liebe Bentsen",
            "email": "[email protected]"
        }
    },
    "host": "localhost",
    "basePath": "/",
    "schemes": [
        "http"
    ],
    "consumes": [
        "application/json"
    ],
    "produces": [
        "application/json"
    ],
    "paths": {
        "/test": {
            "post": {
                "summary": "Test",
                "description": "Test stuff",
                "operationId": "doTest",
                "parameters": [
                    {
                        "in": "body",
                        "name": "body",
                        "required": true,
                        "schema": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/test"
                            }
                        }                       
                    },
                    {
                        "in": "header",
                        "name": "ETag",
                        "description": "Used as caching key for future requests",
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Test stuff response",
                        "schema": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/test"
                            }
                        },
                        "headers": {
                            "ETag": {
                                "description": "Used as caching key for future requests",
                                "type": "string"
                            }
                        }
                    },
                    "405": {
                        "description": "Invalid input",
                        "headers": {
                            "ETag": {
                                "description": "Used as caching key for future requests",
                                "type": "string"
                            }
                        },
                        "schema": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/test"
                            }
                        }
                    }
                },
                "tags": ["test"]
            }
        }
    },
    "definitions": {
        "test": {
            "required": [
                "test1",
                "test2"
            ],
            "properties": {
                "test1": {
                    "type": "string"
                },
               "test": {
                    "description": "Amount to be payment",
                    "type": "number",
                    "format": "double",
                    "default": 0
                }
            }
        }
    }
}

[fehguy]

@mohsen1 can you please look at this?

[tlbdk]

Updated to latest version from master and I still see the issue

[mohsen1]

I've spent some time looking into this issue. I don't know exactly what we should do here because the way we're passing responseModel to StatusCodeView is via optiosn.responseModel option which is a string and use that string to lookup router.api.models object

We're resolving $refs here but we're not doing it deeply. If we were to resolve deeply then should we pass the inner schema name string? If we do that, it's not accurate because the model should be the array.

I think $ref resolving mechanism needs a refactoring. We can't rely on little components resolve $refs little by little.

[ponelat]

I agree, a little refactoring would be great. I kinda went looking at the same problem...
#671 (comment)

[fehguy]

please follow parent issue #1248