[Hub Generated] Review request for Microsoft.LoadTestService to add version preview/2022-04-15-preview by mjmadhu · Pull Request #20917 · Azure/azure-rest-api-specs

mjmadhu · 2022-09-28T16:43:41Z

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

openapi-pipeline-app · 2022-09-28T16:43:44Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.9.7)]	new version	base version
loadtestservice.json	2022-12-01(eedda8e)	2022-04-15-preview(main)

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 1 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2022-12-01	package-2022-12-01(eedda8e)	default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isAvailable Location: Microsoft.LoadTestService/stable/2022-12-01/loadtestservice.json#L798

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` API Readiness check failed. Please make sure your service is deployed.	"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.LoadTestService' for api version '2022-12-01'. The supported api-versions are '2020-09-01-preview, 2021-09-01-preview, 2021-11-01-preview, 2021-12-01-preview, 2022-04-01-preview, 2022-04-15-preview, 2022-08-01-preview'."

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️⚠️~[Staging] TrafficValidation: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]

The following tags are being changed in this PR

"https://github.com/Azure/azure-rest-api-specs/blob/eedda8e42be254e5f25f246f636b4101d0735544/specification/loadtestservice/resource-manager/readme.md#tag-package-2022-12-01">loadtestservice/resource-manager/readme.md#package-2022-12-01

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ UnkownSecurityScheme	"readme":"loadtestservice/resource-manager/readme.md", "tag":"package-2022-12-01", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous"

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2022-09-28T16:43:44Z

Hi, @mjmadhu Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

openapi-pipeline-app · 2022-09-28T16:43:44Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-python-track2 - track2_azure-mgmt-loadtestservice - Approved - 1.0.0b1

+	Client name is changed from `LoadTestClient` to `LoadTestMgmtClient`
+	Model LoadTestResourcePatchRequestBody no longer has parameter properties
+	Renamed operation LoadTestsOperations.create_or_update to LoadTestsOperations.begin_create_or_update
+	Renamed operation LoadTestsOperations.update to LoadTestsOperations.begin_update

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from cea4ad3. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.15.0 -> 8.19.2
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.2>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.19.2` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-loadtestservice [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation LoadTestsOperations.list_outbound_network_dependencies_endpoints
info	[Changelog]   - Added operation group QuotasOperations
info	[Changelog]   - Model LoadTestResource has a new parameter encryption
info	[Changelog]   - Model LoadTestResourcePatchRequestBody has a new parameter description
info	[Changelog]   - Model LoadTestResourcePatchRequestBody has a new parameter encryption
info	[Changelog]
info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog]   - Client name is changed from `LoadTestClient` to `LoadTestMgmtClient`
info	[Changelog]   - Model LoadTestResourcePatchRequestBody no longer has parameter properties
info	[Changelog]   - Renamed operation LoadTestsOperations.create_or_update to LoadTestsOperations.begin_create_or_update
info	[Changelog]   - Renamed operation LoadTestsOperations.update to LoadTestsOperations.begin_update

️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from cea4ad3. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-loadtestservice [View full logs] [Release SDK Changes]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from cea4ad3. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/loadtestservice/armloadtestservice [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New function `*QuotasClient.CheckAvailability(context.Context, string, string, QuotaBucketRequest, *QuotasClientCheckAvailabilityOptions) (QuotasClientCheckAvailabilityResponse, error)`
info	[Changelog] - New function `*QuotasClient.Get(context.Context, string, string, *QuotasClientGetOptions) (QuotasClientGetResponse, error)`
info	[Changelog] - New function `*QuotasClient.NewListPager(string, *QuotasClientListOptions) *runtime.Pager[QuotasClientListResponse]`
info	[Changelog] - New function `*LoadTestsClient.NewListOutboundNetworkDependenciesEndpointsPager(string, string, *LoadTestsClientListOutboundNetworkDependenciesEndpointsOptions) *runtime.Pager[LoadTestsClientListOutboundNetworkDependenciesEndpointsResponse]`
info	[Changelog] - New function `NewQuotasClient(string, azcore.TokenCredential, *arm.ClientOptions) (*QuotasClient, error)`
info	[Changelog] - New struct `CheckQuotaAvailabilityResponse`
info	[Changelog] - New struct `CheckQuotaAvailabilityResponseProperties`
info	[Changelog] - New struct `EndpointDependency`
info	[Changelog] - New struct `EndpointDetail`
info	[Changelog] - New struct `LoadTestsClientListOutboundNetworkDependenciesEndpointsOptions`
info	[Changelog] - New struct `LoadTestsClientListOutboundNetworkDependenciesEndpointsResponse`
info	[Changelog] - New struct `OutboundEnvironmentEndpoint`
info	[Changelog] - New struct `OutboundEnvironmentEndpointCollection`
info	[Changelog] - New struct `QuotaBucketRequest`
info	[Changelog] - New struct `QuotaBucketRequestProperties`
info	[Changelog] - New struct `QuotaBucketRequestPropertiesDimensions`
info	[Changelog] - New struct `QuotaResource`
info	[Changelog] - New struct `QuotaResourceList`
info	[Changelog] - New struct `QuotaResourceProperties`
info	[Changelog] - New struct `QuotasClient`
info	[Changelog] - New struct `QuotasClientCheckAvailabilityOptions`
info	[Changelog] - New struct `QuotasClientCheckAvailabilityResponse`
info	[Changelog] - New struct `QuotasClientGetOptions`
info	[Changelog] - New struct `QuotasClientGetResponse`
info	[Changelog] - New struct `QuotasClientListOptions`
info	[Changelog] - New struct `QuotasClientListResponse`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 47 additive change(s).

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from cea4ad3. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/arm-loadtestservice [View full logs] [Release SDK Changes]
- azure-arm-loadtestservice-1.0.0.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

️️✔️ azure-powershell succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from cea4ad3. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

️✔️Az.LoadTest [View full logs] [Release SDK Changes]
- Az.LoadTest.0.1.0.nupkg

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2022-09-28T16:43:45Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/loadtestservice/armloadtestservice	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Python	track2_azure-mgmt-loadtestservice	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Java	azure-resourcemanager-loadtestservice	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
JavaScript	@azure/arm-loadtestservice	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

openapi-workflow-bot · 2022-09-28T16:44:19Z

Hi, @mjmadhu your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

...estservice/resource-manager/Microsoft.LoadTestService/stable/2022-12-01/loadtestservice.json

openapi-workflow-bot · 2022-09-28T21:47:03Z

Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

Updated description for outbound network dependency endpoints

mjmadhu · 2022-09-30T01:40:13Z

@chunyu3 Please help with the merge of the PR

mjmadhu added 2 commits September 28, 2022 22:01

First commit with existing version files in new folder

5743d7c

Added new stable version 2022-12-01

a1e1c67

openapi-assignment-bot bot assigned chunyu3 Sep 28, 2022

openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 28, 2022

mjmadhu mentioned this pull request Sep 28, 2022

[Hub Generated] Review request for Microsoft.LoadTestService to add version preview/2022-04-15-preview #20850

Closed

11 tasks

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Sep 28, 2022

AzureRestAPISpecReview added ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS labels Sep 28, 2022