-
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
Swagger correctness operations API #12696
Conversation
Hi, @anponnet 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
|
Rule | Message |
---|---|
1041 - AddedPropertyInResponse |
The new version has a new property 'isDataAction' in response that was not found in the old version. New: Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json#L6809:7 Old: Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json#L6809:7 |
1041 - AddedPropertyInResponse |
The new version has a new property 'isDataAction' in response that was not found in the old version. New: Microsoft.DataBoxEdge/stable/2020-09-01/databoxedge.json#L6809:7 Old: Microsoft.DataBoxEdge/stable/2020-09-01/databoxedge.json#L6809:7 |
️⚠️
LintDiff: 2 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- Linted configuring files (Based on target branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
Rule | Message |
---|---|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction New: Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json#L6822 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction New: Microsoft.DataBoxEdge/stable/2020-09-01/databoxedge.json#L6822 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
Swagger Generation Artifacts
|
Hi ChenTanyi, a swagger correction is done in existing Operations API as per swagger correctness S360. It does not impact any customer and No SDK is released in these versions. Can you please review |
Hi @anponnet, 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. |
Hi @ChenTanyi , can you please check if I have to raise a breaking change request. There was an announcement that swagger correctness does not need it |
@anponnet Please also add another person (may be someone in your team) to review it. Thanks! |
Changes look fine. |
@ChenTanyi, @pvsraviteja from my team has approved in comments |
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with 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
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from API 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.