-
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
[Hub Generated] Review request for Microsoft.RecoveryServices to add version stable/2022-05-01 #19659
[Hub Generated] Review request for Microsoft.RecoveryServices to add version stable/2022-05-01 #19659
Conversation
…/2022-03-01 to version 2022-05-01
Hi, @singhabh27 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
|
Swagger Generation Artifacts
|
Swagger Validation Report
|
compared swaggers (via Oad v0.9.6)] | new version | base version |
---|---|---|
service.json | 2022-05-01(1a85d68) | 2022-04-01(main) |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 4 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2022-05 | package-2022-05(1a85d68) | default(main) |
The following errors/warnings are introduced by current PR:
Rule | Message |
---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.RecoveryServices/stable/2022-05-01/service.json#L18745 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.RecoveryServices/stable/2022-05-01/service.json#L21682 |
|
A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.RecoveryServices/stable/2022-05-01/service.json#L2301 |
|
A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.RecoveryServices/stable/2022-05-01/service.json#L2378 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
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: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/1a85d6809840149edad4f25ded5935961291f91c/specification/recoveryservicessiterecovery/resource-manager/readme.md#tag-package-2022-05">recoveryservicessiterecovery/resource-manager/readme.md#package-2022-05
Rule | Message |
---|---|
"readme":"recoveryservicessiterecovery/resource-manager/readme.md", "tag":"package-2022-05", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️
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.
Hi @singhabh27, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Does this have a fixed set of values? If so, it should be a string enum. In reply to: 1185953798 Refers to: specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2022-05-01/service.json:18118 in bbd756d. [](commit_id = bbd756d, deletion_comment = False) |
ARM recommends against the use of the additionalProperties/empty/unschematized object pattern. ARM favors stronger typing wherever possible because it allows all consumers of your API to reason about it. This has benefits for everyone that interacts with your API including basic infrastructure, other Azure features, SDK owners, and customers. Unschematized objects are essentially API contracts that bypass Azure versioning infrastructure. Generally, this pattern should only be used when needed and the object properties are dynamic, unknown, or user defined. Ref: https://armwiki.azurewebsites.net/api_contracts/guidelines/openapi.html#oapi032-only-use-additionalproperties-when-the-object-properties-are-dynamic-unknown-or-user-defined. In reply to: 1185953859 Refers to: specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2022-05-01/service.json:18690 in bbd756d. [](commit_id = bbd756d, deletion_comment = False) |
If this has a fixed set of values, it should be modeled as string enum. In reply to: 1185953908 Refers to: specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2022-05-01/service.json:24219 in bbd756d. [](commit_id = bbd756d, deletion_comment = False) |
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
Hi @singhabh27 please remove |
Hi @JeffreyRichter Please help review the swagger breaking change. Thanks! |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
|
…st for Microsoft.RecoveryServices to add version stable/2022-05-01 (#2512) Create to sync Azure/azure-rest-api-specs#19659 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/recoveryservicessiterecovery?expand=1)
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
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:
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.
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.