respect

--input

string

Input parameters with values that are mapped to the workflow inputs description. For example, the following command maps the "userEmail" and "userPassword" inputs and values to all workflows in the test.yaml Arazzo description: npx @redocly/cli@latest respect test.yaml --input userEmail=name@redocly.com --input userPassword=12345. You can also use an environment variable to set the input, as in the following example: REDOCLY_CLI_RESPECT_INPUT='userEmail=name@redocly.com,userPassword=12345' npm run cli respect test.yaml

You can even include nested values, as in the following example command that maps the nestedKey input and value to all workflows in the test-file.yaml Arazzo description: npx @redocly/cli@latest respect test-file.yaml --input '{"key": "value", "nested": {"nestedKey": "nestedValue"}}'. You can also use an environment variable to set the input, as in the following example: REDOCLY_CLI_RESPECT_INPUT='{"key":"value","nested":{"nestedKey":"nestedValue"}}' npx @redocly/cli@latest respect test-file.yaml

--server

string

Server overrides for the sourceDescriptions object. For example, the following command runs all workflows from the test-file.yaml Arazzo description and instead of using the server listed in the API description, uses the server at https://test.com: npx @redocly/cli@latest respect test-file.yaml --server test=https://test.com.

You can also pass the server overrides as an environment variable, as in the following example: REDOCLY_CLI_RESPECT_SERVER="test=https://test.com".

--severity

string

Severity of the check. Customize the severity level of validation checks for status codes, schemas, and content types. Setting the severity level is useful when:

• You're actively developing your API and want to temporarily relax validation.
• You're testing new API behavior that doesn't match the current schema.
• You've encountered known issues that shouldn't block test execution.
• You want to treat certain validation failures as warnings instead of errors.

The following checks can be configured:

• STATUS_CODE_CHECK: Verifies if the status code returned with API responses matches the statuses described in the provided OpenAPI description.
• SCHEMA_CHECK: Verifies if the response body schema matches what is defined in the provided OpenAPI description.
• SUCCESS_CRITERIA_CHECK: Verifies if the success criteria defined in the provided Arazzo description has been met.
• CONTENT_TYPE_CHECK: Verifies if the Content-Type matches what is defined in the provided OpenAPI description.

The following severity values are available:

• error: Validation failures cause the workflow to fail.
• warn: Validation failures appear as warnings but don't fail the workflow.
• off: Validation checks still run, but their results are ignored.

For example, the following command sets status code errors to the warning severity level: npx @redocly/cli respect test-file.yaml --severity='{"STATUS_CODE_CHECK":"warn"}'.