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 storage cache api 2023 01 01 #22135

Merged
merged 6 commits into from
Feb 9, 2023

Conversation

rebecca337
Copy link
Member

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. End of January 2023
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. End of January 2023
  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, @rebecca337 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-workflow-bot
    Copy link

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

    @openapi-workflow-bot openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 10, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 10, 2023

    Swagger Validation Report

    ️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    storagecache.json 2022-01-01(eef50a2) 2022-01-01(main)
    storagecache.json 2022-05-01(eef50a2) 2022-05-01(main)
    Rule Message
    1011 - AddingResponseCode The new version adds a response code '202'.
    New: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L554:11
    1011 - AddingResponseCode The new version adds a response code '202'.
    New: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L554:11
    1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
    New: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L518:7
    Old: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L508:7
    1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
    New: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L518:7
    Old: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L508:7
    ️❌Breaking Change(Cross-Version): 4 Errors, 52 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    storagecache.json 2023-01-01(eef50a2) 2022-05-01(main)
    storagecache.json 2023-01-01(eef50a2) 2019-08-01-preview(main)

    The following breaking changes are detected by comparison with the latest stable version:

    Rule Message
    1011 - AddingResponseCode The new version adds a response code '202'.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L555:11
    1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L471:11
    Old: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L461:11
    1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L1089:11
    Old: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L1001:11
    1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L519:7
    Old: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L508:7
    ⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L3353:9
    Old: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3132:9


    The following breaking changes are detected by comparison with the latest preview version:

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

    Rule Message
    ⚠️ 1008 - ModifiedOperationId The operation id has been changed from 'Caches_Create' to 'Caches_CreateOrUpdate'. This will impact generated code.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L451:7
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L364:7
    ⚠️ 1008 - ModifiedOperationId The operation id has been changed from 'StorageTargets_Create' to 'StorageTargets_CreateOrUpdate'. This will impact generated code.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L1066:7
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L854:7
    ⚠️ 1011 - AddingResponseCode The new version adds a response code '202'.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L494:11
    ⚠️ 1011 - AddingResponseCode The new version adds a response code '202'.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L555:11
    ⚠️ 1011 - AddingResponseCode The new version adds a response code '204'.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L754:11
    ⚠️ 1011 - AddingResponseCode The new version adds a response code '204'.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L816:11
    ⚠️ 1011 - AddingResponseCode The new version adds a response code '204'.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L878:11
    ⚠️ 1011 - AddingResponseCode The new version adds a response code '202'.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L1112:11
    ⚠️ 1011 - AddingResponseCode The new version adds a response code '204'.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L1705:11
    ⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L2753:9
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L1509:9
    ⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L2099:13
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L1173:13
    ⚠️ 1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L471:11
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L393:11
    ⚠️ 1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L2798:7
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L1513:11
    ⚠️ 1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L1089:11
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L891:11
    ⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L2121:13
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L1190:13
    ⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L2825:9
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L1534:13
    ⚠️ 1030 - DifferentDiscriminator The new version has a different discriminator than the previous one.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L3130:11
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L1594:11
    ⚠️ 1030 - DifferentDiscriminator The new version has a different discriminator than the previous one.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L1044:13
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L832:13
    ⚠️ 1030 - DifferentDiscriminator The new version has a different discriminator than the previous one.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L1094:13
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L895:13
    ⚠️ 1030 - DifferentDiscriminator The new version has a different discriminator than the previous one.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L1102:13
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L903:13
    ⚠️ 1030 - DifferentDiscriminator The new version has a different discriminator than the previous one.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L1108:13
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L909:13
    ⚠️ 1030 - DifferentDiscriminator The new version has a different discriminator than the previous one.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L2744:5
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L1489:5
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L3130:11
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L1594:11
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L1044:13
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L832:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L1094:13
    Old: Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#L895:13
    ️️✔️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-2022-05 package-2022-05(eef50a2) package-2022-05(main)
    package-2022-01 package-2022-01(eef50a2) package-2022-01(main)
    package-2023-01 package-2023-01(eef50a2) default(main)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    SubscriptionsAndResourceGroupCasing The path segment resourcegroups should be resourceGroups.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L305
    SubscriptionsAndResourceGroupCasing The path segment resourcegroups should be resourceGroups.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L350
    DeleteOperationAsyncResponseValidation An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L351
    LongRunningResponseStatusCode A 'delete' operation 'Caches_Delete' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 204.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L351
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L451
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L493
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L493
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L538
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L538
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property location.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L538
    SubscriptionsAndResourceGroupCasing The path segment resourcegroups should be resourceGroups.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L593
    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.StorageCache/stable/2022-01-01/storagecache.json#L594
    SubscriptionsAndResourceGroupCasing The path segment resourcegroups should be resourceGroups.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L655
    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.StorageCache/stable/2022-01-01/storagecache.json#L656
    SubscriptionsAndResourceGroupCasing The path segment resourcegroups should be resourceGroups.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L717
    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.StorageCache/stable/2022-01-01/storagecache.json#L718
    SubscriptionsAndResourceGroupCasing The path segment resourcegroups should be resourceGroups.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L779
    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.StorageCache/stable/2022-01-01/storagecache.json#L780
    SubscriptionsAndResourceGroupCasing The path segment resourcegroups should be resourceGroups.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L841
    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.StorageCache/stable/2022-01-01/storagecache.json#L842
    SubscriptionsAndResourceGroupCasing The path segment resourcegroups should be resourceGroups.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L903
    SubscriptionsAndResourceGroupCasing The path segment resourcegroups should be resourceGroups.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L951
    TrackedResourcePatchOperation Tracked resource 'StorageTarget' must have patch operation that at least supports the update of tags.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L951
    DeleteOperationAsyncResponseValidation An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L952
    LongRunningResponseStatusCode A 'delete' operation 'StorageTargets_Delete' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 204.
    Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L952
    ️️✔️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]
    ️❌ModelValidation: 28 Errors, 0 Warnings failed [Detail]

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

    Rule Message
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_List.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_List.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_ListByResourceGroup.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_ListByResourceGroup.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_Get.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_Get.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_CreateOrUpdate.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_CreateOrUpdate.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_CreateOrUpdate_ldap_only.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_CreateOrUpdate_ldap_only.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_Update.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_Update.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_Update_ldap_only.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_Update_ldap_only.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_List.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_List.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_ListByResourceGroup.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_ListByResourceGroup.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_Get.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_Get.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_CreateOrUpdate.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_CreateOrUpdate.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_CreateOrUpdate_ldap_only.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_CreateOrUpdate_ldap_only.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: primingManifestUrl
    Url: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3258:19
    ExampleUrl: stable/2022-05-01/examples/Caches_Update.json
    ️️✔️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.
    ️️✔️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 Jan 10, 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-go - sdk/resourcemanager/storagecache/armstoragecache - Approved - 3.0.0
    +	Operation `*CachesClient.Update` has been changed to LRO, use `*CachesClient.BeginUpdate` instead.
    +	Struct `CloudError` has been removed
    azure-sdk-for-python-track2 - track2_azure-mgmt-storagecache - Approved - 1.4.0b1
    +	Renamed operation CachesOperations.update to CachesOperations.begin_update
    azure-sdk-for-js - @azure/arm-storagecache - Approved - 6.0.0
    +	Interface CachesCreateOrUpdateOptionalParams no longer has parameter cache
    +	Interface StorageTargetsCreateOrUpdateOptionalParams no longer has parameter storagetarget
    +	Operation Caches.beginCreateOrUpdate has a new signature
    +	Operation Caches.beginCreateOrUpdateAndWait has a new signature
    +	Operation StorageTargets.beginCreateOrUpdate has a new signature
    +	Operation StorageTargets.beginCreateOrUpdateAndWait has a new signature
    +	Removed operation Caches.update
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from dd8b2cb. 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]
      cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.4.2
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.2>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.4.2` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-storagecache [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation StorageTargetsOperations.begin_restore_defaults
      info	[Changelog]   - Model BlobNfsTarget has a new parameter verification_timer
      info	[Changelog]   - Model BlobNfsTarget has a new parameter write_back_timer
      info	[Changelog]   - Model Nfs3Target has a new parameter verification_timer
      info	[Changelog]   - Model Nfs3Target has a new parameter write_back_timer
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Renamed operation CachesOperations.update to CachesOperations.begin_update
    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • Failed [Logs]Release - Generate from dd8b2cb. 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
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 672 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to build sdk. exit code: False
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    • Azure.ResourceManager.StorageCache [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.ResourceManager.StorageCache/Debug/netstandard2.0/Azure.ResourceManager.StorageCache.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/storagecache/Azure.ResourceManager.StorageCache/src/Azure.ResourceManager.StorageCache.csproj::TargetFramework=netstandard2.0]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from dd8b2cb. 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
      cmderr	[init.sh] [notice] A new release of pip available: 22.3.1 -> 23.0
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip available: 22.3.1 -> 23.0
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    • ️✔️azure-resourcemanager-storagecache [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from dd8b2cb. 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/storagecache/armstoragecache [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Operation `*CachesClient.Update` has been changed to LRO, use `*CachesClient.BeginUpdate` instead.
      info	[Changelog] - Struct `CloudError` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `*StorageTargetsClient.BeginRestoreDefaults(context.Context, string, string, string, *StorageTargetsClientBeginRestoreDefaultsOptions) (*runtime.Poller[StorageTargetsClientRestoreDefaultsResponse], error)`
      info	[Changelog] - New struct `StorageTargetsClientRestoreDefaultsResponse`
      info	[Changelog] - New field `VerificationTimer` in struct `BlobNfsTarget`
      info	[Changelog] - New field `WriteBackTimer` in struct `BlobNfsTarget`
      info	[Changelog] - New field `VerificationTimer` in struct `Nfs3Target`
      info	[Changelog] - New field `WriteBackTimer` in struct `Nfs3Target`
      info	[Changelog]
      info	[Changelog] Total 3 breaking change(s), 5 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from dd8b2cb. 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-storagecache [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation Caches.beginUpdate
      info	[Changelog]   - Added operation Caches.beginUpdateAndWait
      info	[Changelog]   - Added operation StorageTargets.beginRestoreDefaults
      info	[Changelog]   - Added operation StorageTargets.beginRestoreDefaultsAndWait
      info	[Changelog]   - Added Interface CachesDebugInfoHeaders
      info	[Changelog]   - Added Interface CachesDeleteHeaders
      info	[Changelog]   - Added Interface CachesFlushHeaders
      info	[Changelog]   - Added Interface CachesStartHeaders
      info	[Changelog]   - Added Interface CachesStopHeaders
      info	[Changelog]   - Added Interface CachesUpdateHeaders
      info	[Changelog]   - Added Interface CachesUpgradeFirmwareHeaders
      info	[Changelog]   - Added Interface StorageTargetFlushHeaders
      info	[Changelog]   - Added Interface StorageTargetInvalidateHeaders
      info	[Changelog]   - Added Interface StorageTargetResumeHeaders
      info	[Changelog]   - Added Interface StorageTargetsDeleteHeaders
      info	[Changelog]   - Added Interface StorageTargetsDnsRefreshHeaders
      info	[Changelog]   - Added Interface StorageTargetsRestoreDefaultsHeaders
      info	[Changelog]   - Added Interface StorageTargetsRestoreDefaultsOptionalParams
      info	[Changelog]   - Added Interface StorageTargetSuspendHeaders
      info	[Changelog]   - Interface BlobNfsTarget has a new optional parameter verificationTimer
      info	[Changelog]   - Interface BlobNfsTarget has a new optional parameter writeBackTimer
      info	[Changelog]   - Interface CachesUpdateOptionalParams has a new optional parameter resumeFrom
      info	[Changelog]   - Interface CachesUpdateOptionalParams has a new optional parameter updateIntervalInMs
      info	[Changelog]   - Interface Nfs3Target has a new optional parameter verificationTimer
      info	[Changelog]   - Interface Nfs3Target has a new optional parameter writeBackTimer
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Removed operation Caches.update
      info	[Changelog]   - Operation Caches.beginCreateOrUpdate has a new signature
      info	[Changelog]   - Operation Caches.beginCreateOrUpdateAndWait has a new signature
      info	[Changelog]   - Operation StorageTargets.beginCreateOrUpdate has a new signature
      info	[Changelog]   - Operation StorageTargets.beginCreateOrUpdateAndWait has a new signature
      info	[Changelog]   - Interface CachesCreateOrUpdateOptionalParams no longer has parameter cache
      info	[Changelog]   - Interface StorageTargetsCreateOrUpdateOptionalParams no longer has parameter storagetarget
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from dd8b2cb. 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
    • ️✔️storagecache [View full logs]  [Release Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from dd8b2cb. 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.storagecache [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 Jan 10, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/storagecache/armstoragecache https://apiview.dev/Assemblies/Review/8bbf907901e645e992f0aded3855fdc2
    Java azure-resourcemanager-storagecache https://apiview.dev/Assemblies/Review/fc0334d833cb4bfa99c5df1915a983b5
    .Net Azure.ResourceManager.StorageCache https://apiview.dev/Assemblies/Review/78c6ae5cb1b94c2282a6e73b3bd41a0a
    JavaScript @azure/arm-storagecache https://apiview.dev/Assemblies/Review/a077b7b4b5c94b08b76bc89f922f0304

    @openapi-workflow-bot
    Copy link

    Hi @rebecca337, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @openapi-workflow-bot
    Copy link

    Hi, @rebecca337, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline

    @openapi-workflow-bot
    Copy link

    Hi @rebecca337, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @ghost
    Copy link

    ghost commented Feb 5, 2023

    Hi, @rebecca337. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost ghost added the no-recent-activity label Feb 5, 2023
    @rebecca337 rebecca337 removed no-recent-activity DoNotMerge <valid label in PR review process> use to hold merge after approval labels Feb 7, 2023
    @rebecca337
    Copy link
    Member Author

    @tadelesh Could this PR be merged now? We are ready to merge.

    @tadelesh
    Copy link
    Member

    tadelesh commented Feb 8, 2023

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @openapi-pipeline-app openapi-pipeline-app bot added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Feb 8, 2023
    @tadelesh tadelesh added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Feb 8, 2023
    @tadelesh
    Copy link
    Member

    tadelesh commented Feb 8, 2023

    @MaryGao @msyyc Please help to check the SDK breaking changes.

    @rebecca337 rebecca337 removed the DoNotMerge <valid label in PR review process> use to hold merge after approval label Feb 8, 2023
    @rebecca337
    Copy link
    Member Author

    @tadelesh Are we missing anything on my team's end to get this merged? Our rollout is complete so we need to merge this Swagger change as soon as we can.

    @tadelesh tadelesh merged commit dd8b2cb into main Feb 9, 2023
    @tadelesh tadelesh deleted the Microsoft-StorageCache-API-2023-01-01 branch February 9, 2023 03:29
    @openapi-pipeline-app openapi-pipeline-app bot added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Feb 9, 2023
    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023
    * Adds base for updating Microsoft.StorageCache from version stable/2022-05-01 to version 2023-01-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * 2023-01-01 API changes
    
    * Model Validation fixes
    
    * PR Review Comments
    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-ModelValidation Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-JavaScript Approved-SdkBreakingChange-Python ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-Go CI-BreakingChange-JavaScript CI-FixRequiredOnFailure CI-MissingBaseCommit DoNotMerge <valid label in PR review process> use to hold merge after approval new-api-version resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    7 participants