Skip to content

Use case: API and schema evolution #33

Closed

Description

@adityamukho

Summary

Add a use case: store each version of an API or database schema as a graph of types and fields, and check compatibility across versions.

The idea

Record types, fields and their relations for each version. Optionally record which clients use which fields. Then compare any two versions and see who a change affects.

Questions it answers

  • What changed between version A and version B?
  • Is this change breaking for any known client?
  • Which clients used this field when it was removed?

Why Minigraf fits

  • Schemas are graphs (types reference types), and nested references need recursion.
  • Versions map to valid time, so any two versions can be compared without separate copies.

Tools such as Buf already cover part of this for Protobuf, so the doc should focus on the history and client-impact angle.

Suggested content

  • The idea and how it differs from existing schema linters
  • A fact schema (type, field, references, client-uses, version)
  • A query for fields removed between two versions
  • A query for clients affected by a removed field

Notes


Generated by Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions