[Hub Generated] Review request for Microsoft.LoadTestService to add version stable/2022-12-01 #21356

venkatr21 · 2022-10-31T15:19:32Z

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-workflow-bot · 2022-10-31T15:19:37Z

Hi, @venkatr21 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. [email protected]

openapi-pipeline-app · 2022-10-31T15:19:37Z

Swagger Validation Report

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

compared swaggers (via Oad v0.10.2)]	new version	base version
loadtestservice.json	2022-12-01(b948a66)	2022-12-01(main)

Rule	Message
`❌` 1021 - AddedAdditionalProperties	The new version adds an 'additionalProperties' element. New: Microsoft.LoadTestService/stable/2022-12-01/loadtestservice.json#L635:9 Old: Microsoft.LoadTestService/stable/2022-12-01/loadtestservice.json#L617:9

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

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.0)	new version	base version
package-2022-12-01	package-2022-12-01(b948a66)	package-2022-12-01(main)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.LoadTestService/stable/2022-12-01/loadtestservice.json#L651
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.LoadTestService/stable/2022-12-01/loadtestservice.json#L821

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

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

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

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

️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

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

Validation passed for PoliCheck.

️️✔️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-pipeline-app · 2022-10-31T15:19:37Z

Swagger Generation Artifacts

️🔄ApiDocPreview inProgress [Detail]

️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-go - sdk/resourcemanager/loadtestservice/armloadtestservice - 2.0.0

+	Type of `LoadTestResourcePatchRequestBody.Tags` has been changed from `interface{}` to `map[string]*string`

️⌛ azure-sdk-for-python-track2 pending [Detail]

️⌛ azure-sdk-for-java pending [Detail]

️🔄 azure-sdk-for-go inProgress [Detail]

️⌛ azure-sdk-for-js pending [Detail]

️🔄 azure-powershell inProgress [Detail]

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

openapi-pipeline-app · 2022-10-31T15:19:38Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/loadtestservice/armloadtesting	https://apiview.dev/Assemblies/Review/b7bf204bb58a4376bbdbe4a0376dd75c
Python	track2_azure-mgmt-loadtesting	https://apiview.dev/Assemblies/Review/1c8dffe69e11439ea09585d57110b026
JavaScript	@azure/arm-loadtesting	https://apiview.dev/Assemblies/Review/c8f80231042d4870af1c543bf35b5f06

openapi-workflow-bot · 2022-10-31T15:25:09Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

openapi-pipeline-app · 2022-11-09T06:20:39Z

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-go - sdk/resourcemanager/loadtestservice/armloadtestservice - Approved - 2.0.0

+	Type of `LoadTestResourcePatchRequestBody.Tags` has been changed from `interface{}` to `map[string]*string`

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

⚠️Warning [Logs]Release - Generate from a3b67e1. 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] npm notice
cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.2 -> 9.1.1
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.1.1>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-loadtesting [View full logs] [Release SDK Changes]
- azure_mgmt_loadtesting-1.0.0b1-py3-none-any.whl
- azure-mgmt-loadtesting-1.0.0b1.zip
```
info	[Changelog]   - Initial Release
```

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from a3b67e1. 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
cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
warn	No file changes detected after generation
warn	No package detected after generation

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

️✔️Succeeded [Logs]Release - Generate from a3b67e1. 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/armloadtesting [View full logs] [Release SDK Changes]
```
info	[Changelog] This is a new package
info	[Changelog]
```

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

️✔️Succeeded [Logs]Release - Generate from a3b67e1. 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-loadtesting [View full logs] [Release SDK Changes]

azure-arm-loadtesting-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 a3b67e1. 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?}

venkatr21 · 2022-11-09T19:34:19Z

@rkmanda the breaking changes has been approved by the breaking change review team.
In the CI pipeline, not sure why swagger model validation fails. We have not updated anything regarding the same LRO response header.
Please help us with the ARM review and signoff.

xiaoxuqi-ms · 2022-11-11T09:14:07Z

@raych1, could you help to take a look at the update of common types?

venkatr21 · 2022-11-11T09:28:11Z

@raych1 just to give a context on the update of common types:
As per the doc: Managed Identity

null is an allowed property in the Managed identity payload as mentioned in the screenshot and doc above.
For the same case, to ensure other clients calling the API allows passing "null" value in the patch payload, we have added "x-nullable" to be true in the user assigned identity property.

