Resolver error ... allOf must be an array

[sundriver]

HI Everyone,
I am trying to embed the following swagger doc into my web application.
The file renders correctly on editor.swagger.io but when i deploy on my local setup, I get:

Here is the error screenshot

Resolver error at paths./user.post.responses.201.schema.allOf
allOf must be an array
Resolver error at definitions.UserUpdateRequest.allOf
allOf must be an array
Resolver error at definitions.UserDetailResponse.allOf
allOf must be an array

I appreciate your comments,
Ali

• swagger-ui version 3.1.1
• a swagger file reproducing the issue

{
  "swagger": "2.0",
  "info": {
    "title": "Test title",
    "description": "Test descripiton",
    "version": "1.0.0",
    "contact": {
      "name": "No Contact Name provided",
      "url": "http://www.test.com",
      "email": "test@test.com"
    }
  },
  "host": "localhost:3000",
  "schemes": [
    "http"
  ],
  "basePath": "/api/v1.0",
  "produces": [
    "application/json"
  ],
  "paths": {
    "/user": {
      "post": {
        "operationId": "createUser",
        "summary": "Create a new User",
        "description": "This call will create a new User and returns it back to the callee.\n",
        "tags": [
          "User"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/UserCreateRequest"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "The new User, in detailed view.",
            "schema": {
              "$ref": "#/definitions/UserDetailResponse"
            }
          },
          "422": {
            "$ref": "#/responses/ErrorResponse422"
          }
        }
      }
    }
  },
  "parameters": {
    "userId": {
      "name": "userId",
      "in": "path",
      "description": "User id",
      "required": true,
      "type": "string"
    }   
  },
  "definitions": {
    "AppSummaryResponse": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of entity"
        },
        "url": {
          "type": "string",
          "description": "URL pointing to this entity for getting detailed view"
        },
        "deleted_at": {
          "type": "string",
          "description": "When this entry was marked to be deleted"
        }
      }
    },
    "AppCreateRequest": {
      "type": "object",
      "properties": {}
    },
    "AppDetailResponse": {
      "type": "object",
      "properties": {
        "created_by": {
          "type": "string",
          "description": "The user who created the entry"
        },
        "created_at": {
          "type": "string",
          "description": "The timestamp when this entry was created"
        },
        "updated_by": {
          "type": "string",
          "description": "The user who most recently updated the entry"
        },
        "updated_at": {
          "type": "string",
          "description": "When was the entry was most recently updated"
        },
        "deleted_by": {
          "type": "string",
          "description": "The user who deleted the entry"
        }
      }
    },
    "UserCommonFields": {
      "type": "object",
      "properties": {}
    },
    "UserCreateRequest": {
      "allOf": [
        {
          "$ref": "#/definitions/AppCreateRequest"
        },
        {
          "$ref": "#/definitions/UserCommonFields"
        },
        {
          "type": "object",
          "required": [
            "name",
            "email",
            "password"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 255
            },
            "description": {
              "type": "string",
              "maxLength": 1024
            },
            "external_uri": {
              "type": "string",
              "format": "url"
            },
            "email": {
              "type": "string",
              "format": "email"
            },
            "password": {
              "type": "string",
              "minLength": 8,
              "maxLength": 20
            }
          }
        }
      ]
    },
     "AppUpdateRequest": {
      "type": "object"
    },
      "UserSummaryResponse": {
      "allOf": [
        {
          "$ref": "#/definitions/AppSummaryResponse"
        },
        {
          "$ref": "#/definitions/UserCommonFields"
        },
        {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            }
          }
        }
      ]
    },
    "UserUpdateRequest": {
      "allOf": [
        {
          "$ref": "#/definitions/AppUpdateRequest"
        },
        {
          "$ref": "#/definitions/UserCommonFields"
        },
        {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 255
            },
            "description": {
              "type": "string",
              "maxLength": 1024
            },
            "external_uri": {
              "type": "string",
              "format": "url"
            },
            "email": {
              "type": "string",
              "format": "email"
            },
            "password": {
              "type": "string",
              "minLength": 8,
              "maxLength": 20
            }
          }
        }
      ]
    },
    "UserDetailResponse": {
      "allOf": [
        {
          "$ref": "#/definitions/AppDetailResponse"
        },
        {
          "$ref": "#/definitions/UserSummaryResponse"
        },
        {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "external_uri": {
              "type": "string"
            },
            "email": {
              "type": "string"
            }
          }
        }
      ]
    },
    "Error": {
      "type": "object",
      "properties": {
        "error_code": {
          "type": "string"
        },
        "resource_name": {
          "type": "string"
        }
      }
    },
    "ErrorMessage": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string"
        },
        "errors": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Error"
          }
        }
      }
    },
    "SingleErrorMessage": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string"
        }
      }
    }
  },
  "responses": {
    "ErrorResponse400": {
      "description": "Bad request, problems parsing JSON",
      "schema": {
        "$ref": "#/definitions/SingleErrorMessage"
      }
    },
    "ErrorResponse401": {
      "description": "Request failed because user is not authenticated",
      "schema": {
        "$ref": "#/definitions/SingleErrorMessage"
      }
    },
    "ErrorResponse403": {
      "description": "Request failed because user does not have authorization to access a specific resource",
      "schema": {
        "$ref": "#/definitions/SingleErrorMessage"
      }
    },
    "ErrorResponse422": {
      "description": "Your request was understood, but contained invalid parameters",
      "schema": {
        "$ref": "#/definitions/ErrorMessage"
      }
    },
    "CreateResponse": {
      "description": "Entry created successfully",
      "headers": {
        "location": {
          "type": "string",
          "description": "Link to newly created entry."
        }
      }
    }
  }
}

