-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
update amhswagger and add folder structure #24162
Conversation
Hi, @athulvijayanmsft Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
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.
️️✔️
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] |
---|---|---|
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 |
||
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 |
||
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]
Swagger Generation Artifacts
|
Thank you for your contribution athulvijayanmsft! We will review the pull request and get back to you soon. |
Generated ApiView
|
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 |
@microsoft-github-policy-service agree company="Microsoft" |
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. |
@athulvijayanmsft , is this a new service? I found that |
Hi @raych1, |
@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 current PR package is 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 |
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 |
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? |
Hi @kazrael2119, can you approve the PR and add merge requested label? |
I‘m just responsible for reviewing JS sdk breaking |
/pr RequestMerge |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
* 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
ARM API Information (Control Plane)
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
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.
-[ ] 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.