Dev healthcareapis microsoft.healthcare apis 2022 10 01 preview #19948
Conversation
This file contains 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
|
Hi, @tongwu-msft 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.2)] | new version | base version |
|---|---|---|
| healthcare-apis.json | 2022-10-01-preview(bdf770c) | 2022-06-01(main) |
| healthcare-apis.json | 2022-10-01-preview(bdf770c) | 2022-01-31-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version has a different 'maximum' value than the previous one. New: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2628:9 Old: Microsoft.HealthcareApis/preview/2022-01-31-preview/healthcare-apis.json#L2363:9 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 4 Errors, 0 Warnings failed [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-10 | package-preview-2022-10(bdf770c) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2202 |
RPC-V2-URI-5 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2247 |
RPC-V2-URI-5 |
|
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2401 |
RPC-V2-ASYNC-7 |
|
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2451 |
RPC-V2-ASYNC-7 |
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: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.HealthcareApis' for api version '2022-10-01-preview'. The supported api-versions are '2018-08-20-preview, 2019-09-16, 2020-03-15, 2020-03-30, 2021-01-11, 2021-06-01-preview, 2021-11-01, 2022-01-31-preview, 2022-05-15, 2022-06-01'." |
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️~[Staging] SwaggerAPIView 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.
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
|
Hi @tongwu-msft, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Jul 26, 2022
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @tongwu-msft your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Use 201/200 + provisioning state instead of 202, see : https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#creatingupdating-using-put Refers to: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json:2347 in b3f0ba4. [](commit_id = b3f0ba4, deletion_comment = False) |
Is 200 needed here? See https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#updating-using-patch Refers to: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json:2406 in b3f0ba4. [](commit_id = b3f0ba4, deletion_comment = False) |
zizw123
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
added 2 commits
December 1, 2022 11:26
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
Hi @tongwu-msft, 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. |
tongwu-sh
removed
the
BreakingChangeReviewRequired
ruowan
approved these changes
Dec 2, 2022
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
ruowan
removed
the
BreakingChangeReviewRequired
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
tongwu-sh
removed
the
BreakingChangeReviewRequired
This was referenced Dec 2, 2022
anandanthony
pushed a commit
to anandMicro/azure-rest-api-specs
that referenced
this pull request
Dec 16, 2022
…e#19948) * Adds base for updating Microsoft.HealthcareApis from version stable/2022-06-01 to version 2022-10-01-preview * Updates readme * Updates API version in new specs and examples * add analytics connector * add analytics connector example * fix error * fix error * fix error * fix error * remove 202 for create * fix bug * add discriminators * Add missing required type * remove 2 properties * remove additional properities * add long running operations * fix addition properties * fix name pattern * fix identity alert * revert workspace name change * fix location * fix warning * fix warning * fix LRO error * add async headers * merge from stable version Co-authored-by: Tong Wu (SH) <tongwu@microsoft.com>
kayousef-zz
pushed a commit
to kayousef-zz/azure-rest-api-specs
that referenced
this pull request
Dec 21, 2022
…e#19948) * Adds base for updating Microsoft.HealthcareApis from version stable/2022-06-01 to version 2022-10-01-preview * Updates readme * Updates API version in new specs and examples * add analytics connector * add analytics connector example * fix error * fix error * fix error * fix error * remove 202 for create * fix bug * add discriminators * Add missing required type * remove 2 properties * remove additional properities * add long running operations * fix addition properties * fix name pattern * fix identity alert * revert workspace name change * fix location * fix warning * fix warning * fix LRO error * add async headers * merge from stable version Co-authored-by: Tong Wu (SH) <tongwu@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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.