Skip to content
file-text

GitHub Action

openapi-validator-action

v1 Latest version

openapi-validator-action

file-text

openapi-validator-action

This action validates if the OpenAPI/Swagger schema file is valid or not

Installation

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

              

- name: openapi-validator-action

uses: thiyagu06/openapi-validator-action@v1

Learn more about this action in thiyagu06/openapi-validator-action

Choose a version

openapi-validator-action

This action validates whether the OpenAPI/Swagger schema file is valid or not

Inputs

filepath

Required Path of the OpenAPI schema file. Default is "openapi.yaml" at root. Path starts root of github repo. For example, if your schema is in schemas folder.

root
├── schemas
│   └── openapi.yaml
├── package.json
└── package-lock.json

You should use filepath: './schemas/openapi.yaml'

Example usage

- name: 'validate openapi schema'
  uses: thiyagu06/validate-github-action@v1
  with:
    filepath: 'openapi.yaml'

You can specify version with @v<release-version>. It follows semantic release. For latest release, please check releases page.