https://github.com/marketplace/actions/openapi-spec-diff

Skip to content
 
Sign up

  * Product
      + Features
      + Mobile
      + Actions
      + Codespaces
      + Copilot
      + Packages
      + Security
      + Code review
      + Issues
      + Integrations
      + GitHub Sponsors
      + Customer stories
  * Team
  * Enterprise
  * Explore
      + Explore GitHub
      + Learn and contribute
      + Topics
      + Collections
      + Trending
      + Skills
      + GitHub Sponsors
      + Open source guides
      + Connect with others
      + The ReadME Project
      + Events
      + Community forum
      + GitHub Education
      + GitHub Stars program
  * Marketplace
  * Pricing
      + Plans
      + Compare plans
      + Contact Sales
      + Education

[                    ] 

  *  
    #
    Search All GitHub |
    Jump to |

  * No suggested jump to results

  *  
    #
    Search All GitHub |
    Jump to |
  *  
    #
    Search All GitHub |
    Jump to |
  *  
    #
    Search All GitHub |
    Jump to |

Sign in
Sign up
{{ message }}

 1. Marketplace
 2. Actions
 3. OpenAPI Spec Diff

GitHub Action

OpenAPI Spec Diff

v2 Latest version
Use latest version

OpenAPI Spec Diff

A diff tool for OpenAPI Specification 3

Installation

Copy and paste the following snippet into your .yml file.

- name: OpenAPI Spec Diff
  uses: Tufin/oasdiff-action@v2

Learn more about this action in Tufin/oasdiff-action
Choose a version
 
v2

 oasdiff-action

CI

GitHub action for comparing OpenAPI specs, based on oasdiff tool

 How to use?

Copy and paste the following snippet into your build .yml file:

- name: Running OpenAPI Spec diff action
  id: test_breaking_changes
  uses: Tufin/oasdiff-action@v2
  with:
    base: 'specs/base.yaml'
    revision: 'specs/revision-breaking-changes.yaml'
    format: 'text'
    breaking-only: true
    fail-on-diff: true

 Inputs

 base

Required path of original OpenAPI spec in YAML or JSON format

 revision

Required path of revised OpenAPI spec in YAML or JSON format

 format

Optional output format: yaml, text or html (default "yaml")

 breaking-only

Optional display breaking changes only

 fail-on-diff

Optional fail with exit code 1 if a difference is found

Stars

Star 3

Contributors

@reuvenharrison @effoeffi

Categories

Dependency management API management

Links

Tufin/oasdiff-action Open issues 0 Pull requests 0 Report abuse

OpenAPI Spec Diff is not certified by GitHub. It is provided by a
third-party and is governed by separate terms of service, privacy
policy, and support documentation.

GitHub

Product

  * Features
  * Security
  * Team
  * Enterprise
  * Customer stories
  * The ReadME Project
  * Pricing
  * Resources
  * Roadmap

Platform

  * Developer API
  * Partners
  * Atom
  * Electron
  * GitHub Desktop

Support

  * Docs
  * Community Forum
  * Professional Services
  * Skills
  * Status
  * Contact GitHub

Company

  * About
  * Blog
  * Careers
  * Press
  * Inclusion
  * Social Impact
  * Shop

  * Twitter icon GitHub on Twitter
  * Facebook icon GitHub on Facebook
  * YouTube icon GitHub on YouTube
  * Linkedin icon GitHub on LinkedIn
  * GitHub mark GitHub's organization on GitHub

  * (c) 2022 GitHub, Inc.
  * Terms
  * Privacy
  * Site Map
  * What is Git?

You can't perform that action at this time.
You signed in with another tab or window. Reload to refresh your
session. You signed out in another tab or window. Reload to refresh
your session.