From d60a048ccee93685c11e53b623ed17bd1da77325 Mon Sep 17 00:00:00 2001 From: Alex Karcher Date: Tue, 14 Mar 2023 11:11:03 -0700 Subject: [PATCH 1/5] Merging upstream/main --- .../how-to/generateABasicApiScenario.md | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) create 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 new file mode 100644 index 000000000000..44212740228b --- /dev/null +++ b/documentation/api-scenario/how-to/generateABasicApiScenario.md @@ -0,0 +1,36 @@ +# 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). From 39fbea86d0ed050c39d2af9e3049728765e544cb Mon Sep 17 00:00:00 2001 From: Alex Karcher Date: Tue, 14 Mar 2023 11:15:32 -0700 Subject: [PATCH 2/5] Updated flowState to be a reference --- .../Microsoft.Web/stable/2022-09-01/WebApps.json | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2022-09-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2022-09-01/WebApps.json index bbbe8e6007a9..089db060dc79 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2022-09-01/WebApps.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2022-09-01/WebApps.json @@ -29822,19 +29822,7 @@ }, "flowState": { "description": "Gets or sets the state of the workflow.", - "enum": [ - "NotSpecified", - "Completed", - "Enabled", - "Disabled", - "Deleted", - "Suspended" - ], - "type": "string", - "x-ms-enum": { - "name": "WorkflowState", - "modelAsString": false - } + "$ref": "#/definitions/WorkflowState" }, "health": { "$ref": "#/definitions/WorkflowHealth", From 7029fe8d55fa49997bfdeb99160a64a4f1c24e66 Mon Sep 17 00:00:00 2001 From: Alex Karcher Date: Tue, 14 Mar 2023 11:18:09 -0700 Subject: [PATCH 3/5] 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). From b0645755f4969f2185333e77b0b5a3f0c23941e8 Mon Sep 17 00:00:00 2001 From: Alex Karcher Date: Tue, 14 Mar 2023 11:18:49 -0700 Subject: [PATCH 4/5] Revert "Removing conflict" This reverts commit 7029fe8d55fa49997bfdeb99160a64a4f1c24e66. --- .../how-to/GenerateABasicApiScenario.md | 36 +++++++++++++++++++ .../how-to/generateABasicApiScenario.md | 36 +++++++++++++++++++ 2 files changed, 72 insertions(+) create mode 100644 documentation/api-scenario/how-to/GenerateABasicApiScenario.md create 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 new file mode 100644 index 000000000000..44212740228b --- /dev/null +++ b/documentation/api-scenario/how-to/GenerateABasicApiScenario.md @@ -0,0 +1,36 @@ +# 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 new file mode 100644 index 000000000000..44212740228b --- /dev/null +++ b/documentation/api-scenario/how-to/generateABasicApiScenario.md @@ -0,0 +1,36 @@ +# 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). From 0379de7c98b00ad1be9947da370cba0355703bf7 Mon Sep 17 00:00:00 2001 From: Alex Karcher Date: Tue, 14 Mar 2023 11:20:19 -0700 Subject: [PATCH 5/5] Revert "Merging upstream/main" This reverts commit d60a048ccee93685c11e53b623ed17bd1da77325. --- .../how-to/generateABasicApiScenario.md | 36 ------------------- 1 file changed, 36 deletions(-) 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).