-
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.HealthcareApis to add version stable/2022-06-01 #20116
[Hub Generated] Review request for Microsoft.HealthcareApis to add version stable/2022-06-01 #20116
Conversation
…reviously approved change for previous versions. This version was published while the approval was pending so it didn't get updated at that time.
Hi, @PTaladay 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-06-01(52fa9f3) | 2022-06-01(main) |
Rule | Message |
---|---|
1036 - ConstraintChanged |
The new version has a different 'maximum' value than the previous one. New: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2366:9 Old: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2366:9 |
️️✔️
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-06 | package-2022-06(52fa9f3) | package-2022-06(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L37 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L78 |
PatchIdentityProperty |
The patch operation body parameter schema should contains property 'identity'. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L162 |
LroPatch202 |
The async patch operation should return 202. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L172 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L187 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L214 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L355 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L400 |
ResourceNameRestriction |
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L400 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L444 |
CreateOperationAsyncResponseValidation |
An async PUT operation must return 201. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L476 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L497 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L524 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L545 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L587 |
ResourceNameRestriction |
The resource name parameter 'groupName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L587 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L717 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L758 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L806 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L806 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L862 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L876 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L906 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L921 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L966 |
ResourceNameRestriction |
The resource name parameter 'dicomServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L966 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L1010 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L1061 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L1061 |
ParametersOrder |
The parameters:resourceGroupName,dicomServiceName,workspaceName should be kept in the same order as they present in the path. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L1075 |
️️✔️
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.
️️✔️
~[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
|
Generated ApiView
|
@ruowan Please see this previous approval for this change on all our other stable api versions. This version was published while the review was still pending. https://msazure.visualstudio.com/One/_workitems/edit/14708787 |
Hi @PTaladay, 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. |
Previous approval for this change here https://msazure.visualstudio.com/One/_workitems/edit/14708787 |
@ruowan It looks like there is something going on with the build pipeline that is preventing this PR from merging. Is anybody taking a look at it? |
Hi, @PTaladay. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @PTaladay. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @PTaladay. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
@ruowan The swagger model validation is incorrectly flagging issues with response not containing id in the examples. There is an ongoing conversation with those on the Swagger Validation team, but this isn't related to my change and was existing before my PR. Is there any way to bypass this so my PR can get completed? We are out of compliance because this PR never got committed. |
…ft.HealthcareApis to add version stable/2022-06-01 (#2691) Create to sync Azure/azure-rest-api-specs#20116 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/healthcareapis?expand=1)
…rsion stable/2022-06-01 (Azure#20116) * Removed maximum constraint for offerThroughput to keep aligned with previously approved change for previous versions. This version was published while the approval was pending so it didn't get updated at that time. * Fixes for model validation errors related to LRO_Response_HEADER. * Added incorrect change to resolve LRO model validation. Updated. * Another LRO fix. * Fix formatting issue. * Removing Resource header tag.
…rsion stable/2022-06-01 (Azure#20116) * Removed maximum constraint for offerThroughput to keep aligned with previously approved change for previous versions. This version was published while the approval was pending so it didn't get updated at that time. * Fixes for model validation errors related to LRO_Response_HEADER. * Added incorrect change to resolve LRO model validation. Updated. * Another LRO fix. * Fix formatting issue. * Removing Resource header tag.
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.