API Metadata Overlay

Schema Definitions

• The root schema of the document is API Metadata Overlay
• The interface is available as JSON Schema: ApiMetadataOverlay.schema.json.

API Metadata Overlay

Type: Object($schema, apiMetadataOverlay)

Property	Type	Description
$schema OPTIONAL	string	Optional URL to the API Metadata Overlay schema (defined as a JSON Schema). If provided, this enables code intelligence and validation in supported editors (like VSCode) and tools. JSON Schema Format: uri-reference Array Item Allowed Values (extensible): Any string of format uri-reference "https://open-resource-discovery.org/spec-extension/models/ApiMetadataOverlay.schema.json#"
apiMetadataOverlay MANDATORY	string	Version of the API Metadata Overlay specification. Allowed Values: "1.0" Example Values: "1.0"