All arguments can be passed with one or two leading minus signs.
 For example -breaking-only and --breaking-only are equivalent. The Text/Markdown di

GitHub - Tufin/oasdiff: A diff tool for OpenAPI Specification 3

submited by
Style Pass
2022-05-14 12:30:06

All arguments can be passed with one or two leading minus signs. For example -breaking-only and --breaking-only are equivalent.

The Text/Markdown diff report provides a simplified and partial view of the changes. To view all details, use the default format: YAML. If you'd like to see additional details in the text/markdown report, please submit a feature request.

The HTML diff report provides a simplified and partial view of the changes. To view all details, use the default format: YAML. If you'd like to see additional details in the HTML report, please submit a feature request.

Paths vs. Endpoints OpenAPI Specification has a hierarchial model of Paths and Operations (HTTP methods). oasdiff respects this heirarchy and displays a hierarchial diff with path changes: added, deleted and modified, and within the latter, "modified" section, another set of operation changes: added, deleted and modified. For example:

The modified endpoints section has two items per key, method and path, this is called a complex mapping key in YAML. Some YAML libraries don't support complex mapping keys, for example, python's PyYAML. Here's possible solution.

Leave a Comment