make required field changes #20128

HarshAulakhh · 2022-08-05T10:36:56Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

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.
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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

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

openapi-workflow-bot · 2022-08-05T10:36:59Z

Hi, @HarshAulakhh 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-08-05T10:37:01Z

Swagger Validation Report

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

compared swaggers (via Oad v0.9.6)]	new version	base version
elasticsan.json	2021-11-20-preview(f71f471)	2021-11-20-preview(main)

Rule	Message
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'name' that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1342:11 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1339:11
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'name' that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1203:9 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1200:9
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'sku' that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1177:9 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1174:9
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'properties' that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1159:11 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1159:11
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'properties' that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L247:13 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L247:13
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'properties' that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L259:13 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L259:13
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'properties' that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L265:13 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L265:13
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'properties' that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L321:13 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L321:13
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'properties' that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L421:13 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L421:13
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'properties' that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1170:5 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1170:5
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'sku' that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1194:5 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1191:5
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'name' that was not found in the old version. New: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1495:5 Old: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1492:5

️️✔️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 v1.13.0)	new version	base version
package-2021-11-20-preview	package-2021-11-20-preview(f71f471)	package-2021-11-20-preview(main)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R1001 - OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Volumes' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L964
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json#L1114

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

Validation passes for Avocado.

️️✔️ApiReadinessCheck 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.

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

The following tags are being changed in this PR

"https://github.com/Azure/azure-rest-api-specs/blob/f71f471ade38b4eb27698d543a3d7d7c9480934b/specification/elasticsan/resource-manager/readme.md#tag-package-2021-11-20-preview">elasticsan/resource-manager/readme.md#package-2021-11-20-preview

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ UnkownSecurityScheme	"readme":"elasticsan/resource-manager/readme.md", "tag":"package-2021-11-20-preview", "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.

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

openapi-pipeline-app · 2022-08-05T10:37:02Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️✔️azure-sdk-for-go - armelasticsans - 0.1.0
️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-elasticsan - first release

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

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

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.ElasticSan [View full logs] [Release SDK Changes]
- Azure.ResourceManager.ElasticSan.1.0.0-alpha.20220810.1.nupkg
```
info	[Changelog]
```

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

⚠️Warning [Logs]Release - Generate from 8006549. 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]  WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.

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

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

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

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

️✔️Succeeded [Logs]Release - Generate from 8006549. 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

️✔️armelasticsans [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 8006549. 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-elasticsan [View full logs] [Release SDK Changes]
- azure-arm-elasticsan-1.0.0-beta.1.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

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

openapi-pipeline-app · 2022-08-05T10:37:03Z

Generated ApiView

Language	Package Name	ApiView Link
Python	track2_azure-mgmt-elasticsan	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-elasticsan	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-elasticsan	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
.Net	Azure.ResourceManager.ElasticSan	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-08-05T10:39:48Z

Hi @HarshAulakhh, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

make required field changes

f71f471

openapi-assignment-bot bot assigned raych1 Aug 5, 2022

HarshAulakhh requested review from PPrahalad and priyapansrp August 5, 2022 10:37

openapi-pipeline-app bot added the BreakingChangeReviewRequired label Aug 5, 2022

openapi-pipeline-app bot added the resource-manager label Aug 5, 2022

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

raych1 assigned ruowan and unassigned raych1 Aug 9, 2022

ruowan approved these changes Aug 10, 2022

View reviewed changes

ruowan merged commit 8006549 into Azure:main Aug 10, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

make required field changes #20128

make required field changes #20128

HarshAulakhh commented Aug 5, 2022 •

edited

Loading

openapi-workflow-bot bot commented Aug 5, 2022

openapi-pipeline-app bot commented Aug 5, 2022 •

edited

Loading

openapi-pipeline-app bot commented Aug 5, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Aug 5, 2022 •

edited

Loading

openapi-workflow-bot bot commented Aug 5, 2022

make required field changes #20128

make required field changes #20128

Conversation

HarshAulakhh commented Aug 5, 2022 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Aug 5, 2022

openapi-pipeline-app bot commented Aug 5, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Aug 5, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Aug 5, 2022 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Aug 5, 2022

HarshAulakhh commented Aug 5, 2022 •

edited

Loading

openapi-pipeline-app bot commented Aug 5, 2022 •

edited

Loading

openapi-pipeline-app bot commented Aug 5, 2022 •

edited

Loading

openapi-pipeline-app bot commented Aug 5, 2022 •

edited

Loading