Online editor reports several nonsensical errors

[ztrange]

Bug

Q	A
Bug or feature request?	Bug
Which Swagger/OpenAPI version?	3.0.0
Which Swagger-Editor version?	3.1.9
How did you install Swagger-Editor?	npm i -S swagger-editor-dist
Which broswer & version?	chrome 62
Which operating system?	ubuntu 17.04

Demonstration API definition

openapi: 3.0.0
info:
  title: Example API
  description: Service API.
  version: 1.0.0
servers:
  - url: 'http://api.example.com'
paths:
  /login/local:
    post:
      tags:
        - login
      summary: Login using email or nickname
      description: Returns customer info and jwt access and refresh tokens
      security:
        - apiKey: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                emailOrNickname:
                  type: string
                  required: true
                password:
                  type: string
                  required: true
      responses:
        '200':
          description: Login successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Admin"
                  refreshToken:
                    type: string
        "401":
          description: "Unauthorized"
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-application-key
  schemas:
    Admin:
      type: object
      properties:
        _id:
          type: string
        name:
          type: object
          properties:
            first:
              type: string
            last:
              type: string
        email:
          type: object
          properties:
            address:
              type: string
            verified:
              type: boolean
            token:
              type: string
        password:
          type: string
        recoveryToken:
          type: string
        lastLogin:
          type: string
          format: date-time

Configuration (browser query string, constructor, config.yaml)

I'm using the default config

const editor = SwaggerEditorBundle({
      dom_id: '#swagger-editor',
      layout: 'StandaloneLayout',
      presets: [
        SwaggerEditorStandalonePreset
      ]
    })

Expected Behavior

I think my path definition is correct. I've read and re-read the 3.0 spec several times, I based my code on the examples on spec but I still get several weird errors: Mainly I don't want to use a component $ref on the requestBody. I've seen example code on the spec documentation and it looks like I should have that option

Current Behavior

Errors
Hide
Schema error at paths['/login/local'].post.requestBody
should have required property '$ref'
missingProperty: $ref
Jump to line 17
Schema error at paths['/login/local'].post.requestBody
should match exactly one schema in oneOf
Jump to line 17
Schema error at paths['/login/local'].post.requestBody.content['application/json']
should have required property 'examples'
missingProperty: examples
Jump to line 19
Schema error at paths['/login/local'].post.requestBody.content['application/json']
should match exactly one schema in oneOf
Jump to line 19
Schema error at paths['/login/local'].post.requestBody.content['application/json'].schema
should have required property '$ref'
missingProperty: $ref
Jump to line 20
Schema error at paths['/login/local'].post.requestBody.content['application/json'].schema
should match exactly one schema in oneOf
Jump to line 20
Schema error at paths['/login/local'].post.requestBody.content['application/json'].schema.properties['emailOrNickname']
should have required property '$ref'
missingProperty: $ref
Jump to line 23
Schema error at paths['/login/local'].post.requestBody.content['application/json'].schema.properties['emailOrNickname']
should match exactly one schema in oneOf
Jump to line 23
Schema error at paths['/login/local'].post.requestBody.content['application/json'].schema.properties['emailOrNickname'].required
should be array
Jump to line 25
Schema error at paths['/login/local'].post.requestBody.content['application/json'].schema.properties['password']
should have required property '$ref'
missingProperty: $ref
Jump to line 26
Schema error at paths['/login/local'].post.requestBody.content['application/json'].schema.properties['password']
should match exactly one schema in oneOf
Jump to line 26
Schema error at paths['/login/local'].post.requestBody.content['application/json'].schema.properties['password'].required
should be array
Jump to line 28

Context

I'm trying to migrate some bad documentation to something better using swagger 3

[ztrange]

Nevermind. I found out what breaks it. It is that I was using a required: boolean parameter inside a SchemaObject. I got confused with old swagger syntax. the correct syntax is:

openapi: 3.0.0
info:
  title: Example API
  description: Service API.
  version: 1.0.0
servers:
  - url: 'http://api.example.com'
paths:
  /login/local:
    post:
      tags:
        - login
      summary: Login using email or nickname
      description: Returns customer info and jwt access and refresh tokens
      security:
        - apiKey: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - emailOrNickname
                - password
              properties:
                emailOrNickname:
                  type: string
                password:
                  type: string
      responses:
        '200':
          description: Login successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    $ref: "#/components/schemas/Admin"
                  refreshToken:
                    type: string
        "401":
          description: "Unauthorized"
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-application-key
  schemas:
    Admin:
      type: object
      properties:
        _id:
          type: string
        name:
          type: object
          properties:
            first:
              type: string
            last:
              type: string
        email:
          type: object
          properties:
            address:
              type: string
            verified:
              type: boolean
            token:
              type: string
        password:
          type: string
        recoveryToken:
          type: string
        lastLogin:
          type: string
          format: date-time

[webron]

Thanks for reporting the issue and the fix. I'm going to reopen the ticket since we need to rework that validation message. It's not useful to users and we should do a better job at it.

[AlbinoDrought]

Similar nonsensical error when using bool (a non-existent type) instead of boolean. Here's an example:

openapi: "3.0.0"
info:
  version: 1.0.0
  title: A thing
  license:
    name: AGPL-3.0

paths:
  /excellence:
    get:
      responses:
        '200':
          description: "An excellent response"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/ExcellentThing"
components:
  schemas:
    ExcellentThing:
      description: "Something excellent"
      properties:
        extremelyExcellent:
          description: "If false, this item is only somewhat excellent"
          type: bool
          example: true

Errors:

Above schema with actual problem fixed: (bool -> boolean)

openapi: "3.0.0"
info:
  version: 1.0.0
  title: A thing
  license:
    name: AGPL-3.0

paths:
  /excellence:
    get:
      responses:
        '200':
          description: "An excellent response"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/ExcellentThing"
components:
  schemas:
    ExcellentThing:
      description: "Something excellent"
      properties:
        extremelyExcellent:
          description: "If false, this item is only somewhat excellent"
          type: boolean
          example: true

[shockey]

I've opened a pull request (#1985) that will close this issue.

Here's what Swagger Editor reports with my changes:

Structural error at [...]schema.properties.emailOrNickname.required
 should be an array of property names required within an object schema

Structural error at [...]schema.properties.password.required
 should be an array of property names required within an object schema

---

PS: @AlbinoDrought, the messaging for your example has been improved as well:

Structural error at [...]ExcellentThing.properties.extremelyExcellent.type
should be equal to one of the allowed values
allowedValues: array, boolean, integer, number, object, string

[maheshJosephSadashiv]

I too am facing a similar error. When I run the swagger generate spec -o ./doc/resources/swagger.json command it generates a spec that has two structural errors.

PLEASE help me out I can't understand what's going wrong.

[shockey]

@maheshJosephSadashiv this issue has been closed for over 9 months, please open a new one if you need help!