Welcome to jsonschema-diff’s documentation!

Basic use

• Quick Start
  • CLI
  • Python Interface
  • Sphinx Extension
• Colorize
• Config Maker
• How read it?
  • Path
  • Prefixes
  • Multiline
  • Context
  • Combine
    • Custom comparators
      • Base Compare
      • List / Array Compare
      • Range Compare

Pro use / Develop it

• Workflow Cycle Overview
  • Prerequisites fixed since the previous draft
  • 1. Entry Point & Inputs
  • 2. Building the Property tree
  • 3. Comparator Selection (overview)
  • 4. Logical Combination of Parameters
  • 5. Context Expansion
  • 6. Rendering
  • 7. Call Timeline (cheat sheet)
• Comparator Rules Page
  • Precedence tiers
  • Declaration
    • Extending
• Combination Rules
  • Purpose
  • Rule format
    • Customising
• Context Rules Page
  • Tables
  • Resolution algorithm

Reference

• Type aliases
• API Reference
  • jsonschema_diff
    • Submodules
      • jsonschema_diff.cli
      • jsonschema_diff.color
      • jsonschema_diff.config_maker
      • jsonschema_diff.core
      • jsonschema_diff.pypi_interface
      • jsonschema_diff.sphinx
      • jsonschema_diff.table_render
    • Classes
    • Package Contents
      • ConfigMaker
      • JsonSchemaDiff