Incorrect parameter object reference (OpenAPI 2.0)

Description

A $ref used in a parameter location must point to a Parameter Object. Substituting another kind of object, such as a schema, does not provide the required parameter information, including its name and location.

Potential impact

Specification validation or client generation may fail, or request parameters may be represented incorrectly.

Remediation

For a shared parameter, reference the correct definition under #/parameters/.... External files are also supported; verify that the target is a valid Parameter Object.

Examples

These POST examples replace the reference to the User schema in a parameter location with a reference to limitParam.

Before

json

{
  "swagger": "2.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "post": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "200": {
            "description": "A user",
            "schema": {
              "$ref": "#/definitions/User"
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/definitions/User"
          }
        ]
      }
    }
  },
  "parameters": {
    "limitParam": {
      "name": "limit",
      "in": "body",
      "description": "max records to return",
      "required": true,
      "schema": {
        "type": "integer"
      }
    }
  },
  "definitions": {
    "User": {
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}

After