Sync typespec and swagger change for loadtesting service #24412
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @MaryGao Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️❌TypeSpec Validation: 3 Errors, 2 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Unknown identifier LoadTestRunOperations Location: specification/loadtestservice/LoadTestService/routes.tsp#L301 |
|
Argument 'ErrorType' is not assignable to parameter of type 'Operation' Location: specification/loadtestservice/LoadTestService/routes.tsp#L301 |
|
"details":"The 'examples' directory is missing in the typespec folder specification/loadtestservice/LoadTestService, please ensure the 'examples' is added in the PR." |
| "details":"The configuration 'output-file' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/loadtestservice/LoadTestService, please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'." |
|
| "details":"The configuration 'azure-resource-provider-folder' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/loadtestservice/LoadTestService, please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'." |
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
|
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
ghost
added
the
MaryGao
commented
Jun 13, 2023
| @@ -144,7 +145,7 @@ numeric, underscore or hyphen characters. | |||
| @body | |||
| body: bytes; | |||
| }, | |||
| FileInfo | |||
| ResourceCreatedResponse<FileInfo> | |||
There was a problem hiding this comment.
@mikekistler Do we have any guideline for data-plane on returned code(2xx) for various http methods(e.g PUT, PATCH, POST etc)?
There was a problem hiding this comment.
Guidelines for HTTP response status codes is here
…align with the swagger LoadTestAdministration_ prefix Change LoadTestRunOperations to LoadTestRun to align with the swagger LoadTestRun_ prefix
tjprescott
pushed a commit
that referenced
this pull request
Dec 22, 2023
* initial tsp * client.tsp * client.tsp improvements * model updates * update routes * update implementation * Sync typespec and swagger change for loadtesting service (#24412) * Update the diff for put and patch operation * Change LoadTestAdministrationOperations to LoadTestAdministration to align with the swagger LoadTestAdministration_ prefix Change LoadTestRunOperations to LoadTestRun to align with the swagger LoadTestRun_ prefix * update models * add list metric dimensions op and fix create test run * update client.tsp * fix DimensionValueList and update TestRun model * Configuration changes for LoadTesting (#24481) * Update the projected name * Renamed * update config file * update folder * Remove client.tsp * Update the projected name to old ones * Adjust the positions * Update client.tsp * Update tspconfig.yaml Added correct options for python emitter. * Update the metadata * Change the projectedName to client.tsp * Remove the projectedName in routes.tsp * update file * Update the .Net config * Remove the projectedName change for load testing * Revert position change * Update specification/loadtestservice/LoadTestService/tspconfig.yaml --------- Co-authored-by: Ray Chen <raychen@microsoft.com> * update routes to be more accurate * update client.tsp for python * python config to avoid breaking (#24801) * python config * Update client.tsp * java, feature/loadtesting, match tsp and swagger (#24878) * java config * project for java * metricNamespace is required * aggregation is optional * body is optional * metricName and timespan is required * Changes for 2023-04-01-preview version * Minor refactoring * Added URL based changes and versioning support (versioning not working) * Versioning support changes * Refactoring * Refactoring * config changes * Added examples and few refactoring * Adding emitters for pythin, ts and csharp * Updated description for timespan field * Update tspconfig as validation pipelines failing. * Rename createOrUpdateTest.json to CreateOrUpdateTest.json * Rename createOrUpdateTestRun.json to CreateOrUpdateTestRun.json * Rename createOrUpdateTest.json to CreateOrUpdateTest.json * Rename createOrUpdateTestRun.json to CreateOrUpdateTestRun.json * suppress warning in client.tsp * Updated examples for stable version * Updated examples based on latest changes * Updated spec for 2023-04-01-preview * Added description for APIVersions model * Updated readme and added examples * removed tsp-output folder and files in it * Updated service name in client * Updated api version parameter * Pushing updated json * Removing unused example file * suppressing warnings in client.tsp * Changes to use standard templates for operations * Changing create and update to generic template as it is changing to default resource parameter. * Updating visibility of FileName * Minor change in name * changes in visibility of filename * Change in model name of fileInfo * Changing file info to testfileinfo * Updated jsons * Changes to rectify warning in pipeline * changing metricName to metricname * Updated examples to revert to metricname * Ran tsp format and update example for metricname parameter * Added query parameter for list test and testrun operation * Updated description * Enable linter rules * Updated description of models and operations * Updated specs after internal review of APIs * Added ContainerInfo in 2023-04-01-preview * Updated operation id for stop test run * Updated operation id for stop test run * Updated default values of properties * Description changes for few properties and models * Addressed errors in breaking change pipeline * Removed unused models, refactored code, addressed PR comments * nit: changes in client and model tsp * spec after nit changes * Changes suggested in API review * Update specification/loadtestservice/LoadTestService/client.tsp Co-authored-by: Timothee Guerin <timothee.guerin@outlook.com> * Suggested changes in API review * updating name and description for ContainerInfo * Added publicIPDisabled property to Test and TestRun model in 2023-04-01-preview version * Update properties in examples JSON files * Linting changes * Removed example tag and related imports * Minor linting * Merge main and changes after run npx command in local --------- Co-authored-by: Catalina Peralta <catalinaperaltah@hotmail.com> Co-authored-by: Mary Gao <yanmeigao1210@gmail.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Weidong Xu <weidxu@microsoft.com> Co-authored-by: Mike Harder <mharder@microsoft.com> Co-authored-by: Himanshu Bisht <hbisht@microsoft.com> Co-authored-by: Timothee Guerin <timothee.guerin@outlook.com>
arifibrahim4
pushed a commit
that referenced
this pull request
Feb 26, 2024
* initial tsp * client.tsp * client.tsp improvements * model updates * update routes * update implementation * Sync typespec and swagger change for loadtesting service (#24412) * Update the diff for put and patch operation * Change LoadTestAdministrationOperations to LoadTestAdministration to align with the swagger LoadTestAdministration_ prefix Change LoadTestRunOperations to LoadTestRun to align with the swagger LoadTestRun_ prefix * update models * add list metric dimensions op and fix create test run * update client.tsp * fix DimensionValueList and update TestRun model * Configuration changes for LoadTesting (#24481) * Update the projected name * Renamed * update config file * update folder * Remove client.tsp * Update the projected name to old ones * Adjust the positions * Update client.tsp * Update tspconfig.yaml Added correct options for python emitter. * Update the metadata * Change the projectedName to client.tsp * Remove the projectedName in routes.tsp * update file * Update the .Net config * Remove the projectedName change for load testing * Revert position change * Update specification/loadtestservice/LoadTestService/tspconfig.yaml --------- Co-authored-by: Ray Chen <raychen@microsoft.com> * update routes to be more accurate * update client.tsp for python * python config to avoid breaking (#24801) * python config * Update client.tsp * java, feature/loadtesting, match tsp and swagger (#24878) * java config * project for java * metricNamespace is required * aggregation is optional * body is optional * metricName and timespan is required * Changes for 2023-04-01-preview version * Minor refactoring * Added URL based changes and versioning support (versioning not working) * Versioning support changes * Refactoring * Refactoring * config changes * Added examples and few refactoring * Adding emitters for pythin, ts and csharp * Updated description for timespan field * Update tspconfig as validation pipelines failing. * Rename createOrUpdateTest.json to CreateOrUpdateTest.json * Rename createOrUpdateTestRun.json to CreateOrUpdateTestRun.json * Rename createOrUpdateTest.json to CreateOrUpdateTest.json * Rename createOrUpdateTestRun.json to CreateOrUpdateTestRun.json * suppress warning in client.tsp * Updated examples for stable version * Updated examples based on latest changes * Updated spec for 2023-04-01-preview * Added description for APIVersions model * Updated readme and added examples * removed tsp-output folder and files in it * Updated service name in client * Updated api version parameter * Pushing updated json * Removing unused example file * suppressing warnings in client.tsp * Changes to use standard templates for operations * Changing create and update to generic template as it is changing to default resource parameter. * Updating visibility of FileName * Minor change in name * changes in visibility of filename * Change in model name of fileInfo * Changing file info to testfileinfo * Updated jsons * Changes to rectify warning in pipeline * changing metricName to metricname * Updated examples to revert to metricname * Ran tsp format and update example for metricname parameter * Added query parameter for list test and testrun operation * Updated description * Enable linter rules * Updated description of models and operations * Updated specs after internal review of APIs * Added ContainerInfo in 2023-04-01-preview * Updated operation id for stop test run * Updated operation id for stop test run * Updated default values of properties * Description changes for few properties and models * Addressed errors in breaking change pipeline * Removed unused models, refactored code, addressed PR comments * nit: changes in client and model tsp * spec after nit changes * Changes suggested in API review * Update specification/loadtestservice/LoadTestService/client.tsp Co-authored-by: Timothee Guerin <timothee.guerin@outlook.com> * Suggested changes in API review * updating name and description for ContainerInfo * Added publicIPDisabled property to Test and TestRun model in 2023-04-01-preview version * Update properties in examples JSON files * Linting changes * Removed example tag and related imports * Minor linting * Merge main and changes after run npx command in local --------- Co-authored-by: Catalina Peralta <catalinaperaltah@hotmail.com> Co-authored-by: Mary Gao <yanmeigao1210@gmail.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Weidong Xu <weidxu@microsoft.com> Co-authored-by: Mike Harder <mharder@microsoft.com> Co-authored-by: Himanshu Bisht <hbisht@microsoft.com> Co-authored-by: Timothee Guerin <timothee.guerin@outlook.com>
krisnaray
pushed a commit
that referenced
this pull request
Apr 3, 2024
…#27565) * initial tsp * client.tsp * client.tsp improvements * model updates * update routes * update implementation * Sync typespec and swagger change for loadtesting service (#24412) * Update the diff for put and patch operation * Change LoadTestAdministrationOperations to LoadTestAdministration to align with the swagger LoadTestAdministration_ prefix Change LoadTestRunOperations to LoadTestRun to align with the swagger LoadTestRun_ prefix * update models * add list metric dimensions op and fix create test run * update client.tsp * fix DimensionValueList and update TestRun model * Configuration changes for LoadTesting (#24481) * Update the projected name * Renamed * update config file * update folder * Remove client.tsp * Update the projected name to old ones * Adjust the positions * Update client.tsp * Update tspconfig.yaml Added correct options for python emitter. * Update the metadata * Change the projectedName to client.tsp * Remove the projectedName in routes.tsp * update file * Update the .Net config * Remove the projectedName change for load testing * Revert position change * Update specification/loadtestservice/LoadTestService/tspconfig.yaml --------- Co-authored-by: Ray Chen <raychen@microsoft.com> * update routes to be more accurate * update client.tsp for python * python config to avoid breaking (#24801) * python config * Update client.tsp * java, feature/loadtesting, match tsp and swagger (#24878) * java config * project for java * metricNamespace is required * aggregation is optional * body is optional * metricName and timespan is required * Changes for 2023-04-01-preview version * Minor refactoring * Added URL based changes and versioning support (versioning not working) * Versioning support changes * Refactoring * Refactoring * config changes * Added examples and few refactoring * Adding emitters for pythin, ts and csharp * Updated description for timespan field * Update tspconfig as validation pipelines failing. * Rename createOrUpdateTest.json to CreateOrUpdateTest.json * Rename createOrUpdateTestRun.json to CreateOrUpdateTestRun.json * Rename createOrUpdateTest.json to CreateOrUpdateTest.json * Rename createOrUpdateTestRun.json to CreateOrUpdateTestRun.json * suppress warning in client.tsp * Updated examples for stable version * Updated examples based on latest changes * Updated spec for 2023-04-01-preview * Added description for APIVersions model * Updated readme and added examples * removed tsp-output folder and files in it * Updated service name in client * Updated api version parameter * Pushing updated json * Removing unused example file * suppressing warnings in client.tsp * Changes to use standard templates for operations * Changing create and update to generic template as it is changing to default resource parameter. * Updating visibility of FileName * Minor change in name * changes in visibility of filename * Change in model name of fileInfo * Changing file info to testfileinfo * Updated jsons * Changes to rectify warning in pipeline * changing metricName to metricname * Updated examples to revert to metricname * Ran tsp format and update example for metricname parameter * Added query parameter for list test and testrun operation * Updated description * Enable linter rules * Updated description of models and operations * Updated specs after internal review of APIs * Added ContainerInfo in 2023-04-01-preview * Updated operation id for stop test run * Updated operation id for stop test run * Updated default values of properties * Description changes for few properties and models * Addressed errors in breaking change pipeline * Removed unused models, refactored code, addressed PR comments * nit: changes in client and model tsp * spec after nit changes * Changes suggested in API review * Update specification/loadtestservice/LoadTestService/client.tsp Co-authored-by: Timothee Guerin <timothee.guerin@outlook.com> * Initial draft for control plane spec using TypeSpec * Suggested changes in API review * updating name and description for ContainerInfo * Added publicIPDisabled property to Test and TestRun model in 2023-04-01-preview version * Update properties in examples JSON files * Linting changes * Adding outbound and checkAvailability APIs * Added outboundNetworkDependenciesEndpoint and checkAvailability operations * Removed example tag and related imports * Minor linting * Merge main and changes after run npx command in local * Refactoring code * Addressing PR comments * Changes based on diff with existing swagger * nit * nit changes after merge * Added extension x-ms-parameter-location to loadTestName parameter * Resolved outboundNetworkDependenciesEndpoints API * Added examples to directory * minor changes based on pipeline validation failure * Fixing CI failures in PR * fixed LoadTestResourcePatchRequestBody * Changes to remove unwanted headers * Fixing required properties * Fixing CI failures * Fixing CI errors * Removed retry-after header from responses * Removing breaking changes * Fixing CI errors on PR * Resolving SDK breaking changes * Making value as optional in list response * linting by npx tsv * Changes based on PR comments * Removing breaking changes * Removed duplicate Resource model issue * Addressing PR comments * Updated model and routes to use templates and go for breaking changes in "value" making it required. * Updating location parameter to be used as common-types * removed 200 response for delete * Addressed PR comments, removed duplication of standard models * nit: addressing PR comments * removed @azure-tools/typespec-providerhub * update after npx tsv * Create sdk-suppressions.yaml * add azure-sdk-for-go suppression * Update sdk-suppressions.yaml * nit: json updated * nit: tsp compile * Addressed PR comments. Changed common type version from v5 to v3 * Using version v5 for common types due to warning from ManagedIdentityProperties model in Azure.ResourceManager.Foundations --------- Co-authored-by: Catalina Peralta <catalinaperaltah@hotmail.com> Co-authored-by: Mary Gao <yanmeigao1210@gmail.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Weidong Xu <weidxu@microsoft.com> Co-authored-by: Mike Harder <mharder@microsoft.com> Co-authored-by: Himanshu Bisht <hbisht@microsoft.com> Co-authored-by: Timothee Guerin <timothee.guerin@outlook.com> Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com>
wiboris
pushed a commit
to wiboris/azure-rest-api-specs
that referenced
this pull request
May 7, 2024
…Azure#27565) * initial tsp * client.tsp * client.tsp improvements * model updates * update routes * update implementation * Sync typespec and swagger change for loadtesting service (Azure#24412) * Update the diff for put and patch operation * Change LoadTestAdministrationOperations to LoadTestAdministration to align with the swagger LoadTestAdministration_ prefix Change LoadTestRunOperations to LoadTestRun to align with the swagger LoadTestRun_ prefix * update models * add list metric dimensions op and fix create test run * update client.tsp * fix DimensionValueList and update TestRun model * Configuration changes for LoadTesting (Azure#24481) * Update the projected name * Renamed * update config file * update folder * Remove client.tsp * Update the projected name to old ones * Adjust the positions * Update client.tsp * Update tspconfig.yaml Added correct options for python emitter. * Update the metadata * Change the projectedName to client.tsp * Remove the projectedName in routes.tsp * update file * Update the .Net config * Remove the projectedName change for load testing * Revert position change * Update specification/loadtestservice/LoadTestService/tspconfig.yaml --------- Co-authored-by: Ray Chen <raychen@microsoft.com> * update routes to be more accurate * update client.tsp for python * python config to avoid breaking (Azure#24801) * python config * Update client.tsp * java, feature/loadtesting, match tsp and swagger (Azure#24878) * java config * project for java * metricNamespace is required * aggregation is optional * body is optional * metricName and timespan is required * Changes for 2023-04-01-preview version * Minor refactoring * Added URL based changes and versioning support (versioning not working) * Versioning support changes * Refactoring * Refactoring * config changes * Added examples and few refactoring * Adding emitters for pythin, ts and csharp * Updated description for timespan field * Update tspconfig as validation pipelines failing. * Rename createOrUpdateTest.json to CreateOrUpdateTest.json * Rename createOrUpdateTestRun.json to CreateOrUpdateTestRun.json * Rename createOrUpdateTest.json to CreateOrUpdateTest.json * Rename createOrUpdateTestRun.json to CreateOrUpdateTestRun.json * suppress warning in client.tsp * Updated examples for stable version * Updated examples based on latest changes * Updated spec for 2023-04-01-preview * Added description for APIVersions model * Updated readme and added examples * removed tsp-output folder and files in it * Updated service name in client * Updated api version parameter * Pushing updated json * Removing unused example file * suppressing warnings in client.tsp * Changes to use standard templates for operations * Changing create and update to generic template as it is changing to default resource parameter. * Updating visibility of FileName * Minor change in name * changes in visibility of filename * Change in model name of fileInfo * Changing file info to testfileinfo * Updated jsons * Changes to rectify warning in pipeline * changing metricName to metricname * Updated examples to revert to metricname * Ran tsp format and update example for metricname parameter * Added query parameter for list test and testrun operation * Updated description * Enable linter rules * Updated description of models and operations * Updated specs after internal review of APIs * Added ContainerInfo in 2023-04-01-preview * Updated operation id for stop test run * Updated operation id for stop test run * Updated default values of properties * Description changes for few properties and models * Addressed errors in breaking change pipeline * Removed unused models, refactored code, addressed PR comments * nit: changes in client and model tsp * spec after nit changes * Changes suggested in API review * Update specification/loadtestservice/LoadTestService/client.tsp Co-authored-by: Timothee Guerin <timothee.guerin@outlook.com> * Initial draft for control plane spec using TypeSpec * Suggested changes in API review * updating name and description for ContainerInfo * Added publicIPDisabled property to Test and TestRun model in 2023-04-01-preview version * Update properties in examples JSON files * Linting changes * Adding outbound and checkAvailability APIs * Added outboundNetworkDependenciesEndpoint and checkAvailability operations * Removed example tag and related imports * Minor linting * Merge main and changes after run npx command in local * Refactoring code * Addressing PR comments * Changes based on diff with existing swagger * nit * nit changes after merge * Added extension x-ms-parameter-location to loadTestName parameter * Resolved outboundNetworkDependenciesEndpoints API * Added examples to directory * minor changes based on pipeline validation failure * Fixing CI failures in PR * fixed LoadTestResourcePatchRequestBody * Changes to remove unwanted headers * Fixing required properties * Fixing CI failures * Fixing CI errors * Removed retry-after header from responses * Removing breaking changes * Fixing CI errors on PR * Resolving SDK breaking changes * Making value as optional in list response * linting by npx tsv * Changes based on PR comments * Removing breaking changes * Removed duplicate Resource model issue * Addressing PR comments * Updated model and routes to use templates and go for breaking changes in "value" making it required. * Updating location parameter to be used as common-types * removed 200 response for delete * Addressed PR comments, removed duplication of standard models * nit: addressing PR comments * removed @azure-tools/typespec-providerhub * update after npx tsv * Create sdk-suppressions.yaml * add azure-sdk-for-go suppression * Update sdk-suppressions.yaml * nit: json updated * nit: tsp compile * Addressed PR comments. Changed common type version from v5 to v3 * Using version v5 for common types due to warning from ManagedIdentityProperties model in Azure.ResourceManager.Foundations --------- Co-authored-by: Catalina Peralta <catalinaperaltah@hotmail.com> Co-authored-by: Mary Gao <yanmeigao1210@gmail.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Weidong Xu <weidxu@microsoft.com> Co-authored-by: Mike Harder <mharder@microsoft.com> Co-authored-by: Himanshu Bisht <hbisht@microsoft.com> Co-authored-by: Timothee Guerin <timothee.guerin@outlook.com> Co-authored-by: Alancere <804873052@qq.com> Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When generating JS RLC pr for load testing service I found some breakings are introduced by the diff between typespec and swagger definition. So in this pr I tried to minimize them and I assume the swagger one is always right.
LoadTestServicefolder according to the structure guidelinePUT UploadTestFileaccording to swagger def and added the content type withapplication/octet-streamPATCHoperations according to swagger defAnother change is for tsp interface name changed from