[Service Fabric Managed Clusters] fix api 2021_01_01-preview by LukeSlev · Pull Request #14012 · Azure/azure-rest-api-specs

LukeSlev · 2021-04-19T19:19:35Z

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

Update managed clusters preview api to disable broken properties, add property that is working and update a description on managed clusters. These changes are being replicated to GA api as well #13961

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh 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

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
- Adding a new service
Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in 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.

…hat is working

openapi-pipeline-app · 2021-04-19T19:19:38Z

Swagger Validation Report

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

Compared Swaggers (Based on Oad v0.8.9)
- original: preview/2021-01-01-preview/managedapplication.json <---> new: preview/2021-01-01-preview/managedapplication.json
- original: preview/2021-01-01-preview/managedcluster.json <---> new: preview/2021-01-01-preview/managedcluster.json

Rule	Message
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'serviceDnsName' renamed or removed? New: Microsoft.ServiceFabricManagedClusters/preview/2021-01-01-preview/managedapplication.json#L2208:7 Old: Microsoft.ServiceFabricManagedClusters/preview/2021-01-01-preview/managedapplication.json#L2203:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'dropSourceReplicaOnMove' renamed or removed? New: Microsoft.ServiceFabricManagedClusters/preview/2021-01-01-preview/managedapplication.json#L2388:7 Old: Microsoft.ServiceFabricManagedClusters/preview/2021-01-01-preview/managedapplication.json#L2387:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'serviceDnsName' renamed or removed? New: Microsoft.ServiceFabricManagedClusters/preview/2021-01-01-preview/managedapplication.json#L2388:7 Old: Microsoft.ServiceFabricManagedClusters/preview/2021-01-01-preview/managedapplication.json#L2387:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'instanceCloseDelayDuration' renamed or removed? New: Microsoft.ServiceFabricManagedClusters/preview/2021-01-01-preview/managedapplication.json#L2434:7 Old: Microsoft.ServiceFabricManagedClusters/preview/2021-01-01-preview/managedapplication.json#L2437:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'serviceDnsName' renamed or removed? New: Microsoft.ServiceFabricManagedClusters/preview/2021-01-01-preview/managedapplication.json#L2434:7 Old: Microsoft.ServiceFabricManagedClusters/preview/2021-01-01-preview/managedapplication.json#L2437:7
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'useOnlyPrimaryLoad' that was not found in the old version. New: Microsoft.ServiceFabricManagedClusters/preview/2021-01-01-preview/managedapplication.json#L1465:7 Old: Microsoft.ServiceFabricManagedClusters/preview/2021-01-01-preview/managedapplication.json#L1464:7
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'useOnlyPrimaryLoad' that was not found in the old version. New: Microsoft.ServiceFabricManagedClusters/preview/2021-01-01-preview/managedapplication.json#L1446:5 Old: Microsoft.ServiceFabricManagedClusters/preview/2021-01-01-preview/managedapplication.json#L1446:5

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- servicefabricmanagedclusters/resource-manager/readme.md tag:package-2021-01-preview
Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- servicefabricmanagedclusters/resource-manager/readme.md tag:package-2021-01-preview

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ServiceFabricManagedClusters/preview/2021-01-01-preview/managedapplication.json#L2169

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

Validation passes for Avocado.

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

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

The following tags are being changed in this PR

servicefabricmanagedclusters/resource-manager/readme.md#package-2021-01-preview

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"servicefabricmanagedclusters/resource-manager/readme.md",
"tag":"package-2021-01-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"servicefabricmanagedclusters/resource-manager/readme.md",
"tag":"package-2021-01-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|

The following errors/warnings exist before current PR submission:

Only 10 items are listed, please refer to log for more details.