…ersion stable/2022-12-01 (Azure#21356) * changes needed for autorest cli * adding nullable property for UAMI * changed namespace for go,py,js * updated markdown files * deleted unused markdown * updated tags nullability * updated c# output folder * moving MI nullability away from common types * added x-nullable property to user MI * updated enum value * fix model validation failure

changes needed for autorest cli

de82e43

ghost added the Load Test Service Azure Load Test Service label Oct 31, 2022

openapi-workflow-bot bot added the FixS360 label Oct 31, 2022

AzureRestAPISpecReview added NewApiVersionRequired resource-manager RPaaS labels Oct 31, 2022

azure-sdk mentioned this pull request Oct 31, 2022

[AutoPR sdk/resourcemanager/loadtestservice/armloadtestservice] [Hub Generated] Review request for Microsoft.LoadTestService to add version stable/2022-12-01 azure-sdk/azure-sdk-for-go#3385

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label Oct 31, 2022

venkatr21 added 2 commits November 4, 2022 14:32

adding nullable property for UAMI

87446cd

changed namespace for go,py,js

ee55739

venkatr21 added 4 commits November 4, 2022 16:46

updated markdown files

f3c0419

deleted unused markdown

52d8538

updated tags nullability

082cbd2

updated c# output folder

45cd010

venkatr21 marked this pull request as ready for review November 4, 2022 12:18

venkatr21 requested review from msyyc, Wzb123456789 and ArcturusZhang as code owners November 4, 2022 12:18

azure-sdk mentioned this pull request Nov 9, 2022

[AutoPR Az.loadtestservice] [Hub Generated] Review request for Microsoft.LoadTestService to add version stable/2022-12-01 azure-sdk/azure-powershell#3311

Closed

added x-nullable property to user MI

5f15bb8

AzureRestAPISpecReview added the new-api-version label Nov 9, 2022

updated enum value

9ff2005

AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Nov 9, 2022

weidongxu-microsoft added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Nov 9, 2022

mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Nov 9, 2022

venkatr21 removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 9, 2022

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 9, 2022

rkmanda added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Nov 10, 2022

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 10, 2022

fix model validation failure

b948a66

tadelesh added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Nov 11, 2022

xiaoxuqi-ms approved these changes Nov 14, 2022

View reviewed changes

xiaoxuqi-ms merged commit a3b67e1 into Azure:main Nov 14, 2022

venkatr21 deleted the dev-loadtestservice-Microsoft.LoadTestService-2022-12-01 branch January 17, 2023 04:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Hub Generated] Review request for Microsoft.LoadTestService to add version stable/2022-12-01 #21356

[Hub Generated] Review request for Microsoft.LoadTestService to add version stable/2022-12-01 #21356

Uh oh!

venkatr21 commented Oct 31, 2022 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Oct 31, 2022

Uh oh!

openapi-pipeline-app bot commented Oct 31, 2022 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Oct 31, 2022 •

edited

Loading

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app bot commented Oct 31, 2022 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Oct 31, 2022

Uh oh!

openapi-pipeline-app bot commented Nov 9, 2022 •

edited

Loading

Breaking Changes Tracking

Uh oh!

venkatr21 commented Nov 9, 2022

Uh oh!

xiaoxuqi-ms commented Nov 11, 2022

Uh oh!

venkatr21 commented Nov 11, 2022 •

edited

Loading

Uh oh!

Uh oh!

[Hub Generated] Review request for Microsoft.LoadTestService to add version stable/2022-12-01 #21356

[Hub Generated] Review request for Microsoft.LoadTestService to add version stable/2022-12-01 #21356

Uh oh!

Conversation

venkatr21 commented Oct 31, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented Oct 31, 2022

Uh oh!

openapi-pipeline-app bot commented Oct 31, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented Oct 31, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app bot commented Oct 31, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

openapi-workflow-bot bot commented Oct 31, 2022

Uh oh!

openapi-pipeline-app bot commented Nov 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

venkatr21 commented Nov 9, 2022

Uh oh!

xiaoxuqi-ms commented Nov 11, 2022

Uh oh!

venkatr21 commented Nov 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

venkatr21 commented Oct 31, 2022 •

edited

Loading

openapi-pipeline-app bot commented Oct 31, 2022 •

edited

Loading

openapi-pipeline-app bot commented Oct 31, 2022 •

edited

Loading

openapi-pipeline-app bot commented Oct 31, 2022 •

edited

Loading

openapi-pipeline-app bot commented Nov 9, 2022 •

edited

Loading

venkatr21 commented Nov 11, 2022 •

edited

Loading