swagger-api / swagger-editor

Swagger Editor
https://editor.swagger.io
Apache License 2.0
8.84k stars 2.24k forks source link

Missing line break doesn't always trigger a validation error #1740

Open webron opened 6 years ago

webron commented 6 years ago
Q A
Bug or feature request? Bug
Which Swagger/OpenAPI version? 2.0 (could be 3.0 as well)
Which Swagger-Editor version? 3.5.2
How did you install Swagger-Editor? Online editor
Which browser & version? FF 61 (Nightly)
Which operating system? MacOS

Demonstration API definition

swagger: '2.0'
info:
  description: Weird validation bug
  version: "1.0.0"
  title: Validation Bug
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html

paths:
  /item/{dbId}:
    get:
      operationId: itemUse
      parameters:
      - in: path
        name: dbId
        required: true 
        description: 'bug!' type: string
      responses:
        '200':
          description: sucessful response

Expected Behavior

It should complain that either the YAML structure is invalid, or that the parameter is missing a type definition.

Notice that this only happens if the description is quoted, for obvious reasons, and it won't happen with fields other than string type.

Current Behavior

It ignores any validation issue and says it's all 🍑y.

Possible Solution

No idea, can't even fathom the cause.

Context

It doesn't work, @shockey.

shockey commented 6 years ago

Looks like js-yaml is actually letting this be parsed correctly, even though the YAML is invalid:

shockey commented 6 years ago

Closing in favor of https://github.com/nodeca/js-yaml/issues/418.

shockey commented 6 years ago

MOAR issues