Skip to content

Commit 9925784

Browse files
authored
docs: update readme for respect command (#12)
1 parent 11de4c7 commit 9925784

File tree

1 file changed

+116
-0
lines changed

1 file changed

+116
-0
lines changed

README.md

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Add to your `package.json`:
4242
"lint": "redocly-lint",
4343
"docs": "redocly-build-docs",
4444
"arazzo": "redocly-generate-arazzo",
45+
"respect": "redocly-respect",
4546
"validate": "npm run lint && npm run bundle && npm run docs"
4647
}
4748
}
@@ -54,6 +55,7 @@ npm run bundle # Bundles openapi/openapi.yaml -> dist/openapi.yaml
5455
npm run lint # Lints openapi/openapi.yaml
5556
npm run docs # Generates dist/openapi.html
5657
npm run arazzo # Generates dist/auto-generated.arazzo.yaml
58+
npm run respect # Tests arazzo/*.arazzo.yaml workflows
5759
```
5860

5961
## Available Commands
@@ -68,6 +70,7 @@ npm run arazzo # Generates dist/auto-generated.arazzo.yaml
6870
| `redocly-lint` | Lint OpenAPI specs | `openapi/openapi.yaml` | terminal output |
6971
| `redocly-build-docs` | Generate HTML documentation | `openapi/openapi.yaml` | `dist/openapi.html` |
7072
| `redocly-generate-arazzo` | Generate Arazzo workflow descriptions | `openapi/openapi.yaml` | `dist/auto-generated.arazzo.yaml` |
73+
| `redocly-respect` | Test Arazzo workflows | `arazzo/*.arazzo.yaml` | terminal output |
7174

7275
<!-- markdownlint-enable MD013 -->
7376

@@ -132,6 +135,119 @@ Path to Redocly configuration file.
132135
OPENAPI_CONFIG=.config/redocly.yaml redocly-lint
133136
```
134137

138+
### `ARAZZO_INPUT`
139+
140+
Path to your Arazzo workflow(s). Supports glob patterns.
141+
142+
**Default:** `arazzo/*.arazzo.yaml`
143+
144+
**Example:**
145+
146+
```bash
147+
ARAZZO_INPUT=api/arazzo.yaml redocly-respect
148+
```
149+
150+
### `ARAZZO_VERBOSE`
151+
152+
Set to `true` for verbose output.
153+
154+
**Default:** `false`
155+
156+
**Example:**
157+
158+
```bash
159+
ARAZZO_VERBOSE=true redocly-respect
160+
```
161+
162+
### `ARAZZO_HAR_OUTPUT`
163+
164+
HAR file output path (for debugging HTTP traffic).
165+
166+
**Default:** none
167+
168+
**Example:**
169+
170+
```bash
171+
ARAZZO_HAR_OUTPUT=logs/arazzo.har redocly-respect
172+
```
173+
174+
### `ARAZZO_JSON_OUTPUT`
175+
176+
JSON file output path (for debugging).
177+
178+
**Default:** none
179+
180+
**Example:**
181+
182+
```bash
183+
ARAZZO_JSON_OUTPUT=logs/arazzo.json redocly-respect
184+
```
185+
186+
## Redocly's Native Environment Variables
187+
188+
Some Redocly command support native environment variables for advanced configuration:
189+
190+
### `REDOCLY_CLI_RESPECT_INPUT`
191+
192+
Input parameters as JSON or key=value pairs.
193+
194+
**Example:**
195+
196+
```bash
197+
REDOCLY_CLI_RESPECT_INPUT='userEmail=name@redocly.com,userPassword=12345' redocly-respect
198+
REDOCLY_CLI_RESPECT_INPUT='{"key":"value","nested":{"nestedKey":"nestedValue"}}' redocly-respect
199+
```
200+
201+
[Redocly `respect` Documentation](https://redocly.com/docs/cli/commands/respect)
202+
203+
### `REDOCLY_CLI_RESPECT_SERVER`
204+
205+
Server overrides.
206+
207+
**Example:**
208+
209+
```bash
210+
REDOCLY_CLI_RESPECT_SERVER="sourceDescriptionName1=https://example.com" redocly-respect
211+
```
212+
213+
[Redocly `respect` Documentation](https://redocly.com/docs/cli/commands/respect)
214+
215+
### `REDOCLY_CLI_RESPECT_MAX_STEPS`
216+
217+
Maximum number of steps to run.
218+
219+
**Example:**
220+
221+
```bash
222+
REDOCLY_CLI_RESPECT_MAX_STEPS=50 redocly-respect
223+
```
224+
225+
[Redocly `respect` Documentation](https://redocly.com/docs/cli/commands/respect)
226+
227+
### `REDOCLY_CLI_RESPECT_MAX_FETCH_TIMEOUT`
228+
229+
Maximum time to wait for API response per request in milliseconds.
230+
231+
**Example:**
232+
233+
```bash
234+
REDOCLY_CLI_RESPECT_MAX_FETCH_TIMEOUT=60000 redocly-respect
235+
```
236+
237+
[Redocly `respect` Documentation](https://redocly.com/docs/cli/commands/respect)
238+
239+
### `REDOCLY_CLI_RESPECT_EXECUTION_TIMEOUT`
240+
241+
Maximum time to wait for `respect` command execution in milliseconds.
242+
243+
**Example:**
244+
245+
```bash
246+
REDOCLY_CLI_RESPECT_EXECUTION_TIMEOUT=1800000 redocly-respect
247+
```
248+
249+
[Redocly `respect` Documentation](https://redocly.com/docs/cli/commands/respect)
250+
135251
## Contributing
136252

137253
Issues and pull requests welcome!

0 commit comments

Comments
 (0)