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

[Microsoft.StorageSync] Fix S360 swagger linter errors reported for API version 2022-06-01 #23412

Merged
merged 2 commits into from
Apr 14, 2023

Conversation

anpint
Copy link
Member

@anpint anpint commented Apr 3, 2023

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.
    N/A, fixing examples files
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    N/A, fixing examples files
  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.
    N/A, fixing examples files

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.

@anpint anpint requested a review from ankushbindlish2 as a code owner April 3, 2023 22:19
@openapi-workflow-bot
Copy link

Hi, @anpint 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 Apr 3, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    ️️✔️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 3, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking


    azure-sdk-for-python-track2 - track2_azure-mgmt-storagesync - Approved - 2.0.0b1
    +	Model StorageSyncApiError no longer has parameter inner_error
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 375c29e. 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 [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-storagesync [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation CloudEndpointsOperations.afs_share_metadata_certificate_public_keys
      info	[Changelog]   - Added operation group MicrosoftStorageSyncOperationsMixin
      info	[Changelog]   - Model CloudEndpoint has a new parameter change_enumeration_status
      info	[Changelog]   - Model CloudEndpoint has a new parameter system_data
      info	[Changelog]   - Model CloudEndpointCreateParameters has a new parameter system_data
      info	[Changelog]   - Model OperationResourceMetricSpecification has a new parameter supported_aggregation_types
      info	[Changelog]   - Model PrivateEndpointConnection has a new parameter system_data
      info	[Changelog]   - Model PrivateLinkResource has a new parameter system_data
      info	[Changelog]   - Model ProxyResource has a new parameter system_data
      info	[Changelog]   - Model RegisteredServer has a new parameter system_data
      info	[Changelog]   - Model RegisteredServerCreateParameters has a new parameter system_data
      info	[Changelog]   - Model Resource has a new parameter system_data
      info	[Changelog]   - Model ServerEndpoint has a new parameter initial_upload_policy
      info	[Changelog]   - Model ServerEndpoint has a new parameter system_data
      info	[Changelog]   - Model ServerEndpointBackgroundDataDownloadActivity has a new parameter started_timestamp
      info	[Changelog]   - Model ServerEndpointCloudTieringStatus has a new parameter low_disk_mode
      info	[Changelog]   - Model ServerEndpointCreateParameters has a new parameter initial_upload_policy
      info	[Changelog]   - Model ServerEndpointCreateParameters has a new parameter system_data
      info	[Changelog]   - Model ServerEndpointSyncActivityStatus has a new parameter session_minutes_remaining
      info	[Changelog]   - Model StorageSyncApiError has a new parameter innererror
      info	[Changelog]   - Model StorageSyncService has a new parameter system_data
      info	[Changelog]   - Model SyncGroup has a new parameter system_data
      info	[Changelog]   - Model SyncGroupCreateParameters has a new parameter system_data
      info	[Changelog]   - Model TrackedResource has a new parameter system_data
      info	[Changelog]   - Model Workflow has a new parameter system_data
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Model StorageSyncApiError no longer has parameter inner_error
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 375c29e. 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/storagesync/armstoragesync [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New enum type `CloudTieringLowDiskModeState` with values `CloudTieringLowDiskModeStateDisabled`, `CloudTieringLowDiskModeStateEnabled`
      info	[Changelog] - New function `*CloudEndpointsClient.AfsShareMetadataCertificatePublicKeys(context.Context, string, string, string, string, *CloudEndpointsClientAfsShareMetadataCertificatePublicKeysOptions) (CloudEndpointsClientAfsShareMetadataCertificatePublicKeysResponse, error)`
      info	[Changelog] - New struct `CloudEndpointAfsShareMetadataCertificatePublicKeys`
      info	[Changelog] - New struct `CloudTieringLowDiskMode`
      info	[Changelog] - New field `LowDiskMode` in struct `ServerEndpointCloudTieringStatus`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 9 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 375c29e. 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-storagesync [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation CloudEndpoints.afsShareMetadataCertificatePublicKeys
      info	[Changelog]   - Added Interface CloudEndpointAfsShareMetadataCertificatePublicKeys
      info	[Changelog]   - Added Interface CloudEndpointsAfsShareMetadataCertificatePublicKeysHeaders
      info	[Changelog]   - Added Interface CloudEndpointsAfsShareMetadataCertificatePublicKeysOptionalParams
      info	[Changelog]   - Added Interface CloudTieringLowDiskMode
      info	[Changelog]   - Added Interface SystemData
      info	[Changelog]   - Added Type Alias CloudEndpointsAfsShareMetadataCertificatePublicKeysResponse
      info	[Changelog]   - Added Type Alias CloudTieringLowDiskModeState
      info	[Changelog]   - Added Type Alias CreatedByType
      info	[Changelog]   - Interface OperationResourceMetricSpecification has a new optional parameter supportedAggregationTypes
      info	[Changelog]   - Interface Resource has a new optional parameter systemData
      info	[Changelog]   - Interface ServerEndpointCloudTieringStatus has a new optional parameter lowDiskMode
      info	[Changelog]   - Interface StorageSyncApiError has a new optional parameter innererror
      info	[Changelog]   - Added Enum KnownCloudTieringLowDiskModeState
      info	[Changelog]   - Added Enum KnownCreatedByType
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Interface StorageSyncApiError no longer has parameter innerError
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 375c29e. 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
    • ️✔️storagesync [View full logs
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 375c29e. 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.storagesync.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 3, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/storagesync/armstoragesync https://apiview.dev/Assemblies/Review/7596176be59145e89ab02bfec4414b66
    .Net Azure.ResourceManager.StorageSync There is no API change compared with the previous version
    Java azure-resourcemanager-storagesync https://apiview.dev/Assemblies/Review/1988a642a0514388af3238829be1af13
    JavaScript @azure/arm-storagesync https://apiview.dev/Assemblies/Review/92fc46968b65485382b5041da13c9513

    Copy link
    Member

    @ankushbindlish2 ankushbindlish2 left a comment

    Choose a reason for hiding this comment

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

    Would appreciate if you can share Afs pull request which enables Location header and have an effect to show linter error.

    @anpint
    Copy link
    Member Author

    anpint commented Apr 4, 2023

    Would appreciate if you can share Afs pull request which enables Location header and have an effect to show linter error.

    I don't think there was any change in the AFS service that caused the linter check to fail. Most likely it was added to S360 recently, and we were never really compliant to begin with.

    @MaryGao
    Copy link
    Member

    MaryGao commented Apr 14, 2023

    @msyyc Could you help on Python breaking change?

    JoshLove-msft pushed a commit to JoshLove-msft/azure-rest-api-specs that referenced this pull request Apr 25, 2023
    …PI version 2022-06-01 (Azure#23412)
    
    * Fix Location header in examples for pre/post backup and pre/post restore
    
    * Also fix location header in trigger change detection example
    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.

    5 participants