-
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
Fix Swagger Correctness Issues For HealthcareApis #12651
Fix Swagger Correctness Issues For HealthcareApis #12651
Conversation
Hi, @anrudraw 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. vsswagger@microsoft.com |
Swagger Validation Report
Only 10 items are listed, please refer to log for more details.
|
Rule | Message |
---|---|
Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json#L801 |
|
Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.HealthcareApis/stable/2019-09-16/healthcare-apis.json#L822 |
|
Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.HealthcareApis/stable/2020-03-15/healthcare-apis.json#L827 |
|
Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.HealthcareApis/stable/2020-03-30/healthcare-apis.json#L1132 |
|
The operation 'OperationResults_Get' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. New: Microsoft.HealthcareApis/stable/2019-09-16/healthcare-apis.json#L399 |
|
The operation 'OperationResults_Get' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. New: Microsoft.HealthcareApis/stable/2020-03-15/healthcare-apis.json#L399 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction New: Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json#L788 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction New: Microsoft.HealthcareApis/stable/2019-09-16/healthcare-apis.json#L809 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction New: Microsoft.HealthcareApis/stable/2020-03-15/healthcare-apis.json#L814 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction New: Microsoft.HealthcareApis/stable/2020-03-30/healthcare-apis.json#L1119 |
️️✔️
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 @anrudraw, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @anrudraw, 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. |
@anrudraw Do you need a refresh of SDK? |
@PhoenixHe-msft Do you know what will be customer impact if we refresh SDKs? |
@anrudraw User will get latest update for your fix, but this may cause breaking change in SDK. Suggest to do so to fix SDK issues. |
* Initial commit * Fix model validation * Fix typo
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.