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

StoragePool GA Swagger Release #15760

Merged
merged 16 commits into from
Sep 3, 2021
Merged

Conversation

harshitha-akkaraju
Copy link
Contributor

@harshitha-akkaraju harshitha-akkaraju commented Aug 24, 2021

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

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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    08/28/2021
  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
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
  • 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, @harshitha-akkaraju 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-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 24, 2021
    @openapi-workflow-bot
    Copy link

    Hi, @harshitha-akkaraju your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 24, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️🔄LintDiff inProgress [Detail]
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️⌛SemanticValidation pending [Detail]
    ️⌛Cross-Version Breaking Changes pending [Detail]
    ️⌛CredScan pending [Detail]
    ️⌛[Staging] SDK Track2 Validation pending [Detail]
    ️⌛[Staging] PrettierCheck pending [Detail]
    ️⌛[Staging] SpellCheck pending [Detail]
    ️⌛[Staging] Lint(RPaaS) pending [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 24, 2021

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - preview/storagepool/mgmt/2021-04-01-preview/storagepool - v57.0.0
    azure-sdk-for-go - preview/storagepool/mgmt/2020-03-15-preview/storagepool - v57.0.0
    +	Package was removed
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-storagepool - 1.0.0b1
    ️✔️azure-sdk-for-go - storagepool/mgmt/2021-08-01/storagepool - v57.0.0
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2b45143. 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-storagepool [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model DiskPoolUpdate has a new parameter managed_by_extended
      info	[Changelog]   - Model DiskPoolUpdate has a new parameter managed_by
      info	[Changelog]   - Model DiskPoolCreate has a new parameter managed_by_extended
      info	[Changelog]   - Model DiskPoolCreate has a new parameter managed_by
      info	[Changelog]   - Model DiskPool has a new parameter managed_by_extended
      info	[Changelog]   - Model DiskPool has a new parameter managed_by
      info	[Changelog]   - Model IscsiTargetUpdate has a new parameter managed_by_extended
      info	[Changelog]   - Model IscsiTargetUpdate has a new parameter managed_by
      info	[Changelog]   - Model IscsiTarget has a new parameter sessions
      info	[Changelog]   - Model IscsiTarget has a new parameter managed_by_extended
      info	[Changelog]   - Model IscsiTarget has a new parameter managed_by
      info	[Changelog]   - Model IscsiTargetCreate has a new parameter managed_by_extended
      info	[Changelog]   - Model IscsiTargetCreate has a new parameter managed_by
      info	[Changelog]   - Added operation DiskPoolsOperations.begin_upgrade
      info	[Changelog]   - Added operation group ResourceSkusOperations
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2b45143. 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-09-03 02:26:50 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-storagepool"
      cmderr	[generate.py] 2021-09-03 02:26:50 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-09-03 02:26:50 INFO autorest --version=3.4.5 --use=@autorest/java@4.0.36 --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/storagepool/azure-resourcemanager-storagepool --java.namespace=com.azure.resourcemanager.storagepool   --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/storagepool/resource-manager/readme.md
      cmderr	[generate.py] 2021-09-03 02:27:23 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-09-03 02:27:23 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-09-03 02:27:23 INFO [POM][Skip] pom already has module azure-resourcemanager-storagepool
      cmderr	[generate.py] 2021-09-03 02:27:23 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-09-03 02:27:23 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-09-03 02:27:23 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-storagepool [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-09-03 02:29:34 DEBUG Got artifact_id: azure-resourcemanager-storagepool
      cmderr	[Inst] 2021-09-03 02:29:34 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-09-03 02:29:34 DEBUG Got artifact: azure-resourcemanager-storagepool-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-09-03 02:29:34 DEBUG Got artifact: azure-resourcemanager-storagepool-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-09-03 02:29:34 DEBUG Got artifact: azure-resourcemanager-storagepool-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-09-03 02:29:34 DEBUG Match jar package: azure-resourcemanager-storagepool-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-09-03 02:29:34 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/15760/azure-sdk-for-java/azure-resourcemanager-storagepool/azure-resourcemanager-storagepool-1.0.0-beta.1.jar\" -o azure-resourcemanager-storagepool-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-storagepool -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-storagepool-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2b45143. SDK Automation 14.0.0
      command	sh ./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
    • ️✔️storagepool/mgmt/2021-08-01/storagepool [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️preview/storagepool/mgmt/2021-04-01-preview/storagepool [View full logs
      info	[Changelog] No exported changes
    • ️✔️preview/storagepool/mgmt/2020-03-15-preview/storagepool [View full logsBreaking Change Detected
      info	[Changelog] This package was removed
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2b45143. 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.7.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/storagepool/resource-manager/readme.md
    • ️✔️@azure/arm-storagepool [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/storagePoolManagement.js → ./dist/arm-storagepool.js...
      cmderr	[npmPack] created ./dist/arm-storagepool.js in 343ms
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @harshitha-akkaraju, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @jorgecotillo jorgecotillo 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 Aug 25, 2021
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 25, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌LintDiff: 4 Errors, 0 Warnings failed [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    R3006 - BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'DiskPool' has extra properties ['managedByExtended'].
    Location: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L1410
    R3006 - BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'IscsiTarget' has extra properties ['managedByExtended'].
    Location: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L1694
    R3006 - BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'IscsiTargetCreate' has extra properties ['managedByExtended'].
    Location: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L1727
    R3006 - BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'IscsiTargetUpdate' has extra properties ['managedByExtended'].
    Location: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L1754


    The following errors/warnings exist before current PR submission:

    Rule Message
    R4037 - MissingTypeObject The schema 'DiskPoolZoneListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L1358
    R4037 - MissingTypeObject The schema 'TrackedResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L2083
    R4037 - MissingTypeObject The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L2116
    R4037 - MissingTypeObject The schema 'ErrorAdditionalInfo' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L2145
    R4037 - MissingTypeObject The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L2160
    ⚠️ 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.StoragePool/stable/2021-08-01/storagepool.json#L1021
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isAccessible
    Location: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L1133
    ️️✔️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: 4 Errors, 0 Warnings failed [Detail]
    The following breaking changes are detected by comparison with latest preview version:
    Rule Message
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L1380:9
    Old: Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json#L1093:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L1388:9
    Old: Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json#L1100:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L1360:9
    Old: Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json#L1075:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L1368:9
    Old: Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json#L1082:9
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"storagepool/resource-manager/readme.md",
    "tag":"package-2021-08-01",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"storagepool/resource-manager/readme.md",
    "tag":"package-2021-08-01",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"storagepool/resource-manager/readme.md",
    "tag":"package-2021-08-01",
    "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) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    These settings apply only when `--tag=package-2021-08-01 --go` is specified on the command line.
    Please also specify `--go-sdks-folder=<path to the root directory of your azure-sdk-for-go clone>`.

    ```yaml $(tag) == 'package-2021-04-01-preview' && $(go)
    Copy link
    Member

    Choose a reason for hiding this comment

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

    Hi @harshitha-akkaraju , should the tag be package-2021-08-01 here?

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    @changlong-liu just pushed a revision. thanks for catching it!

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    @changlong-liu the go sdk generation still seems to be failing -- do you have any pointers on how to fix it?

    @ruowan
    Copy link
    Member

    ruowan commented Aug 27, 2021

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @changlong-liu
    Copy link
    Member

    Hi @ArcturusZhang , would you help have a look at whether the go sdk failure comes from this PR? Thanks.

    Co-authored-by: Arcturus <dapzhang@microsoft.com>
    @ArcturusZhang
    Copy link
    Member

    Note that my approval is only for the changes in readme.go.md file

    @msyyc
    Copy link
    Member

    msyyc commented Sep 2, 2021

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-LintDiff ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-FixRequiredOnFailure
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    8 participants