Review request for Microsoft.HealthcareApis to add version stable/2022-12-01 #21620
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
…022-06-01 to version 2022-12-01
|
Hi, @jnlycklama 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 |
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @jnlycklama your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| healthcare-apis.json | 2022-12-01(0960efa) | 2022-06-01(main) |
| healthcare-apis.json | 2022-12-01(0960efa) | 2022-10-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The new version is missing a client parameter that was found in the old version. Was 'subscriptionId' removed or renamed? New: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L4117:3 Old: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L4098:3 |
|
The new version is missing a client parameter that was found in the old version. Was 'apiVersion' removed or renamed? New: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L4117:3 Old: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L4098:3 |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-12 | package-2022-12(0960efa) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| 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.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L3829 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L37 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L78 |
|
The patch operation body parameter schema should contains property 'identity'. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L162 |
|
The async patch operation should return 202. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L172 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L187 |
|
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L214 |
|
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L355 |
|
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L400 |
|
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L400 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L444 |
|
An async PUT operation must return 201. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L476 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L497 |
|
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L524 |
|
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L545 |
|
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L587 |
|
The resource name parameter 'groupName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L587 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L717 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L758 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L806 |
|
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L806 |
|
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L862 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L876 |
|
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L906 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L921 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L966 |
|
The resource name parameter 'dicomServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L966 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L1010 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L1061 |
|
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L1061 |
|
The parameters:resourceGroupName,dicomServiceName,workspaceName should be kept in the same order as they present in the path. Location: Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json#L1075 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 32 Errors, 0 Warnings failed [Detail]
Tag package-2022-12; Prod region: Deployed
Test run on region: centralindia; Operation coverage: total: 46, untested: 0, failed: 28, passed: 18
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
statusCode: 400, errorCode: BadRequest, errorMessage: WWW-Authenticate header is invalid in response from endpoint https://my-vault.vault.azure.net/keys/my-key. header value: Bearer authorization="https://login.windows.net/974efe84-a7ab-4d1e-9d45-a3ded745a319", resource="https://vault.azure.net" Source: runtime OperationId: Services_CreateOrUpdate |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.HealthcareApis/services/resource3c7ppy' under resource group 'apiTest-oBYoIY-21620' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Services_Get |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.HealthcareApis/services/resource3c7ppy' under resource group 'apiTest-oBYoIY-21620' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Services_Update |
|
Additional properties not allowed: errorSettings Source: response OperationId: IotConnectors_CreateOrUpdate |
|
String does not match pattern ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$: workspacrtmdzz/iotconnen6uhip Source: response OperationId: IotConnectors_CreateOrUpdate |
|
Additional properties not allowed: errorSettings Source: response OperationId: IotConnectors_ListByWorkspace |
|
String does not match pattern ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$: workspacrtmdzz/iotconnen6uhip Source: response OperationId: IotConnectors_ListByWorkspace |
|
Additional properties not allowed: errorSettings Source: response OperationId: IotConnectors_Get |
|
String does not match pattern ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$: workspacrtmdzz/iotconnen6uhip Source: response OperationId: IotConnectors_Get |
|
Additional properties not allowed: errorSettings Source: response OperationId: IotConnectors_Update |
|
String does not match pattern ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$: workspacrtmdzz/iotconnen6uhip Source: response OperationId: IotConnectors_Update |
|
String does not match pattern ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$: workspacrtmdzz/fhirservnjirn9 Source: response OperationId: FhirServices_CreateOrUpdate |
|
String does not match pattern ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$: workspacrtmdzz/fhirservnjirn9 Source: response OperationId: FhirServices_ListByWorkspace |
|
String does not match pattern ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$: workspacrtmdzz/fhirservnjirn9 Source: response OperationId: FhirServices_Get |
|
String does not match pattern ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$: workspacrtmdzz/fhirservnjirn9 Source: response OperationId: FhirServices_Update |
|
String does not match pattern ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$: workspacrtmdzz/dicomser52ol16 Source: response OperationId: DicomServices_CreateOrUpdate |
|
String does not match pattern ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$: workspacrtmdzz/dicomser52ol16 Source: response OperationId: DicomServices_ListByWorkspace |
|
String does not match pattern ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$: workspacrtmdzz/dicomser52ol16 Source: response OperationId: DicomServices_Get |
|
String does not match pattern ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$: workspacrtmdzz/dicomser52ol16 Source: response OperationId: DicomServices_Update |
|
statusCode: 400, errorCode: BadRequest, errorMessage: Private Endpoint Connection in request contains null or empty Id. Source: runtime OperationId: WorkspacePrivateEndpointConnections_CreateOrUpdate |
|
statusCode: 404, errorCode: NotFound, errorMessage: Private Endpoint Connection in request is null. Source: runtime OperationId: WorkspacePrivateEndpointConnections_Get |
|
statusCode: 400, errorCode: BadRequest, errorMessage: The fhirServiceResourceId property must be a resource id for a FHIR Service in the same workspace. Source: runtime OperationId: IotConnectorFhirDestination_CreateOrUpdate |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The resource with identifier '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-oBYoIY-21620/providers/Microsoft.HealthcareApis/workspaces/workspacrtmdzz/iotconnectors/iotconnen6uhip/fhirdestinations/fhirdesttfm39m' is not found. Source: runtime OperationId: IotConnectorFhirDestination_Get |
|
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'resource3c7ppy' not found. Source: runtime OperationId: PrivateEndpointConnections_CreateOrUpdate |
|
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'resource3c7ppy' not found. Source: runtime OperationId: PrivateEndpointConnections_ListByService |
|
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'resource3c7ppy' not found. Source: runtime OperationId: PrivateEndpointConnections_Get |
|
statusCode: 400, errorCode: NoRegisteredProviderFound, errorMessage: No registered resource provider found for location 'locationim7mv9' and API version '2022-12-01' for type 'locations/operationresults'. The supported api-versions are '2018-08-20-preview, 2019-09-16, 2020-03-15, 2020-03-30, 2020-05-01-preview, 2021-01-11, 2021-06-01-preview, 2021-11-01, 2022-01-31-preview, 2022-05-15, 2022-06-01, 2022-12-01'. The supported locations are 'ukwest, northcentralus, westus2, australiaeast, southeastasia, uksouth, eastus, westeurope, southcentralus, eastus2, northeurope, westcentralus, japaneast, germanywestcentral, canadacentral, southafricanorth, switzerlandnorth, centralindia, westus3, koreacentral, swedencentral, francecentral, qatarcentral'. Source: runtime OperationId: OperationResults_Get |
|
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'resource3c7ppy' not found. Source: runtime OperationId: PrivateLinkResources_ListByService |
|
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'resource3c7ppy' not found. Source: runtime OperationId: PrivateLinkResources_Get |
|
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'resource3c7ppy' not found. Source: runtime OperationId: PrivateEndpointConnections_Delete |
️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️~[Staging] CadlAPIView 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
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @jnlycklama, 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, @jnlycklama, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
This was referenced Nov 21, 2022
sjanamma
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
…tionGuidesConfig FHIR Implementation Guides configuration
|
Looking for a sign-off on the changes from the past 2 weeks, after sjanamma approved. Commits to review: Which is these listed commits: |
Not a blocking comment , but consider making this an enum as explained here : https://eng.ms/docs/products/arm/rp_onboarding/process/api_review_best_practices Replace boolean/switch properties with better enum Refers to: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-12-01/healthcare-apis.json:3834 in 0960efa. [](commit_id = 0960efa, deletion_comment = False) |
Thank you for the suggestion, @raosuhas. Using enums is something we'll consider in future changes. |
jnlycklama
added
the
WaitForARMFeedback
|
SigningOff the changes after last approval. |
visingla-ms
removed
the
WaitForARMFeedback
xiaoxuqi-ms
approved these changes
Jan 26, 2023
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
tadelesh
added
the
Approved-SdkBreakingChange-Go
|
Hi @jnlycklama , Ishould not merge this pr with errors of API readiness check, it is great to fix this and could you create a pr to fix this? |
This was referenced Jan 29, 2023
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Jan 29, 2023
…s to add version stable/2022-12-01 (#2693) Create to sync Azure/azure-rest-api-specs#21620 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/healthcareapis?expand=1)
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.
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:
Target is early December.
Ideally ASAP, but also targeting early December
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.