Redocly · JSON Structure

Redocly Config Structure

JSON structure documentation for the redocly.yaml configuration file.

Type: object Properties: 0
Artificial IntelligenceAPI CatalogAPI DocumentationArazzoDeveloper PortalGovernanceLintingMCPMonitoringOpenAPI

Redocly Config Structure is a JSON Structure definition published by Redocly.

Meta-schema:

JSON Structure

Raw ↑
{
  "title": "Redocly Configuration Structure",
  "description": "JSON structure documentation for the redocly.yaml configuration file.",
  "type": "object",
  "fields": [
    {
      "name": "apis",
      "type": "object",
      "required": false,
      "description": "Named API definitions. Each key is an API name used to reference it in CLI commands.",
      "additionalProperties": {
        "type": "object",
        "fields": [
          { "name": "root", "type": "string", "required": true, "description": "Path to root OpenAPI definition." },
          { "name": "extends", "type": "string or array", "required": false, "description": "Ruleset(s) to extend for this API." },
          { "name": "rules", "type": "object", "required": false, "description": "Per-API rule overrides." },
          { "name": "labels", "type": "array", "required": false, "description": "Labels for Realm catalog organization." }
        ]
      }
    },
    { "name": "extends", "type": "string or array", "required": false, "description": "Base ruleset(s) to extend (spec, recommended, recommended-strict, minimal)." },
    { "name": "rules", "type": "object", "required": false, "description": "Global rule configuration. Values: off, warn, error." },
    { "name": "theme", "type": "object", "required": false, "description": "Theming for Realm/Revel portals." },
    { "name": "plugins", "type": "array", "required": false, "description": "Paths to Redocly CLI plugins." },
    { "name": "decorators", "type": "object", "required": false, "description": "Decorator configuration for OpenAPI transformation." },
    { "name": "preprocessors", "type": "object", "required": false, "description": "Preprocessor configuration." }
  ]
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Structure
curl "https://apis.io/api/v1/json-structures/redocly-config-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.