Linting Rules - Swagger V2 Produce XML Media Type

Number of APIs: 2

This is a Spectral governance rule to make sure that a Swagger definition produces a application/xml media type. Here is a JSON version of the rule that can be applied using this API-driven collection API, or at CLI or CI/CD pipeline.

{
  "swagger-v2-produce-xml-media-type": {
    "description": "Ensures that an API produces application/xml media type.",
    "message": "APIs should produce a application/xml media type.",
    "severity": "error",
    "recommended": true,
    "format": "oas2",
    "given": "$..consumes.*",
    "then": {
      "function": "schema",
      "functionOptions": {
        "schema": {
          "type": "string",
          "enum": [
            "application/xml"
          ]
        }
      }
    }
  }
}

This request can be run as part of this collection, or dragged and dropped to another collection of governance requests organized by folder, demonstrating how API governance linting works, but also providing a rule that can be used as part of your wider API governance strategy.

  1. Swagger V2 Produce XML Media Type POST {{baseUrl}}/linter/?rulesUrl=https://rules.linting.org/rules/swagger-v2-produce-xml-media-type/

  2. Swagger V2 Produce XML Media Type POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/swagger-v2-produce-xml-media-type/