{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"respect","__idx":0},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["respect"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this command to execute API tests described in an Arazzo description."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"usage","__idx":1},"children":["Usage"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","header":{"controls":{"copy":{}}},"source":"npx @redocly/cli@latest respect <your-test-file | multiple files | files bash query> [-w | --workflow] [-s | --skip] [-v | --verbose] [-i | --input] [-S | --server] [-H | --har-output] [-J | --json-output]\n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"options","__idx":2},"children":["Options"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"20%","data-label":"Option"},"children":["Option "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"15%","data-label":"Type"},"children":["Type "]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["-w, --workflow"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["[string]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Workflow names from the test file to run."," ","For example, the following command runs \"first-flow\" and \"second-flow\" workflows from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["test-file.yaml"]}," Arazzo description:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli@latest respect test-file.yaml --workflow first-flow second-flow"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--workflow"]}," option can't be used with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--skip"]},"."]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["-s, --skip"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["[string]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Workflow names from the test file to skip."," ","For example, the following command skips the \"first-flow\" workflow from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["test-file.yaml"]}," Arazzo description:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli@latest respect test-file.yaml --skip first-flow"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--skip"]}," option can't be used with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--workflow"]},"."]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["-v, --verbose"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Runs the command in verbose mode to help with troubleshooting issues."," ","For example, the following command runs all workflows from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["test-file.yaml"]}," Arazzo description in verbose mode:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli@latest respect test-file.yaml --verbose"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["--har-output"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Path for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["har"]}," file for saving logs."," ","For example, the following command runs all workflows from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["test-file.yaml"]}," Arazzo description and saves the logs to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["logs.har"]}," file:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli@latest respect test-file.yaml --har-output='logs.har'"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["--json-output"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Path for the JSON file for saving logs. For example, the following command runs all workflows from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["test-file.yaml"]}," Arazzo description and saves the logs to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["logs.json"]}," file:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli@latest respect test-file.yaml --json-output='logs.json'"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["--input"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["test.yaml"]}," Arazzo description:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli@latest respect test.yaml --input userEmail=name@redocly.com --input userPassword=12345"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also use an environment variable to set the input, as in the following example:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REDOCLY_CLI_RESPECT_INPUT='userEmail=name@redocly.com,userPassword=12345' npm run cli respect test.yaml"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can even include nested values, as in the following example command that maps the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nestedKey"]}," input and value to all workflows in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["test-file.yaml"]}," Arazzo description:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli@latest respect test-file.yaml --input '{\"key\": \"value\", \"nested\": {\"nestedKey\": \"nestedValue\"}}'"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also use an environment variable to set the input, as in the following example:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REDOCLY_CLI_RESPECT_INPUT='{\"key\":\"value\",\"nested\":{\"nestedKey\":\"nestedValue\"}}' npx @redocly/cli@latest respect test-file.yaml"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["--server"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Server overrides for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sourceDescriptions"]}," object."," ","For example, the following command runs all workflows from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["test-file.yaml"]}," Arazzo description and instead of using the servers listed in the API description, uses the specified servers:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli@latest respect test-file.yaml --server sourceDescriptionName1=https://test.com --server sourceDescriptionName2=https://test2.com"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also pass multiple server overrides as an environment variable by separating them with commas, as in the following example:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REDOCLY_CLI_RESPECT_SERVER=\"sourceDescriptionName1=https://test.com,sourceDescriptionName2=https://test2.com\""]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["--severity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You're actively developing your API and want to temporarily relax validation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You're testing new API behavior that doesn't match the current schema."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You've encountered known issues that shouldn't block test execution."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You want to treat certain validation failures as warnings instead of errors."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following checks can be configured:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["STATUS_CODE_CHECK"]},": Verifies if the status code returned with API responses matches the statuses described in the provided OpenAPI description."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SCHEMA_CHECK"]},": Verifies if the response body schema matches what is defined in the provided OpenAPI description."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SUCCESS_CRITERIA_CHECK"]},": Verifies if the success criteria defined in the provided Arazzo description has been met."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTENT_TYPE_CHECK"]},": Verifies if the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}," matches what is defined in the provided OpenAPI description."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following severity values are available:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]},": Validation failures cause the workflow to fail."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warn"]},": Validation failures appear as warnings but don't fail the workflow."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["off"]},": Validation checks still run, but their results are ignored."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Setting the severity of a check to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["off"]}," does not prevent the check from executing - it only prevents the check's results from affecting the workflow outcome."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For example, the following command sets status code errors to the warning severity level:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli respect test-file.yaml --severity='{\"STATUS_CODE_CHECK\":\"warn\"}'"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":3},"children":["Examples"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Run the tests by running the following command: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli@latest respect <your-test-file>"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Run multiple tests by running the following command: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli@latest respect <your-test-file-one> <your-test-file-two>"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Run multiple tests by running the following command with bash selector : ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli@latest respect $(find ./path-to-tests-folder -type f -name '*.arazzo.yaml')"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example output"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"Running workflow warp.arazzo.yaml / missionLostInvention\n\n  ✓ POST /anchors - step setAnchorToCurrentTime\n    ✓ status code check (Response code 201 matches one of description codes: [201, 409])\n    ✓ content-type check\n    ✓ schema check\n\n  ✓ POST /timelines - step createTimelineTo1889\n    ✓ status code check (Response code 201 matches one of description codes: [201])\n    ✓ content-type check\n    ✓ schema check\n\n  ✓ POST /travels - step travelTo1889\n    ✓ status code check (Response code 200 matches one of description codes: [200, 400])\n    ✓ content-type check\n    ✓ schema check\n\n  ✓ POST /items - step findAndRegisterBlueprint\n    ✓ status code check (Response code 200 matches one of description codes: [200, 409])\n    ✓ content-type check\n    ✓ schema check\n\n  ✓ POST /paradox-checks - step avoidParadox\n    ✓ success criteria check\n    ✓ success criteria check\n    ✓ status code check (Response code 200 matches one of description codes: [200, 400])\n    ✓ content-type check\n    ✓ schema check\n\n  ✓ POST /travels - step returnToPresent\n    ✓ status code check (Response code 200 matches one of description codes: [200, 400])\n    ✓ content-type check\n    ✓ schema check\n\n\n  Summary for warp.arazzo.yaml\n  \n  Workflows: 1 passed, 1 total\n  Steps: 6 passed, 6 total\n  Checks: 20 passed, 20 total\n  Time: 1060ms\n\n\n┌──────────────────────────────────────────────────────────┬────────────┬─────────┬─────────┬──────────┬─────────┐\n│ Filename                                                 │ Workflows  │ Passed  │ Failed  │ Warnings │ Skipped │\n├──────────────────────────────────────────────────────────┼────────────┼─────────┼─────────┼──────────┼─────────┤\n│ ✓ warp.arazzo.yaml                                       │ 1          │ 1       │ -       │ -        │ -       │\n└──────────────────────────────────────────────────────────┴────────────┴─────────┴─────────┴──────────┴─────────┘\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":4},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Learn more about using mTLS with Respect in ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/respect/guides/mtls-cli"},"children":["Use mTLS"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Follow steps to test API sequences in ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/respect/guides/test-api-sequences"},"children":["Test a sequence of API calls"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Learn what Respect is and how you can use it to test API in the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/respect"},"children":["Respect"]}," concept document."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/learn/arazzo/what-is-arazzo"},"children":["Learn Arazzo"]},"."]}]}]},"frontmatter":{"slug":["/docs/cli/v1/commands/respect","/docs/respect/v1/commands/respect"]},"tagList":["admonition","table"],"title":"respect","lastModified":"2026-09-29T11:18:13.000Z"}