Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
file-text

GitHub Action

ApiDOM Validator

v1.0.0

ApiDOM Validator

file-text

ApiDOM Validator

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

Installation

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

 
              
- name: ApiDOM Validator

              
  uses: char0n/[email protected]
Learn more about this action in char0n/apidom-validate

Choose a version

ApiDOM Validator GitHub Action

This GitHub Actions validates OpenAPI 3.x.y / 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:

  • OpenAPI 3.0.0
  • OpenAPI 3.0.1
  • OpenAPI 3.0.2
  • OpenAPI 3.0.3
  • OpenAPI 3.1.0
  • AsyncAPI 2.0.0
  • AsyncAPI 2.1.0
  • AsyncAPI 2.2.0
  • AsyncAPI 2.3.0
  • AsyncAPI 2.4.0
  • AsyncAPI 2.5.0
  • AsyncAPI 2.6.0

Inputs

definition-file

Required Path to definition file.

Example usage

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