Inline Catalog

Overview

An Inline Catalog is a method for defining and storing schemas, API definitions, and configurations directly within Zilla's configuration file. This approach ensures fast access to schemas without relying on external registries.

catalog:
  type: inline
  options:
    subjects:
      items-snapshots:
        schema: |
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "status": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "status"
            ]
          }

Usage Example

Validating API Traffic with an HTTP Proxy

The http.json.schema example demonstrates how Zilla can act as an HTTP proxy that validates incoming API requests and outgoing responses against predefined JSON schemas. By embedding schemas inline, this configuration ensures strict validation without relying on external schema registries, improving API reliability and security.

Configuration (* required)

options

options

object

The inline specific options.

Property	Type	Description
options.subjects	object as map of named object properties	Unique identifier for schema categorization in the registry.
options.subjects.schema*	string	Definition specifying data structure and format in detail.
options.subjects.version	string	Default: latest