oasdiff

Compare and detect breaking changes in OpenAPI specs

Handy tool that lets you:

Do OpenAPI diffs in YAML, JSON, Text/Markdown or HTML
Do OpenAPI diffs of local files system or remote files over http/s
Display a user-friendly changelog of all important API changes

The following changes are detected in specifications:

Breaking changes
API deprecation
Multiple versions of the same endpoint
Path prefix modification
Path parameter renaming

dev

https://github.com/tufin/oasdiff

arm64 amd64

Installation

1. Add WakeMeOps repository

curl -sSL https://raw.githubusercontent.com/upciti/wakemeops/main/assets/install_repository | sudo bash

2. Install oasdiff

sudo apt install oasdiff

Snippets

DockerfileGithub Action

FROM wakemeops/minideb:bullseye

RUN install_packages \
    oasdiff=1.8.0*

USER 1001

- name: Install dependencies
  uses: upciti/wakemeops-action@v1
  with:
    packages: |
      oasdiff=1.8.0*

Download URLs

amd64arm64

Version	SHA256	Size (KB)
1.8.0	`7454b0fa2bd9cb729e14689dabe3b38c1b4933b63f3d4a25888d920eaf28487a`	3126
1.7.10	`a13d07cb5dd09c85105c05cb4f5fece86a4877cf6c86e0473aebe139e7435230`	3075
1.7.9	`90ab50c0da398852ec7d0cc37f5f37737659a56f31f9569c9895f14db2c32ff9`	3073

Version	SHA256	Size (KB)
1.8.0	`40ff8a149036dfc769d7402ba453c4ff7dd6625a46b6721611d2c23dd1b6b6e4`	2649
1.7.10	`a2389115cd777b893b090f28d96b095ed692d0fcedc730e817a3a5deb6c83df5`	2607
1.7.9	`c0a7e1d1f9ce8112e4958732f08c33a93478cd5a929cae8e24c7de37eb67ce96`	2603

Blueprints

Debian packages listed on this page are generated from op2deb YAML blueprints. Blueprints for oasdiff are versioned here.

Click here to see oasdiff ops2deb blueprints

https://github.com/upciti/wakemeops/blob/main/blueprints/dev/oasdiff/ops2deb.yml

name: oasdiff
matrix:
  architectures:
    - amd64
    - arm64
  versions:
    - 1.7.9
    - 1.7.10
    - 1.8.0
homepage: https://github.com/tufin/oasdiff
summary: compare and detect breaking changes in OpenAPI specs
description: |-
  Handy tool that lets you:

  - Do OpenAPI diffs in YAML, JSON, Text/Markdown or HTML
  - Do OpenAPI diffs of local files system or remote files over http/s
  - Display a user-friendly changelog of all important API changes

  The following changes are detected in specifications:

  - Breaking changes
  - API deprecation
  - Multiple versions of the same endpoint
  - Path prefix modification
  - Path parameter renaming
fetch: https://github.com/Tufin/oasdiff/releases/download/v{{version}}/oasdiff_{{version}}_linux_{{arch}}.tar.gz
script:
  - install -m 755 oasdiff {{src}}/usr/bin/

The blueprint fetch keyword contains a URL template pointing to oasdiff releases. Downloaded files are locked in a lockfile versioned here.

Click here to see oasdiff release hashes

https://github.com/upciti/wakemeops/blob/main/blueprints/dev/oasdiff/ops2deb.lock.yml

- url: https://github.com/Tufin/oasdiff/releases/download/v1.7.9/oasdiff_1.7.9_linux_amd64.tar.gz
  sha256: 65e3577085d272977a117290211d3f836b9d2c4845652597a99dcaf363959724
  timestamp: 2023-09-05 12:44:52+00:00
- url: https://github.com/Tufin/oasdiff/releases/download/v1.7.9/oasdiff_1.7.9_linux_arm64.tar.gz
  sha256: 738bb2f6f21100df02fb1fd57bd1b550a2fc5d09ab83de65fa0940973c67e6de
  timestamp: 2023-09-05 12:44:52+00:00
- url: https://github.com/Tufin/oasdiff/releases/download/v1.7.10/oasdiff_1.7.10_linux_amd64.tar.gz
  sha256: 5fb422f9081f582ec80d7881b710b2d21381a14d81b1e1a150ec19e9260ddc40
  timestamp: 2023-09-16 21:12:58+00:00
- url: https://github.com/Tufin/oasdiff/releases/download/v1.7.10/oasdiff_1.7.10_linux_arm64.tar.gz
  sha256: 2eb72246427360f33c7a747d946c771aa9eef77aea5663a5267d75bce2f056e5
  timestamp: 2023-09-16 21:12:58+00:00
- url: https://github.com/Tufin/oasdiff/releases/download/v1.8.0/oasdiff_1.8.0_linux_amd64.tar.gz
  sha256: f3e5c45f3f0c2f833d31444caa484717e1ea4d4c6f24e16abf7e0b93c5a2a21a
  timestamp: 2023-09-20 15:16:56+00:00
- url: https://github.com/Tufin/oasdiff/releases/download/v1.8.0/oasdiff_1.8.0_linux_arm64.tar.gz
  sha256: 0fd0c97585a9b438fe3b9656e8faab6e5f31da63c6ff59d3e271eae9766daf26
  timestamp: 2023-09-20 15:16:56+00:00

Badge

MarkdownHTMLRST

[![WakeMeOps](https://docs.wakemeops.com/badges/oasdiff.svg)](https://docs.wakemeops.com/packages/oasdiff)

<a href="https://docs.wakemeops.com/packages/oasdiff">
  <img src="https://docs.wakemeops.com/badges/oasdiff.svg"/>
</a>

.. image:: https://docs.wakemeops.com/badges/oasdiff.svg
:target: https://docs.wakemeops.com/packages/oasdiff