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

add missing property to fix swagger issue in databox-v2022-02-01 #20779

Merged
merged 1 commit into from
Sep 29, 2022

Conversation

ashoknailwal
Copy link
Contributor

ARM API Information (Control Plane)

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[x] 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. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @ashoknailwal 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 20, 2022

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.9.7)] new version base version
    databox.json 2022-02-01(768472b) 2022-02-01(main)
    Rule Message
    1045 - AddedOptionalProperty The new version has a new optional property 'granularCopyLogDetails' that was not found in the old version.
    New: Microsoft.DataBox/stable/2022-02-01/databox.json#L2789:7
    Old: Microsoft.DataBox/stable/2022-02-01/databox.json#L2789:7
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-02 package-2022-02(768472b) package-2022-02(main)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    R4039 - ParametersOrder The parameters:jobName,resourceGroupName should be kept in the same order as they present in the path.
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L113
    R4039 - ParametersOrder The parameters:jobName,resourceGroupName should be kept in the same order as they present in the path.
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L167
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L1072
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L1148
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L1287
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L1371
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L1383
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L1434
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L2123
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L2157
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L2798
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L2849
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L2919
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L2943
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L2968
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L2981
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L3004
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L3028
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L3067
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L3080
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L3197
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L3204
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L3420
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L3565
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L3591
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L3598
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L3641
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L4850
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L5670
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.DataBox/stable/2022-02-01/databox.json#L5683
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
    Validation passes for ServiceAPIReadinessTest.
    ️️✔️~[Staging] TrafficValidation succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/768472b52ec477ce9434fe5ff0f6b9e7bd9ce1c5/specification/databox/resource-manager/readme.md#tag-package-2022-02">databox/resource-manager/readme.md#package-2022-02
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ UnkownSecurityScheme "readme":"databox/resource-manager/readme.md",
    "tag":"package-2022-02",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️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).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 20, 2022

    Swagger Generation Artifacts

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

    Breaking Changes Tracking


    azure-sdk-for-python-track2 - track2_azure-mgmt-databox - Approved - 1.0.0
    +	Model DataBoxDiskJobDetails no longer has parameter expected_data_size_in_terabytes
    +	Model DataBoxHeavyJobDetails no longer has parameter expected_data_size_in_terabytes
    +	Model DataBoxJobDetails no longer has parameter expected_data_size_in_terabytes
    +	Model DiskScheduleAvailabilityRequest has a new required parameter expected_data_size_in_tera_bytes
    +	Model DiskScheduleAvailabilityRequest no longer has parameter expected_data_size_in_terabytes
    +	Model JobDetails no longer has parameter expected_data_size_in_terabytes
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 065b070. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.0
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/databox/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
      cmderr	[Autorest] No usable version of the libssl was found
      cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
      cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
      warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 065b070. 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-databox [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation JobsOperations.mark_devices_shipped
      info	[Changelog]   - Added operation group DataBoxManagementClientOperationsMixin
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter actions
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter data_center_code
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter datacenter_address
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter device_erasure_details
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter expected_data_size_in_tera_bytes
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter granular_copy_log_details
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter granular_copy_progress
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter last_mitigation_action_on_job
      info	[Changelog]   - Model DataBoxHeavyJobDetails has a new parameter actions
      info	[Changelog]   - Model DataBoxHeavyJobDetails has a new parameter data_center_code
      info	[Changelog]   - Model DataBoxHeavyJobDetails has a new parameter datacenter_address
      info	[Changelog]   - Model DataBoxHeavyJobDetails has a new parameter device_erasure_details
      info	[Changelog]   - Model DataBoxHeavyJobDetails has a new parameter expected_data_size_in_tera_bytes
      info	[Changelog]   - Model DataBoxHeavyJobDetails has a new parameter last_mitigation_action_on_job
      info	[Changelog]   - Model DataBoxJobDetails has a new parameter actions
      info	[Changelog]   - Model DataBoxJobDetails has a new parameter data_center_code
      info	[Changelog]   - Model DataBoxJobDetails has a new parameter datacenter_address
      info	[Changelog]   - Model DataBoxJobDetails has a new parameter device_erasure_details
      info	[Changelog]   - Model DataBoxJobDetails has a new parameter expected_data_size_in_tera_bytes
      info	[Changelog]   - Model DataBoxJobDetails has a new parameter last_mitigation_action_on_job
      info	[Changelog]   - Model DataImportDetails has a new parameter log_collection_level
      info	[Changelog]   - Model JobDetails has a new parameter actions
      info	[Changelog]   - Model JobDetails has a new parameter data_center_code
      info	[Changelog]   - Model JobDetails has a new parameter datacenter_address
      info	[Changelog]   - Model JobDetails has a new parameter device_erasure_details
      info	[Changelog]   - Model JobDetails has a new parameter expected_data_size_in_tera_bytes
      info	[Changelog]   - Model JobDetails has a new parameter last_mitigation_action_on_job
      info	[Changelog]   - Model JobResource has a new parameter system_data
      info	[Changelog]   - Model Preferences has a new parameter storage_account_access_tier_preferences
      info	[Changelog]   - Model RegionConfigurationRequest has a new parameter datacenter_address_request
      info	[Changelog]   - Model RegionConfigurationResponse has a new parameter datacenter_address_response
      info	[Changelog]   - Model UpdateJobDetails has a new parameter return_to_customer_package_details
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Model DataBoxDiskJobDetails no longer has parameter expected_data_size_in_terabytes
      info	[Changelog]   - Model DataBoxHeavyJobDetails no longer has parameter expected_data_size_in_terabytes
      info	[Changelog]   - Model DataBoxJobDetails no longer has parameter expected_data_size_in_terabytes
      info	[Changelog]   - Model DiskScheduleAvailabilityRequest has a new required parameter expected_data_size_in_tera_bytes
      info	[Changelog]   - Model DiskScheduleAvailabilityRequest no longer has parameter expected_data_size_in_terabytes
      info	[Changelog]   - Model JobDetails no longer has parameter expected_data_size_in_terabytes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 065b070. 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
      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
    • ️✔️@azure/arm-databox [View full logs]  [Release SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 065b070. 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
    • ️✔️sdk/resourcemanager/databox/armdatabox [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New field `GranularCopyLogDetails` in struct `DiskJobDetails`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 1 additive change(s).
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 065b070. 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
      warn	No file changes detected after generation
    • ️✔️databox [View full logs
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 065b070. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.DataBox [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 20, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/databox/armdatabox Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Python track2_azure-mgmt-databox Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    JavaScript @azure/arm-databox Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Java azure-resourcemanager-databox Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

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

    @live1206
    Copy link
    Member

    @msyyc Could you help check the breaking change for Python? Thanks!

    @msyyc
    Copy link
    Member

    msyyc commented Sep 28, 2022

    the breaking of python is not caused by this PR. Approved.

    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-SdkBreakingChange-Python FixS360 ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants