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

ASE New API version 2023-01-01-preview Changes #22054

Conversation

sameerpatro
Copy link
Contributor

@sameerpatro sameerpatro commented Jan 4, 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.
  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, @sameerpatro 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 Jan 4, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌Breaking Change(Cross-Version): 3 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.2)] new version base version
    databoxedge.json 2023-01-01-preview(b3e0ef6) 2022-03-01(main)
    databoxedge.json 2023-01-01-preview(b3e0ef6) 2022-12-01-preview(main)

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

    Rule Message
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'IoTAddon' removed or renamed?
    New: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L4621:3
    Old: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L4159:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'IoTAddonProperties' removed or renamed?
    New: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L4621:3
    Old: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L4159:3
    1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
    New: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L292:7
    Old: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L292:7
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 50 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2023-01-01-preview package-2023-01-01-preview(b3e0ef6) default(main)

    [must fix]The following errors/warnings are introduced by current PR:

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

    Rule Message Related RPC [For API reviewers]
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MarketplaceImageOfferModel'. Consider using the plural form of 'MarketplaceImageOffer' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1371
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1382
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: OrderGet
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1556
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MarketplaceImagePublisherModel'. Consider using the plural form of 'MarketplaceImagePublisher' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1720
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1731
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: OrderGet
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1757
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MarketplaceImageOfferModel'. Consider using the plural form of 'MarketplaceImageOffer' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1770
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1781
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1789
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: OrderGet
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1815
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MarketplaceImageSkuModel'. Consider using the plural form of 'MarketplaceImageSku' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1828
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1839
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1847
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1855
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: OrderGet
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1881
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MarketplaceImageVersionModel'. Consider using the plural form of 'MarketplaceImageVersion' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1894
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1905
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1913
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1921
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1929
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: OrderGet
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1955
    ⚠️ RequiredReadOnlySystemData The response of operation:'MarketplaceImageVersion_GetParticularImage' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1963
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MarketplaceImageVersionModel'. Consider using the plural form of 'MarketplaceImageVersion' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1968
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1976
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1983
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1990
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L1997
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L2004
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: OrderGet
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L2029
    ⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'generatesastoken' in:'MarketplaceImageSasToken_GetSASToken'. Consider updating the operationId
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L2042


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ResourceNameRestriction The resource name parameter 'deviceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L188
    ParametersOrder The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L189
    ParametersOrder The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L236
    ParametersOrder The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L292
    ParametersOrder The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L336
    PatchSkuProperty The patch operation body parameter schema should contains property 'sku'.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L350
    ResourceNameRestriction The resource name parameter 'deviceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L390
    ParametersOrder The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L391
    ResourceNameRestriction The resource name parameter 'deviceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L439
    ParametersOrder The parameters:deviceName,name,resourceGroupName should be kept in the same order as they present in the path.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L440
    ResourceNameRestriction The resource name parameter 'deviceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L492
    ParametersOrder The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L493
    ResourceNameRestriction The resource name parameter 'deviceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L541
    ParametersOrder The parameters:deviceName,name,resourceGroupName should be kept in the same order as they present in the path.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L542
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L593
    ParametersOrder The parameters:deviceName,name,resourceGroupName should be kept in the same order as they present in the path.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L593
    CreateOperationAsyncResponseValidation An async PUT operation must return 201.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L633
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L640
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L640
    DeleteOperationAsyncResponseValidation An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L657
    ParametersOrder The parameters:deviceName,name,resourceGroupName should be kept in the same order as they present in the path.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L657
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L692
    ResourceNameRestriction The resource name parameter 'deviceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L713
    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.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L714
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L755
    ResourceNameRestriction The resource name parameter 'deviceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L779
    OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'DeviceCapacityInfo' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L785
    ResourceNameRestriction The resource name parameter 'deviceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L825
    ParametersOrder The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path.
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L826
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json#L870
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    API Readiness check failed. Please make sure your service is deployed. "code: InvalidResourceType,
    message: The resource type 'operations' could not be found in the namespace 'Microsoft.DataBoxEdge' for api version '2023-01-01-preview'. The supported api-versions are '2017-09-01,
    2018-07-01,
    2019-03-01,
    2019-07-01,
    2019-08-01,
    2020-01-01,
    2020-05-01-preview,
    2020-06-01,
    2020-07-01,
    2020-07-01-preview,
    2020-09-01,
    2020-09-01-preview,
    2020-12-01,
    2021-02-01-preview,
    2021-02-01,
    2021-06-01,
    2021-06-01-preview,
    2022-03-01,
    2022-04-01-preview'."
    ️❌~[Staging] ServiceAPIReadinessTest: 83 Errors, 0 Warnings failed [Detail]

    Tag package-2023-01-01-preview; Prod region: Not deployed; Canary region: Deployed

    Test run on region: eastus2euap; Operation coverage: total: 84, untested: 0, failed: 83, passed: 1

    Service API Readiness Test failed. Check pipeline artifact for detail report.

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

    Rule Message
    CLIENT_ERROR "statusCode: 400,
    errorCode: NoRegisteredProviderFound,
    errorMessage: No registered resource provider found for location 'eastus2euap' and API version '2023-01-01-preview' for type 'DataBoxEdgeDevices'. The supported api-versions are '2017-09-01,
    2018-07-01,
    2019-03-01,
    2019-07-01,
    2019-08-01,
    2020-01-01,
    2020-05-01-preview,
    2020-06-01,
    2020-07-01,
    2020-07-01-preview,
    2020-09-01,
    2020-09-01-preview,
    2020-12-01,
    2021-02-01-preview,
    2021-02-01,
    2021-06-01,
    2021-06-01-preview,
    2022-03-01,
    2022-04-01-preview'. The supported locations are 'eastus,
    westeurope,
    southeastasia,
    eastus2euap,
    centraluseuap'."
    CLIENT_ERROR "statusCode: 404,
    errorCode: InvalidResourceType,
    errorMessage: The resource type 'DataBoxEdgeDevices' could not be found in the namespace 'Microsoft.DataBoxEdge' for api version '2023-01-01-preview'. The supported api-versions are '2017-09-01,
    2018-07-01,
    2019-03-01,
    2019-07-01,
    2019-08-01,
    2020-01-01,
    2020-05-01-preview,
    2020-06-01,
    2020-07-01,
    2020-07-01-preview,
    2020-09-01,
    2020-09-01-preview,
    2020-12-01,
    2021-02-01-preview,
    2021-02-01,
    2021-06-01,
    2021-06-01-preview,
    2022-03-01,
    2022-04-01-preview'."
    CLIENT_ERROR "statusCode: 404,
    errorCode: InvalidResourceType,
    errorMessage: The resource type 'DataBoxEdgeDevices' could not be found in the namespace 'Microsoft.DataBoxEdge' for api version '2023-01-01-preview'. The supported api-versions are '2017-09-01,
    2018-07-01,
    2019-03-01,
    2019-07-01,
    2019-08-01,
    2020-01-01,
    2020-05-01-preview,
    2020-06-01,
    2020-07-01,
    2020-07-01-preview,
    2020-09-01,
    2020-09-01-preview,
    2020-12-01,
    2021-02-01-preview,
    2021-02-01,
    2021-06-01,
    2021-06-01-preview,
    2022-03-01,
    2022-04-01-preview'."
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    CLIENT_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.DataBoxEdge/DataBoxEdgeDevices/devicenadh6j7c' under resource group 'apiTest-QMrSKS-22054' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix"
    ️️✔️~[Staging] SwaggerAPIView 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.
    ️️✔️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 4, 2023

    Swagger Generation Artifacts

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

    Breaking Changes Tracking


    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 871bc7693aae45dd1bcd3423d91c96b33f4b7807. 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.DataBoxEdge [View full logs]  [Preview SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 871bc7693aae45dd1bcd3423d91c96b33f4b7807. 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.2 -> 9.2.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.2.0>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.2.0` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-databoxedge [View full logs]  [Preview SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group DiagnosticSettingsOperations
      info	[Changelog]   - Added operation group SupportPackagesOperations
      info	[Changelog]   - Model DataBoxEdgeSku has a new parameter capabilities
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 871bc7693aae45dd1bcd3423d91c96b33f4b7807. 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-databoxedge [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation group DeviceCapacityCheck
      info	[Changelog]   - Added operation group DeviceCapacityInfoOperations
      info	[Changelog]   - Added Interface ClusterCapacityViewData
      info	[Changelog]   - Added Interface ClusterGpuCapacity
      info	[Changelog]   - Added Interface ClusterMemoryCapacity
      info	[Changelog]   - Added Interface ClusterStorageViewData
      info	[Changelog]   - Added Interface DeviceCapacityCheckCheckResourceCreationFeasibilityOptionalParams
      info	[Changelog]   - Added Interface DeviceCapacityInfo
      info	[Changelog]   - Added Interface DeviceCapacityInfoGetDeviceCapacityInfoOptionalParams
      info	[Changelog]   - Added Interface DeviceCapacityRequestInfo
      info	[Changelog]   - Added Interface HostCapacity
      info	[Changelog]   - Added Interface NumaNodeData
      info	[Changelog]   - Added Interface VmMemory
      info	[Changelog]   - Added Interface VmPlacementRequestResult
      info	[Changelog]   - Added Type Alias ClusterWitnessType
      info	[Changelog]   - Added Type Alias DeviceCapacityInfoGetDeviceCapacityInfoResponse
      info	[Changelog]   - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter cloudWitnessContainerName
      info	[Changelog]   - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter cloudWitnessStorageAccountName
      info	[Changelog]   - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter cloudWitnessStorageEndpoint
      info	[Changelog]   - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter clusterWitnessType
      info	[Changelog]   - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter fileShareWitnessLocation
      info	[Changelog]   - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter fileShareWitnessUsername
      info	[Changelog]   - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter systemData
      info	[Changelog]   - Interface Order has a new optional parameter kind
      info	[Changelog]   - Interface Order has a new optional parameter orderId
      info	[Changelog]   - Added Enum KnownClusterWitnessType
      info	[Changelog]   - Enum KnownSkuName has a new value EdgeMRTCP
      info	[Changelog]   - Enum KnownSkuName has a new value EP2128GPU1Mx1W
      info	[Changelog]   - Enum KnownSkuName has a new value EP2256GPU2Mx1
      info	[Changelog]   - Enum KnownSkuName has a new value EP264Mx1W
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Interface DevicesListByResourceGroupNextOptionalParams no longer has parameter expand
      info	[Changelog]   - Interface DevicesListBySubscriptionNextOptionalParams no longer has parameter expand
      info	[Changelog]   - Interface TriggersListByDataBoxEdgeDeviceNextOptionalParams no longer has parameter filter
      info	[Changelog]   - Interface UsersListByDataBoxEdgeDeviceNextOptionalParams no longer has parameter filter
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 871bc7693aae45dd1bcd3423d91c96b33f4b7807. 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/databoxedge/armdataboxedge [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Struct `CloudError` has been removed
      info	[Changelog] - Struct `CloudErrorBody` has been removed
      info	[Changelog]
      info	[Changelog] Total 4 breaking change(s), 0 additive change(s).
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 871bc7693aae45dd1bcd3423d91c96b33f4b7807. 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 -> 22.3.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
      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-databoxedge [View full logs]  [Preview SDK Changes]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 871bc7693aae45dd1bcd3423d91c96b33f4b7807. 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
    • ️✔️databoxedge [View full logs]  [Preview Schema Changes]
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 871bc7693aae45dd1bcd3423d91c96b33f4b7807. 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.DataBoxEdge [View full logs]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 4, 2023

    Generated ApiView

    Language Package Name ApiView Link
    swagger Microsoft.DataBoxEdge https://apiview.dev/Assemblies/Review/21ed25ac220e4836819db1ffd3a385ea
    Go sdk/resourcemanager/databoxedge/armdataboxedge https://apiview.dev/Assemblies/Review/cdc95f2b88db41f4bd9c94d5cda604cb
    Java azure-resourcemanager-databoxedge https://apiview.dev/Assemblies/Review/ec3b0bec63fa4c7f87461c7ff892d564
    .Net Azure.ResourceManager.DataBoxEdge There is no API change compared with the previous version
    JavaScript @azure/arm-databoxedge https://apiview.dev/Assemblies/Review/53514ec506624fb587e1f0fb24746082

    @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 4, 2023
    @openapi-workflow-bot
    Copy link

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

    @sameerpatro
    Copy link
    Contributor Author

    The breaking changes were part of previous review. Here is the breaking change approved task and the PR.

    Task: https://msazure.visualstudio.com/One/_workitems/edit/14008883

    Swagger PR: #18529

    @AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-MissingBaseCommit new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager labels Jan 4, 2023
    @openapi-workflow-bot
    Copy link

    Hi @sameerpatro, 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, @sameerpatro, 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

    @mentat9
    Copy link
    Member

    mentat9 commented Jan 5, 2023

    @sameerpatro - It looks like the latest checked-in version of this spec is 2022-12-01-preview. Please make your base commit on files from that version, so we can see all changes to now. If some of the intermediate API versions were already reviewed/signed off by ARM, please provide links to those PRs: we don't want to re-review those changes.

    @mentat9 mentat9 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jan 5, 2023
    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 5, 2023
    @lirenhe
    Copy link
    Member

    lirenhe commented Jan 5, 2023

    @sameerpatro, the PR contains breaking changes compared with the last stable version, please follow the below guide for review.

    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.

    @sameerpatro sameerpatro closed this Jan 5, 2023
    @sameerpatro
    Copy link
    Contributor Author

    @sameerpatro - It looks like the latest checked-in version of this spec is 2022-12-01-preview. Please make your base commit on files from that version, so we can see all changes to now. If some of the intermediate API versions were already reviewed/signed off by ARM, please provide links to those PRs: we don't want to re-review those changes.

    I have created another PR with the base commit. Here is the PR: #22072.
    Please help to review it.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-MissingBaseCommit new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager Reviewed-FeedbackProvided
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants