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

[NetAppFiles]Anf 26457 s360 linting remove backup policy details #23438

Merged

Conversation

audunn
Copy link
Member

@audunn audunn commented Apr 5, 2023

ARM API Information (Control Plane)

This is to fix issues in s360
https://portal.azure-devex-tools.com/amekpis/linting/detail?errorId=78AD65DE-AA14-45CD-8979-743413242EBC
https://portal.azure-devex-tools.com/amekpis/linting/detail?errorId=FBB43145-CBCB-4770-A72A-EB592E505946

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
      -[ ] 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, @audunn 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 Apr 5, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    netapp.json 2022-09-01(335899b) 2022-09-01(main)
    ️️✔️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 v2.0.0) new version base version
    package-netapp-2022-09-01 package-netapp-2022-09-01(335899b) package-netapp-2022-09-01(main)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.NetApp/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L59
    ResourceNameRestriction The resource name parameter 'quotaLimitName' should be defined with a 'pattern' restriction.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L255
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L530
    PatchIdentityProperty The patch operation body parameter schema should contains property 'identity'.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L558
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L558
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L558
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property location.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L558
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L587
    PostOperationAsyncResponseValidation An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options'
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L612
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L637
    CreateOperationAsyncResponseValidation An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options'
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L740
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L808
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L808
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property location.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L808
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L840
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L882
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L1043
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L1043
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L1068
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L1068
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property location.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L1068
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L1103
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L1158
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L1220
    PostOperationAsyncResponseValidation An async POST operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L1239
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L1270
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L1390
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L1446
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L1591
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.NetApp/stable/2022-09-01/netapp.json#L1641
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView 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.
    ️️✔️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.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand]
    Validation passes for TypeSpec Validation.
    ️️✔️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 Apr 5, 2023

    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-netapp - 9.0.2b1
    +	Model VolumeBackupProperties no longer has parameter vault_id
    +	Model VolumeRelocationProperties no longer has parameter old_bare_metal_tenant_id
    +	Model VolumeRelocationProperties no longer has parameter old_volume_id
    +	Removed operation group VaultsOperations
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 993e372. 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] npm notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.0 -> 9.6.4
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.4>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.4` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-netapp [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation BackupsOperations.begin_restore_files
      info	[Changelog]   - Added operation VolumesOperations.begin_break_file_locks
      info	[Changelog]   - Model ActiveDirectory has a new parameter preferred_servers_for_ldap_client
      info	[Changelog]   - Model Backup has a new parameter system_data
      info	[Changelog]   - Model Snapshot has a new parameter system_data
      info	[Changelog]   - Model Volume has a new parameter data_store_resource_id
      info	[Changelog]   - Model Volume has a new parameter file_access_logs
      info	[Changelog]   - Model Volume has a new parameter is_large_volume
      info	[Changelog]   - Model Volume has a new parameter provisioned_availability_zone
      info	[Changelog]   - Model VolumeGroupVolumeProperties has a new parameter data_store_resource_id
      info	[Changelog]   - Model VolumeGroupVolumeProperties has a new parameter file_access_logs
      info	[Changelog]   - Model VolumeGroupVolumeProperties has a new parameter is_large_volume
      info	[Changelog]   - Model VolumeGroupVolumeProperties has a new parameter provisioned_availability_zone
      info	[Changelog]   - Model VolumePropertiesDataProtection has a new parameter volume_relocation
      info	[Changelog]   - Model VolumeQuotaRulePatch has a new parameter tags
      info	[Changelog]   - Model VolumeRelocationProperties has a new parameter ready_to_be_finalized
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Model VolumeBackupProperties no longer has parameter vault_id
      info	[Changelog]   - Model VolumeRelocationProperties no longer has parameter old_bare_metal_tenant_id
      info	[Changelog]   - Model VolumeRelocationProperties no longer has parameter old_volume_id
      info	[Changelog]   - Removed operation group VaultsOperations
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 993e372. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    • ️✔️Azure.ResourceManager.NetApp [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 993e372. 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
      cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.
    • ️✔️@azure/arm-netapp [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 993e372. 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/netapp/armnetapp [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 993e372. 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
    • ️✔️netapp [View full logs
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from 993e372. 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.netapp.DefaultTag [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 Apr 5, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/netapp/armnetapp There is no API change compared with the previous version
    Java azure-resourcemanager-netapp There is no API change compared with the previous version
    .Net Azure.ResourceManager.NetApp There is no API change compared with the previous version
    JavaScript @azure/arm-netapp https://apiview.dev/Assemblies/Review/7be93162d1ca4be4843b89a289e50c8f

    @audunn
    Copy link
    Member Author

    audunn commented Apr 5, 2023

    @lirenhe Note this is not changing in this PR most likely python SDK is outdated, updated version has not been relesed yet, and does not include a previous change that was approved.

    Model VolumeBackupProperties no longer has parameter vault_id
    +	Model VolumeRelocationProperties no longer has parameter old_bare_metal_tenant_id
    +	Model VolumeRelocationProperties no longer has parameter old_volume_id
    +	Removed operation group VaultsOperations
    

    @audunn
    Copy link
    Member Author

    audunn commented Apr 12, 2023

    @lirenhe can we progress with this ?

    @audunn
    Copy link
    Member Author

    audunn commented Apr 14, 2023

    @ihsanali01 This has one review approval, can we move this along to clear s360 issue?

    @lirenhe
    Copy link
    Member

    lirenhe commented Apr 14, 2023

    The SDK breaking in python is not related to this PR.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants