Skip to content
Platform Status

CLI

openapi

speakeasy lint openapi

Lint an OpenAPI document

Details

Section titled “Details”

Lint

Section titled “Lint”

OpenAPI

Section titled “OpenAPI”

Validates an OpenAPI document is valid and conforms to the Speakeasy OpenAPI specification.

Usage

Section titled “Usage”
speakeasy lint openapi [flags]

Options

Section titled “Options”
      --dry-run                       run dry-run SDK generation to surface target-specific warnings
  -H, --header string                 header key to use if authentication is required for downloading schema from remote URL
  -h, --help                          help for openapi
      --max-validation-errors int     limit the number of errors to output (default 1000, 0 = no limit) (default 1000)
      --max-validation-warnings int   limit the number of warnings to output (default 1000, 0 = no limit) (default 1000)
      --non-interactive               force non-interactive mode even when running in a terminal
  -r, --ruleset string                ruleset to use for linting (default "speakeasy-recommended")
  -s, --schema string                 local filepath or URL for the OpenAPI schema
      --suggestions                   fetch and display SDK generation suggestions
      --token string                  token value to use if authentication is required for downloading schema from remote URL

Options inherited from parent commands

Section titled “Options inherited from parent commands”
      --logLevel string   the log level (available options: [info, warn, error]) (default "info")

Parent Command

Section titled “Parent Command”
  • speakeasy lint - Lint/Validate OpenAPI documents and Speakeasy configuration files