redocly-openapi-cli-github-action

A Github action for running redocly openapi-cli commands

⌨️ Inputs

args

The arguments to be provided to the redocly openapi cli command. By default this is empty so that redocly openapi cli will print a note about its correct usage.

💡 Quick Start

Bundle

jobs:
  bundle:
    runs-on: ubuntu-latest
    name: bundle
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: openapi bundle
        uses: trybeapp/[email protected]
        with:
          args: 'bundle test/petstore.yml'

This example uses the bundle action to generate a HTML bundle for the petstore.yml OpenAPI definition.

Lint

jobs:
  lint:
    runs-on: ubuntu-latest
    name: lint
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: openapi lint
        uses: trybeapp/[email protected]
        with:
          args: 'lint test/petstore.yml'

This example validates your OpenAPI definition files to ensure they do not contain errors and have a valid structure according to the OpenAPI specifications.

📘 References

• Redocly OpenAPI CLI