Skip to content

This GitHub Action validates OpenAPI 2.0, OpenAPI 3.x.y and AsyncAPI 2.x definition file using ApiDOM Language Service.

License

Notifications You must be signed in to change notification settings

char0n/apidom-validate

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ApiDOM Validator GitHub Action

This GitHub Action validates OpenAPI 2.0, OpenAPI 3.x.y and AsyncAPI 2.x definition file using ApiDOM Language Service.

Validation rules are exactly the same as the one that https://editor-next.swagger.io/ uses.

Supported specifications:

Inputs

definition-file

Required Path to definition file.

fails-on

Severity level at which to fail action. Default 1, if not specified.

  • 1: Fails if error messages exist in validation output
  • 2: Fails if error or warning messages exist in validation output
  • 3: Fails if error, warning or information messages exist in validation output
  • 4: Fails if error, warning, information or hint messages exist in validation output

Example usage

uses: char0n/apidom-validate@v1
with:
  definition-file: 'path/to/my/openapi.yaml'
  fails-on: 2