Skip to main content

Supported Document Types

@open-resource-discovery/metadata-renderer renders the following API metadata formats into a structured, navigable UI.

OpenAPI​

OpenAPI (formerly Swagger) is the most widely-used standard for describing RESTful HTTP APIs. The renderer delegates to Scalar for a rich, interactive API reference experience, supporting OpenAPI 3.0, 3.1, and 2.0/Swagger documents in JSON or YAML.

AsyncAPI​

AsyncAPI describes event-driven and message-based APIs (Kafka, MQTT, WebSocket, etc.). Documents in AsyncAPI 2.x or 3.x format (JSON or YAML) are rendered via the official AsyncAPI React component.

A2A​

A2A (Agent-to-Agent) is Google's open protocol for communication between AI agents. Agent card JSON documents are rendered to show agent capabilities, skills, and endpoints.

MCP​

MCP (Model Context Protocol) is Anthropic's open standard for connecting AI models to external tools and data sources. MCP server card JSON documents are rendered to display available tools, resources, and prompts.

CSN Interop​

CSN (Core Schema Notation) interop is SAP's format for describing data models and their annotations in a machine-readable way. The renderer presents entity types, properties, and annotations in a structured layout.

ORD Overlay​

ORD Overlay is a patch format defined by the Open Resource Discovery specification. It allows teams to annotate and extend existing API metadata documents without modifying the originals. Overlay 0.1 documents (JSON or YAML) are rendered to show the set of patches and their targets.

Environment Compatibility​

The library is designed to be compatible with React 18+ applications and modern web browsers.

Please raise an issue if you encounter problems with specific UI libraries or framework integrations.