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

[Hub Generated] Review request for Microsoft.AzureStackHCI to add version stable/2022-01-01 #17377

Conversation

sanray-ms
Copy link
Member

@sanray-ms sanray-ms commented Jan 17, 2022

It has only one change from the last public API version. We made a readonly properly to writable.

Changelog

Add a changelog entry for 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 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.
    January 2022
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    January 2022
  4. If updating an existing version, please select the specific langauge 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:

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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[x] 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
Copy link

Hi, @sanray-ms 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
    Copy link

    openapi-pipeline-app bot commented Jan 17, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.AzureStackHCI/stable/2022-01-01/operations.json#L38
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoUpgradeMinorVersion
    Location: Microsoft.AzureStackHCI/stable/2022-01-01/extensions.json#L458
    ⚠️ 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: common-types/resource-management/v2/types.json#L359
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️❌~[Staging] ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    API Readiness check failed. Please make sure your service is deployed. "code: InvalidResourceType,
    message: The resource type 'operations' could not be found in the namespace 'Microsoft.AzureStackHCI' for api version '2022-01-01'. The supported api-versions are '2020-03-01-preview,
    2020-10-01,
    2020-11-01-preview,
    2021-01-01-preview,
    2021-07-01-preview,
    2021-09-01-preview,
    2021-09-01'."
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️❌Cross-Version Breaking Changes: 1 Errors, 1 Warnings failed [Detail]
    The following breaking changes are detected by comparison with the latest stable version:
    Rule Message
    1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
    New: Microsoft.AzureStackHCI/stable/2022-01-01/arcSettings.json#L280:9
    Old: Microsoft.AzureStackHCI/stable/2021-09-01/arcSettings.json#L280:9


    The following breaking changes are detected by comparison with latest preview version:

    Rule Message
    ⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
    New: Microsoft.AzureStackHCI/stable/2022-01-01/arcSettings.json#L280:9
    Old: Microsoft.AzureStackHCI/preview/2021-01-01-preview/arcSettings.json#L280:9
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @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 Jan 17, 2022

    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-track2 - armazurestackhci - 0.2.1
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-azurestackhci - 6.1.0b1
    ️✔️azure-sdk-for-go - azurestackhci/mgmt/2020-10-01/azurestackhci - v61.2.0
    ️✔️azure-sdk-for-go - preview/azurestackhci/mgmt/2021-01-01-preview/azurestackhci - v61.2.0
    ️✔️azure-sdk-for-go - preview/azurestackhci/mgmt/2020-03-01-preview/azurestackhci - v61.2.0
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from ea1aed2. 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]
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.1.2 -> 8.3.2
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.3.2>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-azurestackhci [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model Cluster has a new parameter desired_properties
      info	[Changelog]   - Model ClusterNode has a new parameter windows_server_subscription
      info	[Changelog]   - Model ClusterPatch has a new parameter aad_client_id
      info	[Changelog]   - Model ClusterPatch has a new parameter aad_tenant_id
      info	[Changelog]   - Model ClusterPatch has a new parameter desired_properties
      info	[Changelog]   - Model ClusterReportedProperties has a new parameter diagnostic_level
      info	[Changelog]   - Model ClusterReportedProperties has a new parameter imds_attestation
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from ea1aed2. 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] 2022-01-25 02:37:12 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-azurestackhci;1.0.0-beta.1;1.0.0-beta.2"
      cmderr	[generate.py] 2022-01-25 02:37:12 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
      cmderr	[generate.py] 2022-01-25 02:37:12 INFO autorest --version=3.6.6 --use=@autorest/[email protected] --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/azurestackhci/azure-resourcemanager-azurestackhci --java.namespace=com.azure.resourcemanager.azurestackhci   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --generate-samples --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL  ../azure-rest-api-specs/specification/azurestackhci/resource-manager/readme.md
      cmderr	[generate.py] 2022-01-25 02:37:38 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-azurestackhci
      cmderr	[generate.py] 2022-01-25 02:37:38 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2022-01-25 02:37:38 INFO [POM][Skip] pom already has module azure-resourcemanager-azurestackhci
      cmderr	[generate.py] 2022-01-25 02:37:38 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2022-01-25 02:37:38 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2022-01-25 02:37:38 INFO [POM][Skip] pom already has module sdk/azurestackhci
      cmderr	[generate.py] 2022-01-25 02:37:38 INFO [POM][Success] Write to root pom
      cmderr	[generate.py] 2022-01-25 02:39:24 ERROR [COMPILE] Maven build fail
    • ️✔️azure-resourcemanager-azurestackhci [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2022-01-25 02:39:26 DEBUG Got artifact_id: azure-resourcemanager-azurestackhci
      cmderr	[Inst] 2022-01-25 02:39:26 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2022-01-25 02:39:26 DEBUG Got artifact: azure-resourcemanager-azurestackhci-1.0.0-beta.2.jar
      cmderr	[Inst] 2022-01-25 02:39:26 DEBUG Match jar package: azure-resourcemanager-azurestackhci-1.0.0-beta.2.jar
      cmderr	[Inst] 2022-01-25 02:39:26 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/17377/azure-sdk-for-java/azure-resourcemanager-azurestackhci/azure-resourcemanager-azurestackhci-1.0.0-beta.2.jar\" -o azure-resourcemanager-azurestackhci-1.0.0-beta.2.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-azurestackhci -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-azurestackhci-1.0.0-beta.2.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from ea1aed2. SDK Automation 14.0.0
      command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️azurestackhci/mgmt/2020-10-01/azurestackhci [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `User`
      info	[Changelog] - New const `Key`
      info	[Changelog] - New const `Application`
      info	[Changelog] - New const `ManagedIdentity`
      info	[Changelog] - New function `PossibleCreatedByTypeValues() []CreatedByType`
      info	[Changelog] - New struct `SystemData`
      info	[Changelog] - New anonymous field `*SystemData` in struct `Cluster`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 8 additive change(s).
    • ️✔️preview/azurestackhci/mgmt/2021-01-01-preview/azurestackhci [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️preview/azurestackhci/mgmt/2020-03-01-preview/azurestackhci [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from ea1aed2. 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
    • ️✔️armazurestackhci [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `ExtensionParameters.ProtectedSettings` has been changed from `map[string]interface{}` to `interface{}`
      info	[Changelog] - Type of `ExtensionParameters.Settings` has been changed from `map[string]interface{}` to `interface{}`
      info	[Changelog] - Function `ErrorDetail.MarshalJSON` has been removed
      info	[Changelog] - Struct `ErrorAdditionalInfo` has been removed
      info	[Changelog] - Struct `ErrorDetail` has been removed
      info	[Changelog] - Struct `ErrorResponse` has been removed
      info	[Changelog]
      info	[Changelog] Total 8 breaking change(s), 0 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from ea1aed2. 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
      cmderr	[automation_init.sh] deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh] npm WARN deprecated [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh]  deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] notice created a lockfile as package-lock.json. You should commit this file.
      cmderr	[automation_init.sh] npm WARN @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      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
    • ️✔️track2_@azure/arm-azurestackhci [View full logs]  [Release SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from ea1aed2. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      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
    • ️✔️azurestackhci [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @sanray-ms, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @sanray-ms sanray-ms marked this pull request as ready for review January 17, 2022 11:00
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 18, 2022
    @openapi-workflow-bot
    Copy link

    Hi, @sanray-ms your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    Copy link
    Contributor

    @j5lim j5lim left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Approved from ARM side.

    @j5lim j5lim added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 19, 2022
    @openapi-workflow-bot
    Copy link

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

    @sanray-ms
    Copy link
    Member Author

    @raych1 , Work item link for breaking change using the template -> https://msazure.visualstudio.com/One/_workitems/edit/13061339

    This is assigned to our service PM

    Justification in short -> Making one read-only field to writable.
    This field is a Resource Group (RG) name which is created by the service. It was a GUID. Customer wants to pass the RG name as parameter. So it has been made to writable.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 24, 2022
    @raych1
    Copy link
    Member

    raych1 commented Jan 25, 2022

    Talked with @sanray-ms offline, this PR has to be merged to generate manifest. So, ignore api readiness check.

    @raych1 raych1 merged commit ea1aed2 into Azure:main Jan 25, 2022
    ghost pushed a commit to Azure/azure-resource-manager-schemas that referenced this pull request Jan 25, 2022
    mstrisoline pushed a commit to mstrisoline/azure-rest-api-specs that referenced this pull request Feb 1, 2022
    …sion stable/2022-01-01 (Azure#17377)
    
    * Adds base for updating Microsoft.AzureStackHCI from version stable/2021-09-01 to version 2022-01-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * remove readonly attribute
    
    * added example file
    
    * Format the files
    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    …sion stable/2022-01-01 (Azure#17377)
    
    * Adds base for updating Microsoft.AzureStackHCI from version stable/2021-09-01 to version 2022-01-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * remove readonly attribute
    
    * added example file
    
    * Format the files
    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 ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go-V2
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants