https://github.com/swaggerexpert/apidom-validate

This GitHub Action validates OpenAPI 2.0, OpenAPI 3.x.y and AsyncAPI 2.x definition file using ApiDOM Language Service.
https://github.com/swaggerexpert/apidom-validate

asyncapi asyncapi2 openapi openapi2 openapi3 openapi31 swagger validate validator

Last synced: 2 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/swaggerexpert/apidom-validate
• Owner: swaggerexpert
• License: apache-2.0
• Created: 2023-03-20T19:34:02.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-30T09:15:19.000Z (8 days ago)
• Last Synced: 2024-12-30T09:25:52.736Z (8 days ago)
• Topics: asyncapi, asyncapi2, openapi, openapi2, openapi3, openapi31, swagger, validate, validator
• Language: JavaScript
• Homepage: https://github.com/marketplace/actions/apidom-validator
• Size: 54.7 KB
• Stars: 4
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yaml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# ApiDOM Validator GitHub Action

This GitHub Action validates [OpenAPI 2.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md), [OpenAPI 3.x.y](https://spec.openapis.org/#openapi-specification) 

and [AsyncAPI 2.x](https://www.asyncapi.com/docs/reference/specification/v2.x) definition file using [ApiDOM Language Service](https://github.com/swagger-api/apidom).

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

**Supported specifications:**

- [OpenAPI 2.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md)

- [OpenAPI 3.0.0](https://spec.openapis.org/oas/v3.0.0.html)

- [OpenAPI 3.0.1](https://spec.openapis.org/oas/v3.0.1.html)

- [OpenAPI 3.0.2](https://spec.openapis.org/oas/v3.0.2.html)

- [OpenAPI 3.0.3](https://spec.openapis.org/oas/v3.0.3.html)

- [OpenAPI 3.0.4](https://spec.openapis.org/oas/v3.0.4.html)

- [OpenAPI 3.1.0](https://spec.openapis.org/oas/v3.1.0.html)

- [AsyncAPI 2.0.0](https://v2.asyncapi.com/docs/reference/specification/v2.0.0)

- [AsyncAPI 2.1.0](https://v2.asyncapi.com/docs/reference/specification/v2.1.0)

- [AsyncAPI 2.2.0](https://v2.asyncapi.com/docs/reference/specification/v2.2.0)

- [AsyncAPI 2.3.0](https://v2.asyncapi.com/docs/reference/specification/v2.3.0)

- [AsyncAPI 2.4.0](https://v2.asyncapi.com/docs/reference/specification/v2.4.0)

- [AsyncAPI 2.5.0](https://v2.asyncapi.com/docs/reference/specification/v2.5.0)

- [AsyncAPI 2.6.0](https://v2.asyncapi.com/docs/reference/specification/v2.6.0)

## 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

```yaml

uses: swaggerexpert/apidom-validate@v1

with:

  definition-file: 'path/to/my/openapi.yaml'

  fails-on: 2

```