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

Sanjaiga/removetemplatedeploymentoptions #14522

Conversation

sanjaiganesh
Copy link
Contributor

@sanjaiganesh sanjaiganesh commented May 21, 2021

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
    • 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.

@openapi-workflow-bot
Copy link

Hi, @sanjaiganesh 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-workflow-bot
    Copy link

    [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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 21, 2021

    Swagger Validation Report

    ️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]
    Rule Message
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'templateDeploymentOptions' renamed or removed?
    New: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L3758:7
    Old: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L3768:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'subscriptionLifecycleNotificationSpecifications' renamed or removed?
    New: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L3838:7
    Old: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L3855:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'templateDeploymentOptions' renamed or removed?
    New: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L3838:7
    Old: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L3855:7
    1045 - AddedOptionalProperty The new version has a new optional property 'provisioningState' that was not found in the old version.
    New: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L4527:7
    Old: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L4587:7
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R4021 - DescriptionAndTitleMissing 'ProvisioningState' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L2141


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L2315
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L2579
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L3483
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L3569
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L3860
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L4312
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L4548
    ⚠️ R2017 - PutRequestResponseScheme A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Operations_CreateOrUpdate' Request Model: 'OperationsPutContent' Response Model: 'OperationsContent'
    Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L769
    ⚠️ R2017 - PutRequestResponseScheme A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Skus_CreateOrUpdate' Request Model: 'ResourceTypeSku' Response Model: 'SkuResource'
    Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L1326
    ⚠️ R2017 - PutRequestResponseScheme A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Skus_CreateOrUpdateNestedResourceTypeFirst' Request Model: 'ResourceTypeSku' Response Model: 'SkuResource'
    Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L1478
    ️️✔️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 Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️[Staging] SDK Track2 Validation: 5 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ Modeler/MissingType "readme":"providerhub/resource-manager/readme.md",
    "tag":"package-2021-05-01-preview",
    "details":"The schema 'ResourceProviderManagement-resourceAccessRolesItem' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#/components/schemas/ResourceProviderManagement-resourceAccessRolesItem"
    ⚠️ Modeler/MissingType "readme":"providerhub/resource-manager/readme.md",
    "tag":"package-2021-05-01-preview",
    "details":"The schema 'ResourceProviderManifestProperties-metadata' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#/components/schemas/ResourceProviderManifestProperties-metadata"
    ⚠️ Modeler/MissingType "readme":"providerhub/resource-manager/readme.md",
    "tag":"package-2021-05-01-preview",
    "details":"The schema 'ResourceType-metadata' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#/components/schemas/ResourceType-metadata"
    ⚠️ Modeler/MissingType "readme":"providerhub/resource-manager/readme.md",
    "tag":"package-2021-05-01-preview",
    "details":"The schema 'ResourceProviderManifest-metadata' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#/components/schemas/ResourceProviderManifest-metadata"
    ⚠️ Modeler/MissingType "readme":"providerhub/resource-manager/readme.md",
    "tag":"package-2021-05-01-preview",
    "details":"The schema 'OperationsDefinition-properties' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#/components/schemas/OperationsDefinition-properties"
    💬 AutorestCore/Exception "readme":"providerhub/resource-manager/readme.md",
    "tag":"package-2021-05-01-preview",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"
    💬 AutorestCore/Exception "readme":"providerhub/resource-manager/readme.md",
    "tag":"package-2021-05-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:

    Rule Message
    AutorestCore/Exception "readme":"providerhub/resource-manager/readme.md",
    "tag":"package-2021-05-01-preview",
    "details":"Error: Plugin pre-namer reported failure."
    💬 AutorestCore/Exception "readme":"providerhub/resource-manager/readme.md",
    "tag":"package-2021-05-01-preview",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️❌[Staging] Lint(RPaaS): 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    R4031 - Rpaas_ResourceProvisioningState [RPaaS] The resource NotificationRegistration is defined without 'provisioningState' in properties bag, consider adding the provisioningState for it.
    Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L3467
    R4031 - Rpaas_ResourceProvisioningState [RPaaS] The resource SkuResource is defined without 'provisioningState' in properties bag, consider adding the provisioningState for it.
    Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L4532
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 21, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from ab67136. 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] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      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
      warn	No package detected after generation
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from ab67136. 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-05-26 06:21:33 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-providerhub"
      cmderr	[generate.py] 2021-05-26 06:21:33 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-05-26 06:21:33 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.29 --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/providerhub/azure-resourcemanager-providerhub --java.namespace=com.azure.resourcemanager.providerhub   --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/providerhub/resource-manager/readme.md
      cmderr	[generate.py] 2021-05-26 06:22:11 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-05-26 06:22:11 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-05-26 06:22:11 INFO [POM][Skip] pom already has module azure-resourcemanager-providerhub
      cmderr	[generate.py] 2021-05-26 06:22:11 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-05-26 06:22:11 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-05-26 06:22:11 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-providerhub [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-05-26 06:25:00 DEBUG Got artifact_id: azure-resourcemanager-providerhub
      cmderr	[Inst] 2021-05-26 06:25:00 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-05-26 06:25:00 DEBUG Got artifact: azure-resourcemanager-providerhub-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-05-26 06:25:00 DEBUG Got artifact: azure-resourcemanager-providerhub-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-05-26 06:25:00 DEBUG Got artifact: azure-resourcemanager-providerhub-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-05-26 06:25:00 DEBUG Match jar package: azure-resourcemanager-providerhub-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-05-26 06:25:00 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14522/azure-sdk-for-java/azure-resourcemanager-providerhub/azure-resourcemanager-providerhub-1.0.0-beta.1.jar\" -o azure-resourcemanager-providerhub-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-providerhub -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-providerhub-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from ab67136. 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
    • ️✔️providerhub/mgmt/2020-11-20/providerhub [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from ab67136. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/providerhub/resource-manager/readme.md
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️🔄 azure-sdk-for-net inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

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

    @openapi-workflow-bot
    Copy link

    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.

    @sanjaiganesh
    Copy link
    Contributor Author

    @weidongxu-microsoft We just added this api-version to swagger repo couple days back. These properties were never supported. So there is no breaking change here.

    @weidongxu-microsoft
    Copy link
    Member

    weidongxu-microsoft commented May 24, 2021

    @sanjaiganesh

    Please show me the PR that you added it, and confirm no SDK released. Ideally it still need approval from Jeffrey.

    Also please fix the LintDiff and PrettierCheck.

    @sanjaiganesh
    Copy link
    Contributor Author

    @weidongxu-microsoft I confirm that SDK is not released.
    merged 2 weeks back: #14249

    btw the linter is failing for existing stable api version. i am fine to add provisioningState, since it is actually supported. let me know what you suggest.

    [RPaaS] The resource NotificationRegistration is defined without 'provisioningState' in properties bag, consider adding the provisioningState for it.
    Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L3467

    @weidongxu-microsoft
    Copy link
    Member

    @sanjaiganesh

    Then it should be fine.

    provisioningState could be handled in anther PR. Let us make this one simple.

    Let me know when you need it merged.

    @weidongxu-microsoft weidongxu-microsoft added Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates labels May 26, 2021
    @weidongxu-microsoft
    Copy link
    Member

    Suppress breaking changes, as api-version is newly added, and no SDK released.

    @sanjaiganesh
    Copy link
    Contributor Author

    @weidongxu-microsoft Thank you. please merge the PR.

    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * remove property
    
    * prettier check fixes and removing SubscriptionLifecycleNotificationSpecifications
    
    * adding provisioning state
    
    * reverting updates to stable version
    
    * update
    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 Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants