openapi-breaking-changes

To detect OpenAPI breaking changes, compare your locally built server schema against the public evitaDB REST schema using the openapi-diff tool. This read-only workflow identifies breaking changes that could affect downstream TypeScript clients before merging or releasing.

An OpenAPI breaking change is a modification in the REST schema that breaks existing API contracts. It impacts TypeScript client generation by causing auto-generated REST clients to fail, requiring downstream projects to update their code before the new API version is released.

You do not strictly need Docker to run an OpenAPI schema diff for evitaDB. You can execute the openapi-diff tool via Docker or a local script, depending on your environment setup and whether you prefer containerized or native execution.

Yes, you can compare a local evitaDB server schema against the public demo REST schema. This requires a running local server and access to the public demo schema URL to generate a human-readable summary of breaking changes.

The OpenAPI breaking changes workflow does not modify source code during schema comparison. It operates as a read-only evaluation, ensuring your local evitaDB server and public REST schema remain untouched while producing a diff report.