Skip to content

Parameter description of null raises a validation error in Swagger-UI #395

Closed
@wleeper

Description

@wleeper

If you don't provide a desc: field for a parameter, the generated swagger spec has null as the value for description. This raises a validation error in Swagger-UI

ex:

{
"in": "query",
"name": "force_refresh",
"description": null,
"type": "string",
"required": false
},

Produces the following validation error

schemaValidationMessages": [
{
"level": "error",
"domain": "validation",
"keyword": "oneOf",
"message": "instance failed to match exactly one schema (matched 0 out of 2)",
"schema": {
"loadingURI": "http://swagger.io/v2/schema.json#",
"pointer": "/definitions/parametersList/items"
},
"instance": {
"pointer": "/paths/test/get/parameters/3"
}
},

Recommendation
Based on http://swagger.io/specification/#parameterObject the description is optional and should be omitted when nil

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions