Skip to content

Commit 060295a

Browse files
tianxchen-msTianxiang Chenleniatgh
authored
[ApiScenario] update doc (#18424)
* update doc * Update documentation/api-scenario/how-to/generateABasicApiScenario.md Co-authored-by: Tianxiang Chen <[email protected]> Co-authored-by: Lei Ni <[email protected]>
1 parent 1965b5b commit 060295a

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

documentation/api-scenario/how-to/generateABasicApiScenario.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,16 @@ We use `oav` tools to generate basic API scenario. `oav` analyze swagger file an
88

99
`oav` support rule based API scenario file generation. We use this command to generate API scenario file.
1010

11-
`oav generate-static-api-scenario --readme <readme> --tag <tag> --rules <generated-rules>`
11+
`oav generate-api-scenario static --readme <readme> --tag <tag> --specs <specs> --rules <generated-rules>`
12+
13+
OR
14+
15+
`oav generate-api-scenario static --readme <readme> --tag <tag> --specs <specs> --dependency <dependency-path>`
1216

1317
- readme: swagger readme file.
1418
- tag: which tag to generate. oav will analyze swagger file under the tag and generate API scenario.
19+
- specs: one or more spec file paths. type: array.
20+
- dependency: The file path of the RESTler dependency. It cannot be used with `rules`.
1521
- rules: Currently support two types. `resource-put-delete`, `operations-list`. Default: `resource-put-delete`
1622
- `resource-put-delete`: generate resource put and delete API scenario.
1723
- `operations-list`: generate operations list API scenario. `operations-list` is the simplest API which must be defined in swagger.

0 commit comments

Comments
 (0)