Rule	Message
⚠️ PreCheck/EmptyParentSchemaWarning	"readme":"servicefabricmanagedclusters/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"Schema 'AddRemoveIncrementalNamedPartitionScalingMechanism' has an allOf list with an empty object schema as a parent, removing it."
⚠️ PreCheck/EmptyParentSchemaWarning	"readme":"servicefabricmanagedclusters/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"Schema 'AveragePartitionLoadScalingTrigger' has an allOf list with an empty object schema as a parent, removing it."
⚠️ PreCheck/EmptyParentSchemaWarning	"readme":"servicefabricmanagedclusters/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"Schema 'AverageServiceLoadScalingTrigger' has an allOf list with an empty object schema as a parent, removing it."
⚠️ PreCheck/EmptyParentSchemaWarning	"readme":"servicefabricmanagedclusters/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"Schema 'NamedPartitionScheme' has an allOf list with an empty object schema as a parent, removing it."
⚠️ PreCheck/EmptyParentSchemaWarning	"readme":"servicefabricmanagedclusters/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"Schema 'PartitionInstanceCountScaleMechanism' has an allOf list with an empty object schema as a parent, removing it."
⚠️ PreCheck/EmptyParentSchemaWarning	"readme":"servicefabricmanagedclusters/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"Schema 'ServicePlacementInvalidDomainPolicy' has an allOf list with an empty object schema as a parent, removing it."
⚠️ PreCheck/EmptyParentSchemaWarning	"readme":"servicefabricmanagedclusters/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"Schema 'ServicePlacementPreferPrimaryDomainPolicy' has an allOf list with an empty object schema as a parent, removing it."
⚠️ PreCheck/EmptyParentSchemaWarning	"readme":"servicefabricmanagedclusters/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"Schema 'ServicePlacementRequiredDomainPolicy' has an allOf list with an empty object schema as a parent, removing it."
⚠️ PreCheck/EmptyParentSchemaWarning	"readme":"servicefabricmanagedclusters/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"Schema 'ServicePlacementRequireDomainDistributionPolicy' has an allOf list with an empty object schema as a parent, removing it."
⚠️ PreCheck/EmptyParentSchemaWarning	"readme":"servicefabricmanagedclusters/resource-manager/readme.md", "tag":"package-2021-01-preview", "details":"Schema 'UniformInt64RangePartitionScheme' has an allOf list with an empty object schema as a parent, removing it."

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

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

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

openapi-workflow-bot · 2021-04-19T19:19:38Z

Hi, @LukeSlev 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. vsswagger@microsoft.com

openapi-pipeline-app · 2021-04-19T19:19:39Z

Swagger Generation Artifacts

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

⚠️Warning [Logs]Release - Generate from 14cf80e. 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

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

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Model LoadBalancingRule has a new parameter probe_port
info	[Changelog]   - Model ManagedCluster has a new parameter zonal_resiliency
info	[Changelog]   - Model ManagedCluster has a new parameter cluster_upgrade_mode
info	[Changelog]   - Model NodeType has a new parameter is_stateless
info	[Changelog]   - Model NodeType has a new parameter data_disk_type
info	[Changelog]   - Model NodeType has a new parameter multiple_placement_groups
info	[Changelog]   - Added operation group ManagedClusterVersionOperations
info	[Changelog]
info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Model StatelessServiceProperties no longer has parameter instance_close_delay_duration
info	[Changelog]   - Model StatelessServiceProperties no longer has parameter service_dns_name
info	[Changelog]   - Model AverageServiceLoadScalingTrigger has a new required parameter use_only_primary_load
info	[Changelog]   - Model StatefulServiceProperties no longer has parameter drop_source_replica_on_move
info	[Changelog]   - Model StatefulServiceProperties no longer has parameter service_dns_name
info	[Changelog]   - Model ServiceResourceProperties no longer has parameter service_dns_name

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

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

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/servicefabricmanagedclusters/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied

️✔️Microsoft.Azure.Management.ServiceFabricManagedClusters [View full logs] [Release SDK Changes]
- Microsoft.Azure.Management.ServiceFabricManagedClusters.1.0.0.nupkg
- Microsoft.Azure.Management.ServiceFabricManagedClusters.1.0.0.snupkg

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from 14cf80e. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
warn	No file changes detected after generation
warn	Skip detect changed packages

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

 Please click here to preview with your @microsoft account.

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

