Redocly · Example Payload

Redocly Config Example

Example redocly.yaml configuration for a multi-API project with linting rules

AIAPI CatalogAPI DocumentationArazzoDeveloper PortalGovernanceLintingMCPMonitoringOpenAPI

Redocly Config Example is an example object payload from Redocly, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

descriptionfilenamecontent_as_json

Example Payload

{
  "description": "Example redocly.yaml configuration for a multi-API project with linting rules",
  "filename": "redocly.yaml",
  "content_as_json": {
    "apis": {
      "petstore@v1": {
        "root": "openapi/petstore-v1.yaml",
        "extends": ["recommended"],
        "rules": {
          "operation-description": "warn",
          "tag-description": "off"
        }
      },
      "payments@v2": {
        "root": "openapi/payments-v2.yaml",
        "extends": ["recommended-strict"],
        "labels": ["payments", "billing"]
      }
    },
    "extends": ["recommended"],
    "rules": {
      "no-invalid-media-type-examples": "error",
      "operation-operationId": "error",
      "operation-summary": "error",
      "security-defined": "warn"
    },
    "theme": {
      "openapi": {
        "showExtensions": true,
        "sortPropsAlphabetically": true
      }
    }
  }
}