@redocly/blue-harvest-test-runner

Blue Harvest Test Runner

CLI Test Runner for the Blue Harvest. It will trigger info Test on the Blue Harvest and can get definition from it.

Quickstart

Step 1: Install blue-harvest-test-runner

npm i @redocly/blue-harvest-test-runner --registry http://3.236.95.236:8000/

Step 2: Run the tests

BH_TOKEN=<BH_TOKEN> API_URL=<url of API Blue Harvest (example http://api.redocly-local.com) API_KEY=API_KEY blue-harvest-test-runner test-file.yaml

You can find the BH_TOKEN on the Test page of Blue Harvest in the Api Keys tab.

Example of test file

Use same structure for tests as in the @redocly/christi

If you want to use the bundled definition from the Blue Harvest use next config structure:

definition:
  adapter: blue-harvest
  path: <path to the definition in the Blue Harvest>
  branch: <branch in the Blue Harvest>

Example:

definition:
  adapter: blue-harvest
  path: openapi.yaml
  branch: main