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.

Sign up for GitHub

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

Jump to bottom

Add optional fields in Disk Pool Update #16023

Merged
merged 1 commit into from
Sep 14, 2021
Merged

Add optional fields in Disk Pool Update #16023

merged 1 commit into from
Sep 14, 2021

Conversation

harshitha-akkaraju
Copy link
Contributor

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: Adding an optional field during resource update.

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

  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.

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

    openapi-pipeline-app bot commented Sep 13, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'sku' that was not found in the old version.
    New: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L1514:7
    Old: Microsoft.StoragePool/stable/2021-08-01/storagepool.json#L1514:7
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    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#L1699
    ❌ 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#L1732
    ❌ 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#L1759
    ❌ 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#L2088
    ❌ 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#L2121
    ❌ 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#L2150
    ❌ 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#L2165
    ⚠️ 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 succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation

    ️️✔️[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?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 13, 2021 •
    edited
    Loading

    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-python-track2 - track2_azure-mgmt-storagepool - 1.0.0b1
    ️✔️azure-sdk-for-go - storagepool/mgmt/2021-08-01/storagepool - v57.2.0
    ️✔️azure-sdk-for-go - preview/storagepool/mgmt/2021-04-01-preview/storagepool - v57.2.0
    ❌azure-sdk-for-go - preview/storagepool/mgmt/2020-03-15-preview/storagepool - v57.2.0
    +	Package was removed
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 68acb89. 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 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
info	[Changelog]   - Model IscsiTarget has a new parameter managed_by_extended
info	[Changelog]   - Model DiskPool has a new parameter managed_by_extended
info	[Changelog]   - Model DiskPool has a new parameter managed_by
info	[Changelog]   - Model DiskPoolUpdate has a new parameter managed_by_extended
info	[Changelog]   - Model DiskPoolUpdate has a new parameter managed_by
info	[Changelog]   - Model DiskPoolUpdate has a new parameter sku
info	[Changelog]   - Model IscsiTargetCreate has a new parameter managed_by_extended
info	[Changelog]   - Model IscsiTargetCreate 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]   - Added operation DiskPoolsOperations.begin_upgrade
info	[Changelog]   - Added operation group ResourceSkusOperations
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 68acb89. 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-14 04:29:08 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-storagepool"
cmderr	[generate.py] 2021-09-14 04:29:08 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-09-14 04:29:08 INFO autorest --version=3.6.0 --use=@autorest/java@4.0.37 --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-14 04:29:37 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-09-14 04:29:37 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-09-14 04:29:37 INFO [POM][Skip] pom already has module azure-resourcemanager-storagepool
cmderr	[generate.py] 2021-09-14 04:29:37 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-09-14 04:29:37 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-09-14 04:29:37 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-storagepool [View full logs]  [Release SDK Changes] 
      cmderr	[Inst] 2021-09-14 04:31:21 DEBUG Got artifact_id: azure-resourcemanager-storagepool
cmderr	[Inst] 2021-09-14 04:31:21 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-09-14 04:31:21 DEBUG Got artifact: azure-resourcemanager-storagepool-1.0.0-beta.1-sources.jar
cmderr	[Inst] 2021-09-14 04:31:21 DEBUG Got artifact: azure-resourcemanager-storagepool-1.0.0-beta.1-javadoc.jar
cmderr	[Inst] 2021-09-14 04:31:21 DEBUG Got artifact: azure-resourcemanager-storagepool-1.0.0-beta.1.jar
cmderr	[Inst] 2021-09-14 04:31:21 DEBUG Match jar package: azure-resourcemanager-storagepool-1.0.0-beta.1.jar
cmderr	[Inst] 2021-09-14 04:31:21 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/16023/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 68acb89. 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 logs]  Breaking Change Detected
      info	[Changelog] This package was removed
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 68acb89. 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 365ms
    Posted by Swagger Pipeline | How to fix these errors?

    @harshitha-akkaraju harshitha-akkaraju changed the title Updates Add optional fields in Disk Pool Update Sep 13, 2021
    @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.

    This was referenced Sep 13, 2021
    Closed
    Closed
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Sep 13, 2021
    Closed
    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Sep 13, 2021
    @changlong-liu changlong-liu merged commit 68acb89 into main Sep 14, 2021
    This was referenced Sep 14, 2021
    Closed
    Closed
    Closed
    Closed
    Closed
    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    @harshitha-akkaraju @LeiWang3
    Updates (Azure#16023)
    95b12fc
    @JackTn JackTn deleted the dev/hakkaraj/ga-2021-08-01 branch June 16, 2022 00:48
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @changlong-liu changlong-liu changlong-liu approved these changes

    Assignees

    @changlong-liu changlong-liu

    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Go
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @harshitha-akkaraju @changlong-liu @JeffreyRichter