Welcome to genschema documentation!

Basic use

• Quick Start
  • genschema CLI Tool
    • Features
    • Usage
      • Arguments
      • Options
    • Examples
      • Read single file and write schema to disk
      • Multiple files → anyOf combination
      • Read from stdin
      • Use oneOf instead of anyOf
      • Extract shared refs
      • Tune ref extraction
      • Disable most refinements (minimal schema)
    • Exit Codes
    • Output
    • Implementation Notes
  • Python Interface
    • Postprocessing shared references
    • See also
  • Postprocessing
    • Why this is separate
    • Basic example
    • Single JSON also works
    • CLI support
    • Configuration
    • How similarity works
    • Minimum structure size
    • Result shape
    • Notes
  • Writing Custom Comparators
    • Overview
    • Built-in Comparator Examples
    • Where Comparators Run
    • Core Types and Interfaces
    • Comparator Result Contract
    • Minimal Comparator Example
    • Adding JSON Schema Version
    • Working With Alternatives (anyOf / oneOf)
    • Using Input Data
    • Best Practices
    • Registering a Comparator (Python)
    • Registering a Comparator (CLI)
    • Troubleshooting

Reference

• API Reference
  • genschema
    • Submodules
      • genschema.cli
      • genschema.comparators
      • genschema.node
      • genschema.pipeline
      • genschema.postprocessing
      • genschema.pseudo_arrays
    • Classes
    • Package Contents
      • Converter
      • PseudoArrayHandler
      • PseudoArrayHandlerBase