UI Shows Single Example Response Model Only

[avishaan]

For code such as this

        "responses": {
          "default": {
            "description": "Invalid request.",
            "schema": {
              "$ref": "Error"
            }
          },
          "200": {
            "description": "Successful request.",
            "schema": {
              "$ref": "Error"
            }
          }
        }

Only the default is shown but not for "200". See screenshot below.

[avishaan]

This may be related to #671

[avishaan]

This seems to be something else. When I do this

I get this, which is to say nothing.

[avishaan]

@webron, any idea on this one?

[webron]

@codehatcher - any chance you can share your full spec?

[avishaan]

Here is an example, I tried to truncate some of it.

{
  "swagger": "2.0",
  "info": {
    "title": "title",
    "description": "descriptor",
    "version": "0.1"
  },
  "host": "localhost:3000",
  "consumes": [
    "application/json",
    "application/x-www-form-urlencoded"
  ],
  "produces": [
    "application/json"
  ],
  "basePath": "/api",
  "paths": {
    "/v1/auths/facebook": {
      "post": {
        "x-swagger-router-controller": "auths",
        "operationId": "facebook",
        "tags": ["auths"],
        "description": "Facebook authentication",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "Facebook Token",
            "required": true,
            "schema": {
              "$ref": "#/definitions/FacebookToken"
            }
          }
        ],
        "security": [
          {
            "facebookAuth": []
          }
        ],
        "responses": {
          "default": {
            "description": "Invalid request.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "200": {
            "description": "Successful request.",
            "schema": {
              "uid": "string",
              "token": "string",
              "username": "string"
            }
          }
        }
      }
    }
  },
  "securityDefinitions": {
    "basicAuth": {
      "type": "basic"
    },
    "tokenAuth": {
      "type": "apiKey",
      "description": "Built in token auth",
      "name": "access_token",
      "in": "query"
    },
    "facebookAuth": {
      "type": "apiKey",
      "description": "Facebook token auth using passport-facebook-token",
      "name": "access_token",
      "in": "query"
    }
  },
  "definitions": {
    "Review": {
      "properties": {
        "company": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "rating": {
          "type": "number"
        },
        "images": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "datetime": {
          "type": "number"
        },
        "location": {
          "type": "string"
        },
        "_id": {
          "type": "string"
        },
        "submitter": {
          "type": "string"
        }
      },
      "required": ["company", "description"]
    },
    "FacebookToken": {
      "properties": {
        "access_token": {
          "type": "string"
        }
      }
    },
    "UserRegistration": {
      "properties": {
        "username": {
          "type": "string"
        },
        "password": {
          "type": "string"
        }
      }
    },
    "Ok": {
      "properties": {
        "message": {
          "type": "string"
        }
      },
      "required": ["message"]
    },
    "Error": {
      "properties": {
        "message": {
          "type": "string"
        }
      },
      "required": ["message"]
    }
  }
}

which looks like the following:

[webron]

For the "200" response, the value is not a valid schema.

[avishaan]

If I change it to the following for the sake of a valid schema

        "responses": {
          "default": {
            "description": "Invalid request.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "200": {
            "description": "Successful request.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        }

Then 200 doesn't show up at all.

[webron]

Actually, it appears above the operation as the response. See #674 for more details.

[avishaan]

This was due to an invalid schema and not an issue.

[webron]

No problem, thank you for the update.

[avishaan]

@webron, I'm nervous about being back here because chances are something is wrong with my response body, but here goes. I am having the same problem as above but I believe my response object is correct. I verified it with the swagger-editor.

        "responses": {
          "400": {
            "description": "Successful request.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "200": {
            "description": "Successful request.",
            "schema": {
              "title": "Success",
              "required": ["token"],
              "properties": {
                "token": {
                  "type": "string"
                }
              }
            }
          }
        }

missing response in swagger-ui looks like:

but seems to be fine in swagger-editor:

[avishaan]

It also doesn't appear above the operation as the response:

[webron]

Yup, now you've hit #705, which will apply to any inline schema definitions.

Generally speaking, I'd advise not using inline schema definitions (unless they are primitives/arrays) even when they do get supported by the UI.

[avishaan]

Haha ok, thanks for the speedy response!

[webron]

As long as you keep opening issues late at night for you, you'll hit my early morning, and there's nothing like replying issues early in the morning ;)

[avishaan]

haha