openapi-breaking-changes

Compare evitaDB OpenAPI REST schemas to identify breaking changes.

70|7|Updated Feb 22, 2023

Search Tags:#typescript #openapi #rest #breaking-changes #client-generation #api-diff #evitaDB

Ready to run

npx skills add https://github.com/FgForrest/evitaDB --skill openapi-breaking-changes

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: openapi-breaking-changes
Source: https://github.com/FgForrest/evitaDB/tree/main/.claude/skills/openapi-breaking-changes
Command: npx skills add https://github.com/FgForrest/evitaDB --skill openapi-breaking-changes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Compares the public evitaDB OpenAPI REST schema with a local server's schema to identify breaking changes that could affect downstream REST clients before merging or releasing.

Core Features & Use Cases

Compare the public demo REST schema against a locally built evitaDB server to surface breaking changes and their implications for TypeScript clients that auto-generate REST clients.
Generate a human-readable summary of changes and tailor discussions to downstream projects.

Quick Start

Run the OpenAPI breaking changes workflow to compare schemas and produce a report.

Frequently Asked Questions about openapi-breaking-changes

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I detect OpenAPI breaking changes before releasing a REST API?▼

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.

What is an OpenAPI breaking change and how does it impact TypeScript client generation?▼

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.

Do I need Docker to run an OpenAPI schema diff for evitaDB?▼

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.

Can I compare a local evitaDB server schema against the public demo REST schema?▼

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.

Does the OpenAPI breaking changes workflow modify source code during schema comparison?▼

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.