OpenAPI CLI Github Action
ActionsA wrapper around the redocly openapi-cli for linting and bundling OpenAPI definitions
v1.0.0
LatestBy trybeapp
Tags
(2)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.
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.
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.
OpenAPI CLI Github Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.