https://github.com/mvegter/openapi-diff-action

GitHub action to identify differences between Swagger or OpenApi specifications.
https://github.com/mvegter/openapi-diff-action

Last synced: about 1 month ago
JSON representation

GitHub action to identify differences between Swagger or OpenApi specifications.

• Host: GitHub
• URL: https://github.com/mvegter/openapi-diff-action
• Owner: mvegter
• License: mit
• Created: 2020-03-01T14:32:30.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-11-13T16:05:21.000Z (about 3 years ago)
• Last Synced: 2024-09-17T07:42:01.848Z (2 months ago)
• Language: Dockerfile
• Homepage:
• Size: 15.6 KB
• Stars: 26
• Watchers: 2
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OpenAPI Diff action

A GitHub Action to identify differences between Swagger or OpenApi specifications.

## Credits

This GitHub Action is a wrapper for the NPM `openapi-diff` package by Atlassian. See the following links for more information:

- https://www.npmjs.com/package/openapi-diff

- https://bitbucket.org/atlassian/openapi-diff/src

## Usage

```yaml

    steps:

      - name: Check out head branch

        uses: actions/checkout@v2

        with:

          path: head

      - name: Check out master branch

        uses: actions/checkout@v2

        with:

          ref: master

          path: base

      - name: Run OpenAPI Diff (from HEAD revision)

        uses: mvegter/[email protected]

        with:

          head-spec: head/spec/openapi.yaml

          base-spec: base/spec/openapi.yaml

```