-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
HWG new api swagger #19121
HWG new api swagger #19121
Conversation
Hi, @ravydv 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. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.9.6)] | new version | base version |
---|---|---|
deletedAutomationAccount.json | 2022-01-31(cf09564) | 2022-01-31(main) |
Rule | Message |
---|---|
1033 - RemovedProperty |
The new version is missing a property found in the old version. Was 'deletedTime' renamed or removed? New: Microsoft.Automation/stable/2022-01-31/deletedAutomationAccount.json#L119:7 Old: Microsoft.Automation/stable/2022-01-31/deletedAutomationAccount.json#L119:7 |
1040 - AddedReadOnlyPropertyInResponse |
The new version has a new read-only property 'deletionTime' in response that was not found in the old version. New: Microsoft.Automation/stable/2022-01-31/deletedAutomationAccount.json#L119:7 Old: Microsoft.Automation/stable/2022-01-31/deletedAutomationAccount.json#L119:7 |
️❌
Breaking Change(Cross-Version): 8 Errors, 17 Warnings failed [Detail]
compared swaggers (via Oad v0.9.6)] | new version | base version |
---|---|---|
hybridRunbookWorkerGroup.json | 2022-02-22(cf09564) | 2021-06-22(main) |
hybridRunbookWorkerGroup.json | 2022-02-22(cf09564) | 2020-01-13(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2022-01-31 | package-2022-01-31(cf09564) | package-2022-01-31(main) |
package-2022-02-22 | package-2022-02-22(cf09564) | default(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Automation/stable/2022-02-22/hybridRunbookWorkerGroup.json#L75 |
R4037 - MissingTypeObject |
The schema 'RunAsCredentialAssociationProperty' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2022-02-22/hybridRunbookWorkerGroup.json#L314 |
R4037 - MissingTypeObject |
The schema 'HybridRunbookWorkerGroup' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2022-02-22/hybridRunbookWorkerGroup.json#L345 |
R4037 - MissingTypeObject |
The schema 'HybridRunbookWorkerGroupsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Automation/stable/2022-02-22/hybridRunbookWorkerGroup.json#L364 |
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'HybridRunbookWorkerGroup_Create' Request Model: 'HybridRunbookWorkerGroupCreateOrUpdateParameters' Response Model: 'HybridRunbookWorkerGroup' Location: Microsoft.Automation/stable/2022-02-22/hybridRunbookWorkerGroup.json#L137 |
|
Based on the response model schema, operation 'deletedAutomationAccounts_ListBySubscription' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Automation/stable/2022-01-31/deletedAutomationAccount.json#L40 |
|
Based on the response model schema, operation 'deletedAutomationAccounts_ListBySubscription' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Automation/stable/2022-01-31/deletedAutomationAccount.json#L40 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HybridRunbookWorkerGroupModel'. Consider using the plural form of 'HybridRunbookWorkerGroup' 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.Automation/stable/2022-02-22/hybridRunbookWorkerGroup.json#L44 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HybridRunbookWorkerGroupModel'. Consider using the plural form of 'HybridRunbookWorkerGroup' 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.Automation/stable/2022-02-22/hybridRunbookWorkerGroup.json#L91 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HybridRunbookWorkerGroupModel'. Consider using the plural form of 'HybridRunbookWorkerGroup' 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.Automation/stable/2022-02-22/hybridRunbookWorkerGroup.json#L141 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HybridRunbookWorkerGroupModel'. Consider using the plural form of 'HybridRunbookWorkerGroup' 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.Automation/stable/2022-02-22/hybridRunbookWorkerGroup.json#L200 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HybridRunbookWorkerGroupModel'. Consider using the plural form of 'HybridRunbookWorkerGroup' 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.Automation/stable/2022-02-22/hybridRunbookWorkerGroup.json#L261 |
|
The child tracked resource, 'hybridRunbookWorkerGroups' with immediate parent 'AutomationAccount', must have a list by immediate parent operation. Location: Microsoft.Automation/stable/2022-02-22/hybridRunbookWorkerGroup.json#L345 |
|
The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Automation/stable/2022-01-31/deletedAutomationAccount.json#L6 |
|
The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Automation/stable/2022-01-31/deletedAutomationAccount.json#L6 |
|
The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Automation/stable/2022-02-22/hybridRunbookWorkerGroup.json#L6 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/automation/resource-manager/readme.md tag: specification/automation/resource-manager/readme.md#tag-package-2022-02-22 |
️️✔️
ApiReadinessCheck 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.
️⚠️
SDK Track2 Validation: 94 Warnings warning [Detail]
- The following tags are being changed in this PR
Only 27 items are listed, please refer to log for more details.
Rule | Message |
---|---|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > AutomationAccountCreateOrUpdateParameters > properties > identity)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > AutomationAccountUpdateParameters > properties > identity)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > ScheduleCreateOrUpdateProperties > properties > frequency)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > ScheduleProperties > properties > frequency)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Using directive.0.suppress which is deprecated and will be removed in the future." |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Using directive.1.suppress which is deprecated and will be removed in the future." |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Using directive.2.suppress which is deprecated and will be removed in the future." |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Using directive.3.suppress which is deprecated and will be removed in the future." |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Using directive.4.suppress which is deprecated and will be removed in the future." |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Using directive.5.suppress which is deprecated and will be removed in the future." |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Using directive.6.suppress which is deprecated and will be removed in the future." |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Using directive.7.suppress which is deprecated and will be removed in the future." |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Using directive.8.suppress which is deprecated and will be removed in the future." |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Using directive.9.suppress which is deprecated and will be removed in the future." |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Using directive.10.suppress which is deprecated and will be removed in the future." |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Using directive.11.suppress which is deprecated and will be removed in the future." |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Using directive.12.suppress which is deprecated and will be removed in the future." |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > ScheduleCreateOrUpdateProperties > properties > frequency)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
"readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > ScheduleProperties > properties > frequency)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
💬 | "readme":"automation/resource-manager/readme.md", "tag":"package-2022-01-31", "details":"AutoRest core version selected from configuration: ^3.2.0." |
️️✔️
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.
Swagger Generation Artifacts
|
Hi @ravydv, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @ravydv, 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. |
NewApiVersionRequired reason: |
Hi @ravydv This PR has not passed breaking change review for long time. If you want to merge this PR, please following the action in the bottom of PR description to ask breaking change review. thanks |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
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.
Please follow the link to find more details on PR review process.