Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Example fields being used as default values

See original GitHub issue

When using a json based swagger document, example values are being used a default values when default is not defined. The expectation is that example values would be ignored.

For example:

"paths": {
  "/companies": {
      "post": {
        "description": "Create a Company",
        "parameters": [
          {
            "name": "company",
            "in": "body",
            "description": "A Company",
            "required": true,
            "schema": {
              "$ref": "#/definitions/company"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "schema": {
              "$ref": "#/definitions/company"
            }
          },
          "406": {
            "description": "Not Acceptable"
          }
        }
      }
    }
},
"definitions": {
    "company": {
      "type": "object",
      "properties": {
        "id": {
          "description": "unique identifier of a company",
          "example": "01234567-89ab-cdef-0123-456789abcdef",
          "format": "uuid",
          "maxLength": 37,
          "readOnly": true,
          "type": "string"
        },
        "name": {
          "description": "name of company",
          "example": "acme",
          "maxLength": 255,
          "readOnly": false,
          "type": "string"
        },
        "code": {
          "description": "unique code of company",
          "maxLength": 255,
          "type": "string"
        },
        "created_at": {
          "description": "when company was created",
          "example": "2001-01-01T12:00:00Z",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "updated_at": {
          "description": "when company was updated",
          "example": "2001-01-01T12:00:00Z",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        }
      },
      "required": [
        "name",
        "code"
      ]
    }
}

When sending a POST request to the /companies endpoint where the code value is defined, but the name field is empty. The result is the value acme being used as if it were a default value.