Review media type prefixes in OpenAPI 2.0

Description

OpenAPI 2.0 media types use type/subtype syntax, such as application/json. A misspelled or inappropriate top-level type can misrepresent the content format and reduce interoperability between tools.

Potential impact

Documentation or generated clients may use the wrong media type.
Requests or responses may fail when server and client expectations differ.

Remediation

Check the media type for the actual data format and correct misspellings in its type and subtype. Review global and operation-level consumes and produces declarations, and align them with the actual Content-Type.

Examples

The first example misspells application/json as aplication/json.

Before

json

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

After