[shockey]

Hi @sundriver, I'm not seeing the allOf errors when I paste that spec into 3.1.1, but I do see this:

Resolver error at paths./user.post.parameters.0.schema.$ref
Could not resolve reference: #/definitions/UserCreateRequest

Resolver error at definitions.UserUpdateRequest.allOf.0.$ref
Could not resolve reference: #/definitions/AppUpdateRequest

Resolver error at definitions.UserDetailResponse.allOf.1.$ref
Could not resolve reference: #/definitions/UserSummaryResponse

Are you certain this is the complete spec that yielded the allOf error?

[sundriver]

Hi @shockey and everyone, I added the missing parts, I also added a screenshot of the error.

[webron]

@sundriver much like @shockey, I'm unable to reproduce the error with the attached spec. Would you mind re-downloading the UI and trying again?

[sundriver]

Hi @webron @shockey
I updated my local swagger-ui to 3.1.2
I am trying to embed swagger-ui within my react project like below.

const  SwaggerUi = require('swagger-ui');
const presets = require('swagger-ui').presets;

SwaggerUi({
                dom_id: '#swaggerContainer',
                spec: spec,
                presets: [presets.apis],
            });

the spec is the json above and I am getting http://imgur.com/a/urptj

Thanks,

[webron]

Missed the fact you're embedding it into your app and that it works as expected in the editor.

The weird part is that the first error your getting doesn't even make sense with the definition you provided, because if you follow the path it points to, it doesn't even exist.

@shockey could this be a dependency issue?

[shockey]

@webron, it could be - this is pretty weird indeed.

@sundriver:

• is this still happening?
• Can you add a console.log above where you call SwaggerUi({...}), to double check that the spec matches what you provided above?
• How are you installing Swagger-UI?

[shockey]

I'm going to guess that you're getting it via npm, since you're working in React and I can see your require call in your snippet above. Try running rm -rf node_modules && npm i in your project... you might have an outdated dependency that's breaking something, as @webron mentioned.

[shockey]

closing due to inactivity!