You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/commands/generate-arazzo.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ rbac:
8
8
9
9
# `generate-arazzo`
10
10
11
-
Auto-generate an Arazzo file based on an OpenAPI description file.
11
+
Auto-generate an Arazzo description based on an OpenAPI description file.
12
12
13
13
If `examples` are provided in the OpenAPI description, they are used as input data for test requests.
14
14
If `schema` is provided, the config generates fake data based on the description schema.
@@ -19,7 +19,7 @@ The `--extended` option also demonstrates how `respect` gets data from an OpenAP
19
19
20
20
{% admonition type="warning" %}
21
21
22
-
Given the nature of OpenAPI, the generated Arazzo file is not a complete test file and may not function. Dependencies between endpoints are not resolved.
22
+
Given the nature of OpenAPI, the generated Arazzo description is not a complete test file and may not function. Dependencies between endpoints are not resolved.
23
23
24
24
It acts as a starting point for a test file and needs to be extended to be functional.
For example, the following command runs "first-flow" and "second-flow" workflows from the "test-file.yaml" test file: `npx @redocly/cli respect test-file.yaml --workflow first-flow second-flow`
33
+
For example, the following command runs "first-flow" and "second-flow" workflows from the "test-file.yaml" Arazzo description: `npx @redocly/cli respect test-file.yaml --workflow first-flow second-flow`
34
34
{% admonition type="warning" %}
35
35
The `--workflow` option can't be used with `--skip`.
For example, the following command skips the "first-flow" workflow from the "test-file.yaml" test file: `npx @redocly/cli respect test-file.yaml --skip first-flow`
44
-
{% admonition type="warning" %}
45
-
Warning: the`--skip` option can't be used with `--workflow`.
43
+
For example, the following command skips the "first-flow" workflow from the "test-file.yaml" Arazzo description: `npx @redocly/cli respect test-file.yaml --skip first-flow`
44
+
{% admonition type="warning" name="Warning" %}
45
+
The`--skip` option can't be used with `--workflow`.
46
46
{% /admonition %}
47
47
48
48
---
49
49
50
50
- -v, --verbose
51
51
- boolean
52
52
- Runs the command in verbose mode to help with troubleshooting issues.
53
-
For example, the following command runs all workflows from the "test-file.yaml" test file in verbose mode: `npx @redocly/cli respect test-file.yaml --verbose`
53
+
For example, the following command runs all workflows from the "test-file.yaml" Arazzo description in verbose mode: `npx @redocly/cli respect test-file.yaml --verbose`
54
54
55
55
---
56
56
57
57
- --har-output
58
58
- string
59
59
- Path for the `har` file for saving logs.
60
-
For example, the following command runs all workflows from the "test-file.yaml" test file and saves the logs to the "logs.har" file: `npx @redocly/cli respect test-file.yaml --har-output='logs.har'`
60
+
For example, the following command runs all workflows from the "test-file.yaml" Arazzo description and saves the logs to the "logs.har" file: `npx @redocly/cli respect test-file.yaml --har-output='logs.har'`
61
61
62
62
---
63
63
64
64
- --json-output
65
65
- string
66
-
- Path for the 'json`file for saving logs. For example, the following command runs all workflows from the "test-file.yaml" test file and saves the logs to the "logs.json" file:`npx @redocly/cli respect test-file.yaml --json-output='logs.json'`
66
+
- Path for the JSON file for saving logs. For example, the following command runs all workflows from the "test-file.yaml" Arazzo description and saves the logs to the "logs.json" file:`npx @redocly/cli respect test-file.yaml --json-output='logs.json'`
67
67
68
68
---
69
69
70
70
- --input
71
71
- string
72
72
- Input parameters with values that are mapped to the workflow inputs description.
73
-
For example, the following command maps the "userEmail" and "userPassword" inputs and values to all workflows in the "test.yaml" test file: `npx @redocly/cli respect test.yaml --input userEmail=name@redocly.com --input userPassword=12345`.
73
+
For example, the following command maps the "userEmail" and "userPassword" inputs and values to all workflows in the "test.yaml" Arazzo description: `npx @redocly/cli respect test.yaml --input userEmail=name@redocly.com --input userPassword=12345`.
74
74
You can also use an environment variable to set the input, as in the following example: `REDOCLY_CLI_RESPECT_INPUT='userEmail=name@redocly.com,userPassword=12345' npm run cli respect test.yaml`
75
75
76
-
You can even include nested values, as in the following example command that maps the "nestedKey" input and value to all workflows in the "test-file.yaml" test file: `npx @redocly/cli respect test-file.yaml --input '{"key": "value", "nested": {"nestedKey": "nestedValue"}}'`.
76
+
You can even include nested values, as in the following example command that maps the "nestedKey" input and value to all workflows in the "test-file.yaml" Arazzo description: `npx @redocly/cli respect test-file.yaml --input '{"key": "value", "nested": {"nestedKey": "nestedValue"}}'`.
77
77
You can also use an environment variable to set the input, as in the following example: `REDOCLY_CLI_RESPECT_INPUT='{"key":"value","nested":{"nestedKey":"nestedValue"}}' npx @redocly/cli respect test-file.yaml`
78
78
79
79
---
80
80
81
81
- --server
82
82
- string
83
83
- Server overrides for the `sourceDescriptions` object.
84
-
For example, the following command runs all workflows from the "test-file.yaml" test file and instead of using the server listed in the API description, uses the server at "https://test.com": `npx @redocly/cli respect test-file.yaml --server test=https://test.com`
84
+
For example, the following command runs all workflows from the "test-file.yaml" Arazzo description and instead of using the server listed in the API description, uses the server at "https://test.com": `npx @redocly/cli respect test-file.yaml --server test=https://test.com`
85
85
86
86
You can also pass the server overrides as an environment variable, as in the following example:
0 commit comments