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

update amhswagger and add folder structure #24162

Merged

Conversation

athulvijayanmsft
Copy link
Contributor

@athulvijayanmsft athulvijayanmsft commented May 25, 2023

ARM API Information (Control Plane)

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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
  • 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, @athulvijayanmsft 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 May 25, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌Breaking Change(Cross-Version): 37 Errors, 20 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    hubmigrate.json 2023-01-01(dfcc5e6) 2020-05-01(main)

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

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

    Rule Message
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ModifyConnectionStateBody' removed or renamed?
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L2541:3
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L720:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ConnectionStateRequestBodyProperties' removed or renamed?
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L2541:3
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L720:3
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'subscriptionId' removed or renamed?
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L22:3
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L17:3
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'resourceGroupName' removed or renamed?
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L22:3
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L17:3
    1010 - AddingRequiredParameter The required parameter 'api-version' was added in the new version.
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L2508:9
    1011 - AddingResponseCode The new version adds a response code '201'.
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L1624:11
    1011 - AddingResponseCode The new version adds a response code '201'.
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L1954:11
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L262:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L739:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L267:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L743:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L272:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L747:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L277:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L751:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L5361:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L1094:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L332:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L1134:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L337:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L1138:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L346:13
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L1156:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L351:13
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L1160:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L356:13
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L1164:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L361:13
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L1168:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L368:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L1146:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L400:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L1116:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v3/types.json#L411:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L1124:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L1549:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L69:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L1594:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L115:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L1661:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L170:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L1706:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L216:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L1815:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L280:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L1865:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L328:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L1917:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L381:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L1991:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L443:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: MigrateProjects/stable/2023-01-01/hubmigrate.json#L2404:9
    Old: MigrateProjects/stable/2020-05-01/hubmigrate.json#L498:9
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 3 Warnings warning [Detail]
    compared tags (via openapi-validator v2.1.5) new version base version
    package-hubmigrate-2023-01 package-hubmigrate-2023-01(dfcc5e6) default(main)

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

    Rule Message Related RPC [For API reviewers]
    ⚠️ RequiredReadOnlySystemData The response of operation:'SolutionsController_GetSolution' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: MigrateProjects/stable/2023-01-01/hubmigrate.json#L759
    ⚠️ RequiredReadOnlySystemData The response of operation:'SolutionsController_Create' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: MigrateProjects/stable/2023-01-01/hubmigrate.json#L806
    ⚠️ RequiredReadOnlySystemData The response of operation:'SolutionsController_Update' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: MigrateProjects/stable/2023-01-01/hubmigrate.json#L875
    ️❌Avocado: 32 Errors, 0 Warnings failed [Detail]

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

    Rule Message
    NOT_LATEST_API_VERSION_IN_DEFAULT_TAG The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/privateEndpointConnections is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/privateEndpointConnections/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/privateLinkResources/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/privateLinkResources is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Migrate/migrateProjects is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourcegroups/{}/providers/Microsoft.Migrate/migrateProjects is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/databaseInstances is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/databaseInstances/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/databases is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/databases/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/migrateEvents is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/migrateEvents/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/machines is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/machines/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/registerTool is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/refreshSummary is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/solutions/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/solutions is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/solutions/{}/getConfig is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/solutions/{}/cleanupData is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/virtualDesktopUsers is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/virtualDesktopUsers/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/webServers is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/webServers/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/webSites is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/webSites/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/registrationDetails is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Migrate/migrateProjects/{}/privateEndpointConnectionProxies is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/migrate/resource-manager/readme.md
    json: MigrateProjects/stable/2023-01-01/hubmigrate.json
    ️️✔️SwaggerAPIView 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).
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    ️️✔️Automated merging requirements met succeeded [Detail] [Expand]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 25, 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-js - @azure/arm-migrate - Approved - 3.0.0
    +	Class AzureMigrateV2 no longer has parameter assessedMachines
    +	Class AzureMigrateV2 no longer has parameter assessments
    +	Class AzureMigrateV2 no longer has parameter groups
    +	Class AzureMigrateV2 no longer has parameter hyperVCollectors
    +	Class AzureMigrateV2 no longer has parameter importCollectors
    +	Class AzureMigrateV2 no longer has parameter machines
    +	Class AzureMigrateV2 no longer has parameter privateEndpointConnectionOperations
    +	Class AzureMigrateV2 no longer has parameter privateLinkResourceOperations
    +	Class AzureMigrateV2 no longer has parameter serverCollectors
    +	Class AzureMigrateV2 no longer has parameter vMwareCollectors
    +	Enum KnownProvisioningState no longer has value Creating
    +	Enum KnownProvisioningState no longer has value Deleting
    +	Enum KnownProvisioningState no longer has value Moving
    +	Interface Machine no longer has parameter eTag
    +	Interface MachineProperties no longer has parameter bootType
    +	Interface MachineProperties no longer has parameter createdTimestamp
    +	Interface MachineProperties no longer has parameter datacenterManagementServerArmId
    +	Interface MachineProperties no longer has parameter datacenterManagementServerName
    +	Interface MachineProperties no longer has parameter description
    +	Interface MachineProperties no longer has parameter discoveryMachineArmId
    +	Interface MachineProperties no longer has parameter disks
    +	Interface MachineProperties no longer has parameter displayName
    +	Interface MachineProperties no longer has parameter groups
    +	Interface MachineProperties no longer has parameter megabytesOfMemory
    +	Interface MachineProperties no longer has parameter networkAdapters
    +	Interface MachineProperties no longer has parameter numberOfCores
    +	Interface MachineProperties no longer has parameter operatingSystemName
    +	Interface MachineProperties no longer has parameter operatingSystemType
    +	Interface MachineProperties no longer has parameter operatingSystemVersion
    +	Interface MachineProperties no longer has parameter updatedTimestamp
    +	Removed Enum KnownAssessmentSizingCriterion
    +	Removed Enum KnownAssessmentStage
    +	Removed Enum KnownAssessmentStatus
    +	Removed Enum KnownAzureDiskSize
    +	Removed Enum KnownAzureDiskSuitabilityDetail
    +	Removed Enum KnownAzureDiskSuitabilityExplanation
    +	Removed Enum KnownAzureDiskType
    +	Removed Enum KnownAzureHybridUseBenefit
    +	Removed Enum KnownAzureLocation
    +	Removed Enum KnownAzureNetworkAdapterSuitabilityDetail
    +	Removed Enum KnownAzureNetworkAdapterSuitabilityExplanation
    +	Removed Enum KnownAzureOfferCode
    +	Removed Enum KnownAzurePricingTier
    +	Removed Enum KnownAzureStorageRedundancy
    +	Removed Enum KnownAzureVmFamily
    +	Removed Enum KnownAzureVmSize
    +	Removed Enum KnownAzureVmSuitabilityDetail
    +	Removed Enum KnownAzureVmSuitabilityExplanation
    +	Removed Enum KnownCloudSuitability
    +	Removed Enum KnownCurrency
    +	Removed Enum KnownGroupStatus
    +	Removed Enum KnownGroupUpdateOperation
    +	Removed Enum KnownMachineBootType
    +	Removed Enum KnownPercentile
    +	Removed Enum KnownPrivateEndpointConnectionPropertiesProvisioningState
    +	Removed Enum KnownProjectStatus
    +	Removed Enum KnownReservedInstance
    +	Removed Enum KnownTimeRange
    +	Removed operation Projects.assessmentOptions
    +	Removed operation Projects.create
    +	Removed operation Projects.delete
    +	Removed operation Projects.get
    +	Removed operation Projects.listAssessmentOptionsList
    +	Removed operation Projects.update
    +	Removed operation group AssessedMachines
    +	Removed operation group Assessments
    +	Removed operation group Groups
    +	Removed operation group HyperVCollectors
    +	Removed operation group ImportCollectors
    +	Removed operation group Machines
    +	Removed operation group PrivateEndpointConnectionOperations
    +	Removed operation group PrivateLinkResourceOperations
    +	Removed operation group ServerCollectors
    +	Removed operation group VMwareCollectors
    +	Type of parameter origin of interface Operation is changed from string to Origin
    +	Type of parameter provisioningState of interface PrivateEndpointConnectionProperties is changed from PrivateEndpointConnectionPropertiesProvisioningState to ProvisioningState
    +	Type of parameter value of interface ProjectResultList is changed from Project[] to MigrateProject[]
    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • Failed [Logs]Release - Generate from e7ecf14. 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:714
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 714 | �[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.Migrate [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from e7ecf14. 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/migrate/armmigrate [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from e7ecf14. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
      cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.
    • ️✔️@azure/arm-migrate [View full logs]  [Release SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️❌ azure-resource-manager-schemas failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from e7ecf14. 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] npm notice
      cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.1.0
      cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
      cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.1.0` to update!
      cmderr	[initScript.sh] npm notice
      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
      cannot force update branch 'sdkAuto/migrate' as it is the current HEAD of the repository.
      Error: cannot force update branch 'sdkAuto/migrate' as it is the current HEAD of the repository.
    • ️✔️migrate [View full logs]  [Release Schema Changes]
    • ️✔️migrate [View full logs
      error	Fatal error: cannot force update branch 'sdkAuto/migrate' as it is the current HEAD of the repository.
      error	The following packages are still pending:
      error		migrate
      error		migrate
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from e7ecf14. 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
      SSL error: syscall failure: Broken pipe
      Error: SSL error: syscall failure: Broken pipe
    • ️✔️Az.migrate.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.migrate.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    @ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label May 25, 2023
    @ghost
    Copy link

    ghost commented May 25, 2023

    Thank you for your contribution athulvijayanmsft! We will review the pull request and get back to you soon.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 25, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/migrate/armmigrate https://apiview.dev/Assemblies/Review/88fc6ddbac1244dd89733c212fb4ffe8
    JavaScript @azure/arm-migrate https://apiview.dev/Assemblies/Review/2ac97eb6dd704fd7946d049594d79b6e
    .Net Azure.ResourceManager.Migrate https://apiview.dev/Assemblies/Review/72f4acfeb30547eaadf0d73ebc91eb87

    @openapi-workflow-bot
    Copy link

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

    @athulvijayanmsft
    Copy link
    Contributor Author

    @athulvijayanmsft please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

    @microsoft-github-policy-service agree [company="{your company}"]
    

    Options:

    • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
    @microsoft-github-policy-service agree
    
    • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
    @microsoft-github-policy-service agree company="Microsoft"
    

    Contributor License Agreement

    @microsoft-github-policy-service agree company="Microsoft"

    @athulvijayanmsft athulvijayanmsft changed the title update amhswagger without folder restructure update amhswagger and add folder structure Jun 9, 2023
    @AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Jun 9, 2023
    @openapi-workflow-bot
    Copy link

    Hi @athulvijayanmsft, 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.

    @raych1
    Copy link
    Member

    raych1 commented Sep 14, 2023

    @athulvijayanmsft , is this a new service? I found that hubmigrate.json is totally different with migrate.json. Can you change the default tag to the latest one so that the SDK package can be generated in this PR for review?

    @athulvijayanmsft
    Copy link
    Contributor Author

    @athulvijayanmsft , is this a new service? I found that hubmigrate.json is totally different with migrate.json. Can you change the default tag to the latest one so that the SDK package can be generated in this PR for review?

    Hi @raych1,
    This is for a different resourcetype named migrateProjects under Azure.Migrate, while the existing migrate.json is for different resourcetype assessmentProjects. Currently SDK breaking changes-for-js are flagged as the types under existing assessmentProjects are not using common-types which is taken care in #25417 as a new version and the existing default tag will be deprecated. We request you to approve the changes in this PR and we will take responsibility for any fixes if required during sdk generation in separate PR.

    @raych1
    Copy link
    Member

    raych1 commented Sep 15, 2023

    @athulvijayanmsft , as they are different resource types and the new swagger file doesn't include the previous resource types, the sdk package name shouldn't be the same one as previous package.

    @athulvijayanmsft
    Copy link
    Contributor Author

    @athulvijayanmsft , as they are different resource types and the new swagger file doesn't include the previous resource types, the sdk package name shouldn't be the same one as previous package.

    Hi @raych1,
    The package names are different, the old default tag package was package-migrate-2019-10 which contained assessmentProjects resourcetype.

    The current PR package is tag: package-hubmigrate-2023-01 which has different resourcetype.

    Keeping either/both of the package names as the default tag causes checks failure as the resourcetypes and related definitions are different. Also in the current PR we are using common-types for few definitions which was local definitions in older resourcetype; which causes duplicate definition flagging.

    @athulvijayanmsft
    Copy link
    Contributor Author

    @athulvijayanmsft , as they are different resource types and the new swagger file doesn't include the previous resource types, the sdk package name shouldn't be the same one as previous package.

    Hi @raych1, The package names are different, the old default tag package was package-migrate-2019-10 which contained assessmentProjects resourcetype.

    The current PR package is tag: package-hubmigrate-2023-01 which has different resourcetype.

    Keeping either/both of the package names as the default tag causes checks failure as the resourcetypes and related definitions are different. Also in the current PR we are using common-types for few definitions which was local definitions in older resourcetype; which causes duplicate definition flagging.

    Hi @raych1 / @kazrael2119, as the breaking change tests are failing just due to duplicate entries in an older tag which will be deprecated and since the current package follows recommended common-types, please approve the sdk breaking change and the PR?

    @kazrael2119
    Copy link
    Contributor

    approve because of the 2019-10-01 version is going to be deprecated according to service team.

    @athulvijayanmsft
    Copy link
    Contributor Author

    approve because of the 2019-10-01 version is going to be deprecated according to service team.

    Thanks @kazrael2119. Can you approve the PR review and add MergeRequested tag?

    @athulvijayanmsft
    Copy link
    Contributor Author

    Hi @kazrael2119, can you approve the PR and add merge requested label?

    @kazrael2119
    Copy link
    Contributor

    Hi @kazrael2119, can you approve the PR and add merge requested label?

    I‘m just responsible for reviewing JS sdk breaking

    @tarsharm tarsharm added Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates MergeRequested and removed MergeRequested labels Sep 25, 2023
    @athulvijayanmsft
    Copy link
    Contributor Author

    /pr RequestMerge

    @openapi-workflow-bot openapi-workflow-bot bot added commitAfterSignedOff and removed Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates labels Sep 28, 2023
    @tarsharm tarsharm added Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates and removed commitAfterSignedOff labels Sep 28, 2023
    @raosuhas raosuhas merged commit e7ecf14 into Azure:main Sep 28, 2023
    @openapi-pipeline-app
    Copy link

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    jnlycklama pushed a commit that referenced this pull request Nov 8, 2023
    * update amhswagger without folder restructure
    
    * fix checks; credscan and ref errors
    
    * fix spellcheck
    
    * update readme.md
    
    * fix lints
    
    * fix lints
    
    * update common-types path
    
    * fix lints
    
    * folder restructure and lint fixes
    
    * fix common-types path after restructure
    
    * fix folder structure in readme
    
    * fix lints
    
    * fix lints
    
    * fix lints
    
    * fix lints
    
    * fix lints
    
    * fix lints
    
    * fix lints
    
    * fix lints
    
    * fix lints
    
    * fix lints
    
    * fix lints
    
    * fix lints
    
    * fix lints
    
    * fix lints
    
    * fix lints
    
    * fix examples
    
    * add missing examples
    
    * fix readme path
    
    * add examples
    
    * fix lints
    
    * fix lints
    
    * fix lints
    
    * fix lints
    
    * fix lints; fix examples
    
    * fix lints; fix examples
    
    * fix lints
    
    * fix lints; update readme
    
    * fix lints
    
    * fix avocado
    
    * fix avocado
    
    * fix avocado
    
    * fix model validation
    
    * fix model validation
    
    * added new version; removed breaking changes from published swagger
    
    * update examples for ga version
    
    * rename version
    
    * rename version
    
    * resolve cross version breaking changes
    
    * fix common types path
    
    * fix common types path
    
    * add common-types
    
    * fix prettify
    
    * fix prettify
    
    * fix prettify
    
    * revert 2020-05-01
    
    * fix prettify
    
    * fix nextLinkName
    
    * remove duplicate key for sdk gen
    
    * remove duplicate key for sdk gen
    
    * remove duplicate key for sdk gen
    
    * remove common-types
    
    * fix nettrack sdk
    
    * fix default tag
    
    * fix ci sdk breaking change
    
    * fix spacing
    
    * update tag
    
    * fix tag
    
    * fix tag
    
    * add default tag, update title
    
    * add default tag, update title
    
    * revert tag and add title
    
    * revert tag
    
    * add sdk java section
    
    * update default tag to resourcetype
    
    * revert tag to original which will be fixed in later PR during the deprecation
    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-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-JavaScript 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-MissingBaseCommit commitAfterSignedOff customer-reported Issues that are reported by GitHub users external to the Azure organization. FixS360 new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.