Healthbot sdk fix - add "x-ms-long-running-operation": true to patch operation#22908
Merged
Healthbot sdk fix - add "x-ms-long-running-operation": true to patch operation#22908
Conversation
Add "x-ms-long-running-operation": true
Add "x-ms-long-running-operation": true
Add "x-ms-long-running-operation": true
Add "x-ms-long-running-operation": true
|
Hi, @guy-microsoft 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 |
|---|---|---|
| healthbot.json | 2022-08-08(5ebd4cd) | 2022-08-08(main) |
| Rule | Message |
|---|---|
|
The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.HealthBot/stable/2022-08-08/healthbot.json#L134:7 Old: Microsoft.HealthBot/stable/2022-08-08/healthbot.json#L134:7 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-08-08 | package-2022-08-08(5ebd4cd) | package-2022-08-08(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The parameter 'subscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.HealthBot/stable/2022-08-08/healthbot.json#L934 |
|
The parameter 'apiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.HealthBot/stable/2022-08-08/healthbot.json#L941 |
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HealthBot/stable/2022-08-08/healthbot.json#L607 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HealthBot/stable/2022-08-08/healthbot.json#L641 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.HealthBot/stable/2022-08-08/healthbot.json#L851 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HealthBot/stable/2022-08-08/healthbot.json#L863 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.HealthBot/stable/2022-08-08/healthbot.json#L209:22 ExampleUrl: stable/2022-08-08/examples/ResourceDeletionDelete.json |
️️✔️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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Mar 5, 2023
Contributor
Author
|
Hi @msyyc, this change is required for generating Go sdk. The missing annotation prevents from supporting 201 response code for patch by the sdk. |
Member
Member
Contributor
Author
Member
|
@guy-microsoft you need to click the |
Contributor
Author
|
@tadelesh I tried to click it but nothing happened. |
Member
|
@raych1 Could you help? |
Contributor
Author
|
@raych1 Please note that I didn't change the request/responses, just added required annotations for SDK generation (supporting LRO in SDK generation). |
raych1
added
the
BreakingChangeReviewRequired
|
Hi @guy-microsoft, 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. |
Member
specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2020-12-08/healthbot.json
Outdated
Show resolved
Hide resolved
Member
|
The JS breaking is introduced by the non-LRO to LRO. I would accept this breaking once it is approved by arch. |
|
Hi @guy-microsoft, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Contributor
Author
|
After a discussion with breaking change review board, we decided to minimize the change, and apply it only to the latest api version. |
mikekistler
added
the
Approved-BreakingChange
tadelesh
added
the
Approved-SdkBreakingChange-Go
Contributor
Author
|
@msyyc We've got all the required breaking change approvals. Would appreciate your approval and help with merging. Thanks! |
msyyc
approved these changes
Mar 31, 2023
Member
|
ModelValidation failure is not caused by this PR |
This was referenced Mar 31, 2023
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
…operation (Azure#22908) * Update healthbot.json Add "x-ms-long-running-operation": true * Update healthbot.json Add "x-ms-long-running-operation": true * Update healthbot.json Add "x-ms-long-running-operation": true * Update healthbot.json Add "x-ms-long-running-operation": true * Update healthbot.json * Update healthbot.json Fix * Update healthbot.json * Update healthbot.json * Update healthbot.json
8 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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.