swagger-api / swagger-api/validator-badge

Validator throws exception on non-string default values for model properties

Open
#23 10 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug P1
Dominant language
Java
Stars
227
Forks
81
Avg merge
2h 3m
Merged PRs (30d)
1

Description

This will cause an error in the validator
http://online.swagger.io/validator/debug?url=

{
  "properties" : {
    "success" : {
      "type" : "boolean",
      "default" : false
    }
  }
}

But this is ok:

{
  "properties" : {
    "success" : {
      "type" : "boolean",
      "default" : true
    }
  }
}

And so is this:

{
  "properties" : {
    "success" : {
      "type" : "boolean",
      "default" : "false"
    }
  }
}

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the validator debug URL and the three JSON examples in the issue, comparing boolean false with boolean true and the string "false" as default values. Reproduce the failure, trace the validator's handling of model-property defaults, and consider the issue done when valid non-string defaults no longer throw an exception and the contrasting examples behave consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.