openapi-workflow-bot · 2021-04-19T19:19:40Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-workflow-bot · 2021-04-19T19:22:34Z

Hi @LukeSlev, 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.

LukeSlev · 2021-04-19T21:12:38Z

Hi @LukeSlev, 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.

@ArcturusZhang This change will fix the preview api to align with actual api; we have disabled the properties instanceCloseDelayDuration, dropSourceReplicaOnMove and serviceDnsName as they are not currently working and the property we want to add, useOnlyPrimaryLoad, already works in this api version. As well we are updating a description of property maxUnusedVersionsToKeep to be more descriptive and let users know more about its behaviour. This change is being added to the GA version (#13961) and needs to be added to the preview version as well or else customers will be able to run into issues when using managed clusters

Intake to approve breaking change is here: https://msazure.visualstudio.com/One/_workitems/edit/9759753

ArcturusZhang · 2021-04-20T09:01:36Z

I will merge this PR once the breaking changes get approved

LukeSlev · 2021-04-26T20:43:40Z

@ArcturusZhang breaking changes were approved

Update preview api to disable broken properties and to add property t…

c473ea0

…hat is working

openapi-assignment-bot bot assigned ArcturusZhang Apr 19, 2021

openapi-pipeline-app bot added the BreakingChangeReviewRequired label Apr 19, 2021

openapi-sdkautomation bot mentioned this pull request Apr 19, 2021

[AutoPR track2_azure-mgmt-servicefabricmanagedclusters] [Service Fabric Managed Clusters] fix api 2021_01_01-preview AzureSDKAutomation/azure-sdk-for-python#5239

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Apr 19, 2021

openapi-sdkautomation bot mentioned this pull request Apr 19, 2021

[AutoPR Microsoft.Azure.Management.ServiceFabricManagedClusters] [Service Fabric Managed Clusters] fix api 2021_01_01-preview AzureSDKAutomation/azure-sdk-for-net#3961

Closed

Update managed cluster description

42311fd

JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Apr 26, 2021

JeffreyRichter approved these changes Apr 26, 2021

View reviewed changes

ArcturusZhang merged commit 14cf80e into Azure:master Apr 29, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Service Fabric Managed Clusters] fix api 2021_01_01-preview#14012

[Service Fabric Managed Clusters] fix api 2021_01_01-preview#14012
ArcturusZhang merged 2 commits intoAzure:masterfrom
LukeSlev:user/luslevin/sfrp-managedclusters-2021-01-01-preview-fix

LukeSlev commented Apr 19, 2021 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Apr 19, 2021 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Apr 19, 2021

Uh oh!

openapi-pipeline-app bot commented Apr 19, 2021 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Apr 19, 2021

Uh oh!

openapi-workflow-bot bot commented Apr 19, 2021

Uh oh!

LukeSlev commented Apr 19, 2021 •

edited

Loading

Uh oh!

ArcturusZhang commented Apr 20, 2021

Uh oh!

LukeSlev commented Apr 26, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

LukeSlev commented Apr 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

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

Uh oh!

Swagger Validation Report

Uh oh!

openapi-workflow-bot bot commented Apr 19, 2021

Uh oh!

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

Uh oh!

Swagger Generation Artifacts

Uh oh!

openapi-workflow-bot bot commented Apr 19, 2021

Uh oh!

openapi-workflow-bot bot commented Apr 19, 2021

Uh oh!

LukeSlev commented Apr 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ArcturusZhang commented Apr 20, 2021

Uh oh!

LukeSlev commented Apr 26, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

LukeSlev commented Apr 19, 2021 •

edited

Loading

openapi-pipeline-app bot commented Apr 19, 2021 •

edited

Loading

openapi-pipeline-app bot commented Apr 19, 2021 •

edited

Loading

LukeSlev commented Apr 19, 2021 •

edited

Loading