Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Service Fabric] fix 2020-01 preview version add AddOnFeature, remove clusterUpgradeMode and description #12086

Merged
merged 1 commit into from
Jan 26, 2021

Conversation

a-santamaria
Copy link
Member

@a-santamaria a-santamaria commented Dec 13, 2020

Fixing version 2020-01-01-preview.
Add: ManagedCluster AddOnFeature (missing property)
Remove: clusterUpgradeMode and clusterUpgradeDescription as they are not available yet
And fix examples

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

Changelog

Please ensure to add changelog with this PR by answering the following questions.

  1. 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
  2. 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.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. 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:

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
    • 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 API 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 version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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.

…rUpgradeDescription as they are not available yet
@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Dec 13, 2020

Swagger Validation Report

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

Rule Message
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'UpgradeMode' removed or renamed?
New: Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json#L431:3
Old: Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json#L426:3
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'clusterUpgradeMode' renamed or removed?
New: Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json#L697:7
Old: Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json#L701:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'clusterUpgradeDescription' renamed or removed?
New: Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json#L697:7
Old: Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json#L701:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'clusterUpgradeMode' renamed or removed?
New: Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json#L605:7
Old: Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json#L608:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'clusterUpgradeDescription' renamed or removed?
New: Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json#L605:7
Old: Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json#L608:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'clusterUpgradeMode' renamed or removed?
New: Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json#L697:7
Old: Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json#L701:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'clusterUpgradeDescription' renamed or removed?
New: Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json#L697:7
Old: Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json#L701:7
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.

️⚠️Avocado: 1 Warnings warning [Detail]
Rule Message
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/servicefabric/resource-manager/readme.md
tag: specification/servicefabric/resource-manager/readme.md#tag-package-2020-03
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Dec 13, 2020

Swagger Generation Artifacts

️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from be58944. 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
    cmderr	[generate.py] 2021-01-26 06:50:32 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-servicefabric"
    cmderr	[generate.py] 2021-01-26 06:50:32 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
    cmderr	[generate.py] 2021-01-26 06:50:32 INFO autorest --version=3.0.6350 --use=@autorest/java@4.0.11 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/servicefabric/azure-resourcemanager-servicefabric --java.namespace=com.azure.resourcemanager.servicefabric   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/servicefabric/resource-manager/readme.md
    cmderr	[generate.py] 2021-01-26 06:51:21 INFO [CI][Success] Write to ci.yml
    cmderr	[generate.py] 2021-01-26 06:51:21 INFO [POM][Process] dealing with pom.xml
    cmderr	[generate.py] 2021-01-26 06:51:21 INFO [POM][Skip] pom already has module azure-resourcemanager-servicefabric
    cmderr	[generate.py] 2021-01-26 06:51:21 INFO [POM][Success] Write to pom.xml
    cmderr	[generate.py] 2021-01-26 06:51:21 INFO [POM][Process] dealing with root pom
    cmderr	[generate.py] 2021-01-26 06:51:21 INFO [POM][Success] Write to root pom
    cmderr	[generate.py] 2021-01-26 06:52:15 ERROR [COMPILE] Maven build fail
  • ️✔️azure-resourcemanager-servicefabric [View full logs]  [Release SDK Changes]
    cmderr	[Inst] 2021-01-26 06:53:11 DEBUG Got artifact_id: azure-resourcemanager-servicefabric
    cmderr	[Inst] 2021-01-26 06:53:11 DEBUG Got artifact: pom.xml
    cmderr	[Inst] 2021-01-26 06:53:11 ERROR Unmatch any jar in artifacts
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from be58944. 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] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
    cmderr	[automation_init.sh]   Failed building wheel for ConfigArgParse
    cmderr	[automation_init.sh]   Failed building wheel for yarl
    cmderr	[automation_init.sh]   Failed building wheel for wrapt
    cmderr	[automation_init.sh]   Failed building wheel for multidict
    cmderr	[automation_init.sh] Cannot uninstall requirement azure-nspkg, not installed
    cmderr	[automation_init.sh] Command '['/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/bin/python', '-m', 'pip', 'uninstall', '-y', 'azure-nspkg']' returned non-zero exit status 1.
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
  • ️✔️azure-mgmt-servicefabric [View full logs]  [Release SDK Changes] Breaking Change Detected
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Model ManagedCluster has a new parameter addon_features
    info	[Changelog]   - Model ManagedClusterUpdateParameters has a new parameter addon_features
    info	[Changelog]
    info	[Changelog] **Breaking changes**
    info	[Changelog]
    info	[Changelog]   - Model ManagedCluster no longer has parameter cluster_upgrade_mode
    info	[Changelog]   - Model ManagedCluster no longer has parameter cluster_upgrade_description
    info	[Changelog]   - Model ManagedCluster no longer has parameter reverse_proxy_endpoint_port
    info	[Changelog]   - Model ManagedCluster no longer has parameter use_test_extension
    info	[Changelog]   - Model ManagedClusterUpdateParameters no longer has parameter cluster_upgrade_mode
    info	[Changelog]   - Model ManagedClusterUpdateParameters no longer has parameter cluster_upgrade_description
    info	[Changelog]   - Model ManagedClusterUpdateParameters no longer has parameter reverse_proxy_endpoint_port
