Skip to content

Commit ac4621d

Browse files
leniatghanandanthony
authored andcommitted
Update QuickStart.md (Azure#21405)
* Update QuickStart.md * Update QuickStart.md
1 parent 3f43e9f commit ac4621d

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ npm install -g oav
2424
- Validation result report. After each run API scenario, developer will get a validation report which contains detected issue in API test.
2525
- Integrate everywhere. Easily integrate with azure-pipeline, cloud-test.
2626

27-
See `oav run -h` to find all available options.
27+
Run `oav run -h` to find all available options.
2828

2929
## Create AAD app
3030

@@ -104,20 +104,22 @@ The `env.json` file contains required API scenario variables such as, subscripti
104104

105105
```json
106106
{
107-
"subscriptionId": "<my subscription id>",
107+
"subscriptionId": "<your subscription id>",
108108
"location": "westcentralus",
109109
"tenantId": "<AAD app tenantId>",
110-
"client_id": "<my add client_id>",
111-
"client_secret": "<my aad client_secret>"
110+
"client_id": "<your add client_id>",
111+
"client_secret": "<your aad client_secret>"
112112
}
113113
```
114114

115115
#### 3. Run API Scenario test
116116

117117
```sh
118-
oav run ~/workspace/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/scenarios/quickstart.yaml --tag=package-2022-05-01 -e env.json --verbose
118+
oav run ~/workspace/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/scenarios/quickstart.yaml --tag package-2022-05-01 -e env.json --verbose
119119
```
120120

121+
The `--tag` parameter specifies tag name in the autorest configuration (readme.md) file, and Swagger files under the tag will be loaded. By default, oav tries to find the closest readme.md file in the upper directories of the scenario file, and use the "default" tag in it. You can use `--readme` and `--tag` to specify readme.md file and tag to load Swagger files, or `--specs` to specify Swagger files directly.
122+
121123
#### 4. Debug with Postman
122124

123125
Sometimes the command `oav run` may fail due to non 2xx HTTP status code. Now you need to debug the API scenario with Postman.

0 commit comments

Comments
 (0)