From 7029fe8d55fa49997bfdeb99160a64a4f1c24e66 Mon Sep 17 00:00:00 2001 From: Alex Karcher Date: Tue, 14 Mar 2023 11:18:09 -0700 Subject: [PATCH] Removing conflict --- .../how-to/GenerateABasicApiScenario.md | 36 ------------------- .../how-to/generateABasicApiScenario.md | 36 ------------------- 2 files changed, 72 deletions(-) delete mode 100644 documentation/api-scenario/how-to/GenerateABasicApiScenario.md delete mode 100644 documentation/api-scenario/how-to/generateABasicApiScenario.md diff --git a/documentation/api-scenario/how-to/GenerateABasicApiScenario.md b/documentation/api-scenario/how-to/GenerateABasicApiScenario.md deleted file mode 100644 index 44212740228b..000000000000 --- a/documentation/api-scenario/how-to/GenerateABasicApiScenario.md +++ /dev/null @@ -1,36 +0,0 @@ -# Generate a basic API Scenario file - -In this section, we will show you how to generate a basic API scenario file from Swagger. This is useful for quickly generating a basic API scenario file as baseline, and you can improve the API Scenario (adjusting step orders and providing meaningful values) and make it runnable. - -## Prerequisites - -1. Install [oav](https://www.npmjs.com/package/oav) - -```bash -npm i -g oav -``` -2. Install [docker](https://docs.docker.com/get-docker/) - -## Steps - -1. Compile Swagger into dependencies.json with Restler. - -```bash -docker run --rm -v $(pwd)/specification:/swagger -w /swagger/.restler_output mcr.microsoft.com/restlerfuzzer/restler dotnet /RESTler/restler/Restler.dll compile --api_spec /swagger/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json -``` - -2. Generate a basic API Scenario file. - -The generated API Scenario file will contain all the operations in the Swagger file, ordered by the dependencies. At each step, the minimum required parameters will be filled in. - -```bash -oav generate-api-scenario static --specs specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json --dependency specification/.restler_output/Compile/dependencies.json -o specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/scenarios -``` - -As an alternative, if Swagger examples are ready, you can add `--useExample` parameter to generate the API scenario file based on Swagger examples: - -```bash -oav generate-api-scenario static --specs specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json --dependency specification/.restler_output/Compile/dependencies.json -o specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/scenarios --useExample -``` - -Next you can run the API scenario file with `oav run`. See how in [QuickStart](./QuickStart.md). diff --git a/documentation/api-scenario/how-to/generateABasicApiScenario.md b/documentation/api-scenario/how-to/generateABasicApiScenario.md deleted file mode 100644 index 44212740228b..000000000000 --- a/documentation/api-scenario/how-to/generateABasicApiScenario.md +++ /dev/null @@ -1,36 +0,0 @@ -# Generate a basic API Scenario file - -In this section, we will show you how to generate a basic API scenario file from Swagger. This is useful for quickly generating a basic API scenario file as baseline, and you can improve the API Scenario (adjusting step orders and providing meaningful values) and make it runnable. - -## Prerequisites - -1. Install [oav](https://www.npmjs.com/package/oav) - -```bash -npm i -g oav -``` -2. Install [docker](https://docs.docker.com/get-docker/) - -## Steps - -1. Compile Swagger into dependencies.json with Restler. - -```bash -docker run --rm -v $(pwd)/specification:/swagger -w /swagger/.restler_output mcr.microsoft.com/restlerfuzzer/restler dotnet /RESTler/restler/Restler.dll compile --api_spec /swagger/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json -``` - -2. Generate a basic API Scenario file. - -The generated API Scenario file will contain all the operations in the Swagger file, ordered by the dependencies. At each step, the minimum required parameters will be filled in. - -```bash -oav generate-api-scenario static --specs specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json --dependency specification/.restler_output/Compile/dependencies.json -o specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/scenarios -``` - -As an alternative, if Swagger examples are ready, you can add `--useExample` parameter to generate the API scenario file based on Swagger examples: - -```bash -oav generate-api-scenario static --specs specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json --dependency specification/.restler_output/Compile/dependencies.json -o specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/scenarios --useExample -``` - -Next you can run the API scenario file with `oav run`. See how in [QuickStart](./QuickStart.md).