️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from be58944. Schema Automation 14.0.0
    warn	Skip initScript due to not configured
    command	npx n 12
    command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6351 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/servicefabric/resource-manager/readme.md
  • ️✔️servicefabric [View full logs]  [Release Schema Changes]
    cmderr	[resource-manager] node-pre-gyp
    cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
    cmderr	[resource-manager] npm WARN template-schema-validation-tools@1.0.0 No repository field.
    cmderr	[resource-manager] npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
    cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from be58944. SDK Automation 14.0.0
    command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️servicefabric/mgmt/2019-03-01/servicefabric [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
  • ️✔️servicefabric/mgmt/2016-09-01/servicefabric [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
  • ️✔️preview/servicefabric/mgmt/2019-03-01-preview/servicefabric [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
  • ️✔️preview/servicefabric/mgmt/2018-02-01-preview/servicefabric [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
  • ️✔️preview/servicefabric/mgmt/2017-07-01-preview/servicefabric [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from be58944. 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/servicefabric/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.ServiceFabric [View full logs]  [Release SDK Changes]
️❌[Staging] ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
Rule Message
RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=181395&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
"detail":"Run.ps1 failed with exit code 1 "
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi @a-santamaria, 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 think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ma/swaggerfeedback.

@a-santamaria
Copy link
Member Author

a-santamaria commented Dec 14, 2020

@leni-msft here is the justification for the breaking changes:
Removed clusterUpgradeDescription and clusterUpgradeMode from managed cluster definition. These operations are not available, They were added by mistake in this preview version

@leni-msft
Copy link
Contributor

Hi @a-santamaria , would you follow the breaking change process?

@a-santamaria
Copy link
Member Author

@leni-msft do we need to do this? this is a preview version and those parameters were never there (they were added to the swagger by mistake) we want to remove them to have the correct documentation

@leni-msft
Copy link
Contributor

hi @a-santamaria , per current rule, yes. Please provide business justification in the intake, I think they will approve it soon.

@ghost
Copy link

ghost commented Jan 3, 2021

Hi, @a-santamaria. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

@a-santamaria
Copy link
Member Author

created the intake to get approved: https://msazure.visualstudio.com/One/_workitems/edit/9193186

@JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 25, 2021
@a-santamaria
Copy link
Member Author

@leni-msft thanks, I followed the breaking change process and it has been approved. Can you merge the pr, please?

ghost pushed a commit to Azure/azure-resource-manager-schemas that referenced this pull request Jan 26, 2021
mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
…rUpgradeDescription as they are not available yet (Azure#12086)

Co-authored-by: Alfredo Santamaria Gomez <alsantam@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants