Can it detect changes if I haven't updated the spec file yet?

Yes, the skill can analyze source code decorators and annotations to detect changes directly from your Git diff before they are even reflected in the spec.

What types of breaking changes does it identify?

It automatically flags endpoint removals, new required parameters, response field deletions, type changes, enum value removals, and URL path changes.

Does this skill support both JSON and YAML formats?

Yes, it can parse and compare both JSON and YAML versions of OpenAPI and Swagger specifications.

Is it compatible with older Swagger versions?

Yes, it is designed to handle both Swagger 2.x and OpenAPI 3.x structures, including definitions and components/schemas.

How does the multi-language output work?

The skill checks for Korean characters in your code or spec files; if found, it generates the changelog in Korean, otherwise it defaults to English.

OpenAPI Diff & Changelog

Name: OpenAPI Diff & Changelog
Author: getsolaris

bygetsolaris

Desarrollo de API

Generates comprehensive API changelogs and detects breaking changes by analyzing Git diffs of OpenAPI specifications and source code.

Acerca de

The openapi-diff skill empowers developers to maintain clear, accurate API documentation by automatically tracking changes between versions of OpenAPI (3.x) and Swagger (2.x) files. It leverages Git diffs to identify modifications in endpoints, schemas, parameters, and deprecations, while specifically flagging breaking changes like removed response fields or altered types. Whether analyzing raw spec files or source code annotations, this skill ensures that stakeholders stay informed about API evolution through structured Markdown changelogs that can be directly integrated into pull requests or release notes.

Características Principales

Proactive identification of breaking changes such as type changes or field removals
0 GitHub stars
Support for both OpenAPI 3.x and Swagger 2.0 specifications
Source code analysis for API decorators and annotations to detect implicit changes
Automated detection of API endpoint and schema modifications using Git diff
Multi-language support, automatically generating changelogs in Korean or English based on input

Casos de Uso

Documenting schema evolution for frontend and mobile teams during rapid development
Performing impact analysis before merging PRs to prevent accidental breaking changes
Generating automated release notes and changelogs for API version updates

Acerca de

Características Principales

Proactive identification of breaking changes such as type changes or field removals
0 GitHub stars
Support for both OpenAPI 3.x and Swagger 2.0 specifications
Source code analysis for API decorators and annotations to detect implicit changes
Automated detection of API endpoint and schema modifications using Git diff
Multi-language support, automatically generating changelogs in Korean or English based on input

Casos de Uso

Documenting schema evolution for frontend and mobile teams during rapid development
Performing impact analysis before merging PRs to prevent accidental breaking changes
Generating automated release notes and changelogs for API version updates