@redocly/cli 1.30.0 → 1.31.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @redocly/cli
 
+## 1.31.0
+
+### Minor Changes
+
+- Added the `generate-arazzo` command to scaffold Arazzo description templates out of OpenAPI descriptions.
+- Added the `respect` command to test APIs against Arazzo description files.
+
+### Patch Changes
+
+- Updated @redocly/openapi-core to v1.31.0.
+
 ## 1.30.0
 
 ### Minor Changes
@@ -237,7 +248,7 @@
 
 ### Minor Changes
 
-- Added Spot and Arazzo rules: `no-criteria-xpath`, `no-actions-type-end`, `criteria-unique`.
+- Added Respect and Arazzo rules: `no-criteria-xpath`, `no-actions-type-end`, `criteria-unique`.
 
 ### Patch Changes
 

package/README.md

@@ -1,6 +1,9 @@
 # Redocly CLI
 
-[@Redocly](https://redocly.com) CLI is your all-in-one OpenAPI utility. It builds, manages, improves, and quality-checks your OpenAPI descriptions, all of which comes in handy for various phases of the API Lifecycle. Create your own rulesets to make API governance easy, and publish beautiful API reference documentation. Supports OpenAPI 3.1, 3.0 and OpenAPI 2.0 (legacy Swagger).
+[@Redocly](https://redocly.com) CLI is your all-in-one OpenAPI utility.
+It builds, manages, improves, and quality-checks your OpenAPI descriptions, all of which comes in handy for various phases of the API Lifecycle.
+Create your own rulesets to make API governance easy, publish beautiful API reference documentation, and more.
+Supports OpenAPI 3.1, 3.0 and OpenAPI 2.0 (legacy Swagger), AsyncAPI 3.0 and 2.6, Arazzo 1.0.
 
 ![build and test](https://github.com/redocly/redocly-cli/actions/workflows/tests.yaml/badge.svg)
 ![npm (scoped)](https://img.shields.io/npm/v/@redocly/cli)
@@ -32,9 +35,8 @@ The minimum required versions of Node.js and NPM are 18.17.0 and 10.8.2 respecti
 
 ### Docker
 
-To give the Docker container access to the OpenAPI description files, you need to
-mount the containing directory as a volume. Assuming the API description is rooted
-in the current working directory, you need the following command:
+To give the Docker container access to the OpenAPI description files, you need to mount the containing directory as a volume.
+Assuming the API description is rooted in the current working directory, you need the following command:
 
 ```sh
 docker run --rm -v $PWD:/spec redocly/cli lint path-to-root-file.yaml
@@ -51,25 +53,36 @@ docker run --rm -v $PWD:/spec redocly/cli lint path-to-root-file.yaml
 
 ### Generate API reference documentation
 
-Redocly CLI is a great way to render API reference documentation. It uses open source [Redoc](https://github.com/redocly/redoc) to build your documentation. Use a command like this:
+Redocly CLI is a great way to render API reference documentation.
+It uses open source [Redoc](https://github.com/redocly/redoc) to build your documentation.
+Use a command like this:
 
 ```sh
 redocly build-docs openapi.yaml
 ```
 
-Your API reference docs are in `redoc-static.html` by default. You can customize this in many ways. [Read the main docs](https://redocly.com/docs/cli/commands/build-docs) for more information.
+Your API reference docs are in `redoc-static.html` by default.
+You can customize this in many ways.
+[Read the main docs](https://redocly.com/docs/cli/commands/build-docs) for more information.
 
-> :bulb: Redocly also has [hosted API reference docs](https://redocly.com/docs/api-registry/guides/api-registry-quickstart/), a (commercial) alternative to Redoc. Both Redoc and Redocly API reference docs can be worked on locally using the `preview-docs` command.
+> :bulb: Redocly also has [hosted API reference docs](https://redocly.com/docs/api-registry/guides/api-registry-quickstart/), a (commercial) alternative to Redoc.
+> Both Redoc and Redocly API reference docs can be worked on locally using the `preview-docs` command.
 
 ### Bundle multiple OpenAPI documents
 
-Having one massive OpenAPI description can be annoying, so most people split them up into multiple documents via `$ref`, only to later find out some tools don't support `$ref` or don't support multiple documents. Redocly CLI to the rescue! It has a `bundle` command you can use to recombine all of those documents back into one single document. The bundled output that Redocly CLI provides is clean, tidy, and looks like a human made it.
+Having one massive OpenAPI description can be annoying, so most people split them up into multiple documents via `$ref`, only to later find out some tools don't support `$ref` or don't support multiple documents.
+Redocly CLI to the rescue! It has a `bundle` command you can use to recombine all of those documents back into one single document.
+The bundled output that Redocly CLI provides is clean, tidy, and looks like a human made it.
 
 ### Automate API guidelines with Linting
 
-Check that your API matches the expected API guidelines by using the `lint` command. API guidelines are an important piece of API governance. They help to keep APIs consistent by enforcing the same standards and naming conventions, and they can also guide API teams through potential security hazards and other pitfalls. Automating API guidelines means you can keep APIs consistent and secure throughout their lifecycle. Even better, you can shape the design of the API before it even exists by combining API linting with a design-first API workflow.
+Check that your API matches the expected API guidelines by using the `lint` command.
+API guidelines are an important piece of API governance. They help to keep APIs consistent by enforcing the same standards and naming conventions, and they can also guide API teams through potential security hazards and other pitfalls.
+Automating API guidelines means you can keep APIs consistent and secure throughout their lifecycle.
+Even better, you can shape the design of the API before it even exists by combining API linting with a design-first API workflow.
 
-Our API linter is designed for speed on even large documents, and it's easy to run locally, in CI, or anywhere you need it. It's also designed for humans, with meaningful error messages to help you get your API right every time.
+Our API linter is designed for speed on even large documents, and it's easy to run locally, in CI, or anywhere you need it.
+It's also designed for humans, with meaningful error messages to help you get your API right every time.
 
 Try it like this:
 
@@ -77,9 +90,12 @@ Try it like this:
 redocly lint openapi.yaml
 ```
 
-**Configure the rules** as you wish. Other API Linters use complicated identifiers like JSONPath, but Redocly makes life easy with simple expressions that understand the OpenAPI structure. You can either use the [built-in rules](https://redocly.com/docs/cli/rules) to mix-and-match your ideal API guidelines, or break out the tools to build your own.
+**Configure the rules** as you wish.
+Other API Linters use complicated identifiers like JSONPath, but Redocly makes life easy with simple expressions that understand the OpenAPI structure.
+You can either use the [built-in rules](https://redocly.com/docs/cli/rules) to mix-and-match your ideal API guidelines, or break out the tools to build your own.
 
-**Format the output** in whatever way you need. The `stylish` output is as good as it sounds, but if you need JSON or Checkstyle outputs to integrate with other tools, the `lint` command can output those too.
+**Format the output** in whatever way you need.
+The `stylish` output is as good as it sounds, but if you need JSON or Checkstyle outputs to integrate with other tools, the `lint` command can output those too.
 
 **Multiple files supported** so you don't need to bundle your API description to lint it; just point Redocly CLI at the "entry point" (e.g.: `openapi.yaml`) and it handles the rest.
 
@@ -87,7 +103,8 @@ redocly lint openapi.yaml
 
 ### Transform an OpenAPI description
 
-If your OpenAPI description isn't everything you hoped it would be, enhance it with the Redocly [decorators](https://redocly.com/docs/cli/decorators) feature. This allows you to:
+If your OpenAPI description isn't everything you hoped it would be, enhance it with the Redocly [decorators](https://redocly.com/docs/cli/decorators) feature.
+This allows you to:
 
 - Publish reference docs with a subset of endpoints for public use
 - Improve the docs by adding examples and descriptions
@@ -95,11 +112,13 @@ If your OpenAPI description isn't everything you hoped it would be, enhance it w
 
 ## Data collection
 
-This tool [collects data](./docs/usage-data.md) to help Redocly improve our products and services. You can opt out by setting the `REDOCLY_TELEMETRY` environment variable to `off`.
+This tool [collects data](./docs/usage-data.md) to help Redocly improve our products and services.
+You can opt out by setting the `REDOCLY_TELEMETRY` environment variable to `off`.
 
 ## Update notifications
 
-Redocly CLI checks for updates on startup. You can disable this by setting the `REDOCLY_SUPPRESS_UPDATE_NOTICE` environment variable to `true`.
+Redocly CLI checks for updates on startup.
+You can disable this by setting the `REDOCLY_SUPPRESS_UPDATE_NOTICE` environment variable to `true`.
 
 ## More resources
 
@@ -111,4 +130,5 @@ Thanks to [graphql-js](https://github.com/graphql/graphql-js) and [eslint](https
 
 ## Development
 
-Contributions are welcome! All the information you need is in [CONTRIBUTING.md](CONTRIBUTING.md).
+Contributions are welcome!
+All the information you need is in [CONTRIBUTING.md](CONTRIBUTING.md).

package/lib/index.js

@@ -1,6 +1,8 @@
 #!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const path = require("path");
+const dotenv = require("dotenv");
 require("./utils/assert-node-version");
 const yargs = require("yargs");
 const colors = require("colorette");
@@ -21,6 +23,7 @@ const translations_1 = require("./commands/translations");
 const eject_1 = require("./commands/eject");
 const constants_1 = require("./commands/preview-project/constants");
 const push_1 = require("./commands/push");
+dotenv.config({ path: path.resolve(process.cwd(), './.env') });
 if (!('replaceAll' in String.prototype)) {
     require('core-js/actual/string/replace-all');
 }
@@ -725,6 +728,92 @@ yargs
 }), (argv) => {
     process.env.REDOCLY_CLI_COMMAND = 'eject';
     (0, wrapper_1.commandWrapper)(eject_1.handleEject)(argv);
+})
+    .command('respect [files...]', 'Run Arazzo tests.', (yargs) => {
+    return yargs
+        .positional('files', {
+        describe: 'Test files or glob pattern.',
+        type: 'string',
+        array: true,
+        default: [],
+    })
+        .env('REDOCLY_CLI_RESPECT')
+        .options({
+        input: {
+            alias: 'i',
+            describe: 'Input parameters.',
+            type: 'string',
+        },
+        server: {
+            alias: 'S',
+            describe: 'Server parameters.',
+            type: 'string',
+        },
+        workflow: {
+            alias: 'w',
+            describe: 'Workflow name.',
+            type: 'string',
+            array: true,
+        },
+        skip: {
+            alias: 's',
+            describe: 'Workflow to skip.',
+            type: 'string',
+            array: true,
+        },
+        verbose: {
+            alias: 'v',
+            describe: 'Apply verbose mode.',
+            type: 'boolean',
+        },
+        'har-output': {
+            describe: 'Har file output name.',
+            type: 'string',
+        },
+        'json-output': {
+            describe: 'JSON file output name.',
+            type: 'string',
+        },
+        'client-cert': {
+            describe: 'Mutual TLS client certificate.',
+            type: 'string',
+        },
+        'client-key': {
+            describe: 'Mutual TLS client key.',
+            type: 'string',
+        },
+        'ca-cert': {
+            describe: 'Mutual TLS CA certificate.',
+            type: 'string',
+        },
+        severity: {
+            describe: 'Severity of the check.',
+            type: 'string',
+        },
+    });
+}, async (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'respect';
+    const { handleRun } = await Promise.resolve().then(() => require('@redocly/respect-core'));
+    (0, wrapper_1.commandWrapper)(handleRun)(argv);
+})
+    .command('generate-arazzo <descriptionPath>', 'Auto-generate arazzo description file from an API description.', (yargs) => {
+    return yargs
+        .positional('descriptionPath', {
+        describe: 'Description file path.',
+        type: 'string',
+    })
+        .env('REDOCLY_CLI_RESPECT')
+        .options({
+        'output-file': {
+            alias: 'o',
+            describe: 'Output File name.',
+            type: 'string',
+        },
+    });
+}, async (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'generate-arazzo';
+    const { handleGenerate } = await Promise.resolve().then(() => require('@redocly/respect-core'));
+    (0, wrapper_1.commandWrapper)(handleGenerate)(argv);
 })
     .completion('completion', 'Generate autocomplete script for `redocly` command.')
     .demandCommand(1)

package/lib/types.d.ts

@@ -1,4 +1,5 @@
 import type { BundleOutputFormat, Region, Config, RuleSeverity } from '@redocly/openapi-core';
+import type { RespectOptions, GenerateArazzoFileOptions } from '@redocly/respect-core';
 import type { ArgumentsCamelCase } from 'yargs';
 import type { LintOptions } from './commands/lint';
 import type { BundleOptions } from './commands/bundle';
@@ -27,7 +28,7 @@ export type Entrypoint = {
 export declare const outputExtensions: ReadonlyArray<BundleOutputFormat>;
 export type OutputExtensions = 'json' | 'yaml' | 'yml' | undefined;
 export declare const regionChoices: ReadonlyArray<Region>;
-export type CommandOptions = StatsOptions | SplitOptions | JoinOptions | PushOptions | CMSPushOptions | LintOptions | BundleOptions | LoginOptions | LogoutOptions | PreviewDocsOptions | BuildDocsArgv | PushStatusOptions | PreviewProjectOptions | TranslationsOptions | EjectOptions;
+export type CommandOptions = StatsOptions | SplitOptions | JoinOptions | PushOptions | CMSPushOptions | LintOptions | BundleOptions | LoginOptions | LogoutOptions | PreviewDocsOptions | BuildDocsArgv | PushStatusOptions | PreviewProjectOptions | TranslationsOptions | EjectOptions | RespectOptions | GenerateArazzoFileOptions;
 export type VerifyConfigOptions = {
     config?: string;
     'lint-config'?: RuleSeverity;

package/lib/utils/miscellaneous.js

@@ -49,9 +49,7 @@ const reference_docs_config_schema_1 = require("@redocly/config/lib/reference-do
 const types_1 = require("../types");
 const update_version_notifier_1 = require("./update-version-notifier");
 const push_1 = require("../commands/push");
-const oauth_client_1 = require("../auth/oauth-client");
 const api_1 = require("../reunite/api");
-const otel_1 = require("../otel");
 async function getFallbackApisOrExit(argsApis, config) {
     const { apis } = config;
     const shouldFallbackToAllDefinitions = !(0, utils_1.isNotEmptyArray)(argsApis) && (0, utils_1.isNotEmptyObject)(apis);
@@ -443,7 +441,6 @@ function cleanColors(input) {
     // eslint-disable-next-line no-control-regex
     return input.replace(/\x1b\[\d+m/g, '');
 }
-otel_1.otelTelemetry.init();
 async function sendTelemetry(argv, exit_code, has_config, spec_version, spec_keyword, spec_full_version) {
     try {
         if (!argv) {
@@ -452,7 +449,8 @@ async function sendTelemetry(argv, exit_code, has_config, spec_version, spec_key
         const { _: [command], $0: _, ...args } = argv;
         const event_time = new Date().toISOString();
         const redoclyClient = new openapi_core_1.RedoclyClient();
-        const oauthClient = new oauth_client_1.RedoclyOAuthClient('redocly-cli', update_version_notifier_1.version);
+        const { RedoclyOAuthClient } = await Promise.resolve().then(() => require('../auth/oauth-client'));
+        const oauthClient = new RedoclyOAuthClient('redocly-cli', update_version_notifier_1.version);
         const reuniteUrl = (0, api_1.getReuniteUrl)(argv.residency);
         const logged_in = redoclyClient.hasTokens() || (await oauthClient.isAuthorized(reuniteUrl));
         const data = {
@@ -474,7 +472,9 @@ async function sendTelemetry(argv, exit_code, has_config, spec_version, spec_key
             spec_keyword,
             spec_full_version,
         };
-        otel_1.otelTelemetry.send(data.command, data);
+        const { otelTelemetry } = await Promise.resolve().then(() => require('../otel'));
+        otelTelemetry.init();
+        otelTelemetry.send(data.command, data);
     }
     catch (err) {
         // Do nothing.

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@redocly/cli",
-  "version": "1.30.0",
+  "version": "1.31.0",
   "description": "",
   "license": "MIT",
   "bin": {
-    "openapi": "bin/cli.js",
-    "redocly": "bin/cli.js"
+    "redocly": "bin/cli.js",
+    "openapi": "bin/cli.js"
   },
   "engines": {
     "node": ">=18.17.0",
@@ -30,17 +30,19 @@
     "OpenAPI linter",
     "Swagger linter",
     "AsyncAPI linter",
+    "Arazzo linter",
     "oas"
   ],
   "contributors": [
     "Roman Hotsiy <roman@redocly.com> (https://redocly.com/)"
   ],
   "dependencies": {
-    "@redocly/openapi-core": "1.30.0",
+    "@redocly/openapi-core": "1.31.0",
     "abort-controller": "^3.0.0",
     "chokidar": "^3.5.1",
     "colorette": "^1.2.0",
     "core-js": "^3.32.1",
+    "dotenv": "^16.4.7",
     "form-data": "^4.0.0",
     "get-port-please": "^3.0.1",
     "glob": "^7.1.6",

package/src/index.ts

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
-
+import * as path from 'path';
+import * as dotenv from 'dotenv';
 import './utils/assert-node-version';
 import * as yargs from 'yargs';
 import * as colors from 'colorette';
@@ -27,11 +28,14 @@ import { commonPushHandler } from './commands/push';
 
 import type { Arguments } from 'yargs';
 import type { OutputFormat, RuleSeverity } from '@redocly/openapi-core';
+import type { GenerateArazzoFileOptions, RespectOptions } from '@redocly/respect-core';
 import type { BuildDocsArgv } from './commands/build-docs/types';
 import type { PushStatusOptions } from './reunite/commands/push-status';
 import type { PushArguments } from './types';
 import type { EjectOptions } from './commands/eject';
 
+dotenv.config({ path: path.resolve(process.cwd(), './.env') });
+
 if (!('replaceAll' in String.prototype)) {
   require('core-js/actual/string/replace-all');
 }
@@ -863,6 +867,102 @@ yargs
       commandWrapper(handleEject)(argv as Arguments<EjectOptions>);
     }
   )
+  .command(
+    'respect [files...]',
+    'Run Arazzo tests.',
+    (yargs) => {
+      return yargs
+        .positional('files', {
+          describe: 'Test files or glob pattern.',
+          type: 'string',
+          array: true,
+          default: [],
+        })
+        .env('REDOCLY_CLI_RESPECT')
+        .options({
+          input: {
+            alias: 'i',
+            describe: 'Input parameters.',
+            type: 'string',
+          },
+          server: {
+            alias: 'S',
+            describe: 'Server parameters.',
+            type: 'string',
+          },
+          workflow: {
+            alias: 'w',
+            describe: 'Workflow name.',
+            type: 'string',
+            array: true,
+          },
+          skip: {
+            alias: 's',
+            describe: 'Workflow to skip.',
+            type: 'string',
+            array: true,
+          },
+          verbose: {
+            alias: 'v',
+            describe: 'Apply verbose mode.',
+            type: 'boolean',
+          },
+          'har-output': {
+            describe: 'Har file output name.',
+            type: 'string',
+          },
+          'json-output': {
+            describe: 'JSON file output name.',
+            type: 'string',
+          },
+          'client-cert': {
+            describe: 'Mutual TLS client certificate.',
+            type: 'string',
+          },
+          'client-key': {
+            describe: 'Mutual TLS client key.',
+            type: 'string',
+          },
+          'ca-cert': {
+            describe: 'Mutual TLS CA certificate.',
+            type: 'string',
+          },
+          severity: {
+            describe: 'Severity of the check.',
+            type: 'string',
+          },
+        });
+    },
+    async (argv) => {
+      process.env.REDOCLY_CLI_COMMAND = 'respect';
+      const { handleRun } = await import('@redocly/respect-core');
+      commandWrapper(handleRun)(argv as Arguments<RespectOptions>);
+    }
+  )
+  .command(
+    'generate-arazzo <descriptionPath>',
+    'Auto-generate arazzo description file from an API description.',
+    (yargs) => {
+      return yargs
+        .positional('descriptionPath', {
+          describe: 'Description file path.',
+          type: 'string',
+        })
+        .env('REDOCLY_CLI_RESPECT')
+        .options({
+          'output-file': {
+            alias: 'o',
+            describe: 'Output File name.',
+            type: 'string',
+          },
+        });
+    },
+    async (argv) => {
+      process.env.REDOCLY_CLI_COMMAND = 'generate-arazzo';
+      const { handleGenerate } = await import('@redocly/respect-core');
+      commandWrapper(handleGenerate)(argv as Arguments<GenerateArazzoFileOptions>);
+    }
+  )
   .completion('completion', 'Generate autocomplete script for `redocly` command.')
   .demandCommand(1)
   .middleware([notifyUpdateCliVersion])

package/src/types.ts

@@ -1,4 +1,5 @@
 import type { BundleOutputFormat, Region, Config, RuleSeverity } from '@redocly/openapi-core';
+import type { RespectOptions, GenerateArazzoFileOptions } from '@redocly/respect-core';
 import type { ArgumentsCamelCase } from 'yargs';
 import type { LintOptions } from './commands/lint';
 import type { BundleOptions } from './commands/bundle';
@@ -43,7 +44,9 @@ export type CommandOptions =
   | PushStatusOptions
   | PreviewProjectOptions
   | TranslationsOptions
-  | EjectOptions;
+  | EjectOptions
+  | RespectOptions
+  | GenerateArazzoFileOptions;
 
 export type VerifyConfigOptions = {
   config?: string;

package/src/utils/miscellaneous.ts

@@ -29,9 +29,7 @@ import { deprecatedRefDocsSchema } from '@redocly/config/lib/reference-docs-conf
 import { outputExtensions } from '../types';
 import { version } from './update-version-notifier';
 import { DESTINATION_REGEX } from '../commands/push';
-import { RedoclyOAuthClient } from '../auth/oauth-client';
 import { getReuniteUrl } from '../reunite/api';
-import { otelTelemetry } from '../otel';
 
 import type { Arguments } from 'yargs';
 import type {
@@ -549,8 +547,6 @@ export function cleanColors(input: string): string {
   return input.replace(/\x1b\[\d+m/g, '');
 }
 
-otelTelemetry.init();
-
 export async function sendTelemetry(
   argv: Arguments | undefined,
   exit_code: ExitCode,
@@ -570,6 +566,7 @@ export async function sendTelemetry(
     } = argv;
     const event_time = new Date().toISOString();
     const redoclyClient = new RedoclyClient();
+    const { RedoclyOAuthClient } = await import('../auth/oauth-client');
     const oauthClient = new RedoclyOAuthClient('redocly-cli', version);
     const reuniteUrl = getReuniteUrl(argv.residency as string | undefined);
     const logged_in = redoclyClient.hasTokens() || (await oauthClient.isAuthorized(reuniteUrl));
@@ -592,6 +589,8 @@ export async function sendTelemetry(
       spec_keyword,
       spec_full_version,
     };
+    const { otelTelemetry } = await import('../otel');
+    otelTelemetry.init();
     otelTelemetry.send(data.command, data);
   } catch (err) {
     // Do nothing.

package/tsconfig.json

@@ -4,6 +4,6 @@
     "rootDir": "src",
     "outDir": "lib"
   },
-  "references": [{ "path": "../core" }],
+  "references": [{ "path": "../core" }, { "path": "../respect-core" }],
   "exclude": ["lib"]
 }