diff --git a/.changeset/generate-arazzo-respect-hint.md b/.changeset/generate-arazzo-respect-hint.md new file mode 100644 index 0000000000..c54592b914 --- /dev/null +++ b/.changeset/generate-arazzo-respect-hint.md @@ -0,0 +1,5 @@ +--- +'@redocly/cli': minor +--- + +The `generate-arazzo` command now prints a ready-to-run `respect` command after generation, including an `--input` placeholder for every workflow input. diff --git a/.changeset/generate-arazzo-with-ai.md b/.changeset/generate-arazzo-with-ai.md new file mode 100644 index 0000000000..ec73be67cb --- /dev/null +++ b/.changeset/generate-arazzo-with-ai.md @@ -0,0 +1,7 @@ +--- +'@redocly/cli': minor +--- + +Added `--with-ai`, `--ai-provider`, and `--max-workflows` options to the `generate-arazzo` command. +With `--with-ai`, the generated one-workflow-per-operation skeleton is redesigned by a locally installed AI CLI (`claude`, `codex`, or `cursor`) into realistic multi-step workflows that chain operations through outputs and runtime expressions, using the OpenAPI description as context. +The AI designs at most `--max-workflows` workflows (default 10), and the generated file is marked as AI-inferred. diff --git a/.changeset/respect-scheme-case.md b/.changeset/respect-scheme-case.md new file mode 100644 index 0000000000..6c046a26b2 --- /dev/null +++ b/.changeset/respect-scheme-case.md @@ -0,0 +1,7 @@ +--- +'@redocly/cli': patch +'@redocly/respect-core': patch +'@redocly/openapi-core': patch +--- + +Fixed `respect` and the `x-security-scheme-required-values` rule rejecting `x-security` HTTP schemes written with non-lowercase casing (such as `Basic`, `Bearer`, or `Digest`) — RFC 7235 scheme names are case-insensitive. diff --git a/docs/@v2/commands/generate-arazzo.md b/docs/@v2/commands/generate-arazzo.md index f903abb02a..61e0bdd6e6 100644 --- a/docs/@v2/commands/generate-arazzo.md +++ b/docs/@v2/commands/generate-arazzo.md @@ -17,10 +17,16 @@ It acts as a starting point for a test file and needs to be extended to be funct The first HTTP response is used as the success criteria for each step. +After writing the file, the command prints a ready-to-run [`respect`](./respect.md) command, including an `--input` placeholder for every workflow input — replace the placeholder values with real ones before running it. + +With `--with-ai`, the generated one-workflow-per-operation skeleton is redesigned by an AI provider into realistic multi-step workflows, using the OpenAPI description as context. +See the [Redesign workflows with AI](#redesign-workflows-with-ai) section. + ## Usage ```sh npx @redocly/cli@latest generate-arazzo [-o | --output-file] +npx @redocly/cli@latest generate-arazzo --with-ai [--ai-provider=