[Hub Generated] Review request for Microsoft.HealthcareApis to add version stable/2022-05-15 #18855
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
…021-11-01 to version 2022-05-15
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: allowCredentials Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L3436 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The integer type does not have a format, please add it. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L2359 |
|
The integer type does not have a format, please add it. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L2422 |
|
The schema 'ServiceAccessPolicyEntry' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L2342 |
|
The schema 'ServicesResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L2521 |
|
The parameters:resourceGroupName,dicomServiceName,workspaceName should be kept in the same order as they present in the path. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L1075 |
|
The parameters:resourceGroupName,dicomServiceName,workspaceName should be kept in the same order as they present in the path. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L1134 |
|
The parameters:resourceGroupName,iotConnectorName,workspaceName should be kept in the same order as they present in the path. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L1336 |
|
The parameters:resourceGroupName,iotConnectorName,workspaceName should be kept in the same order as they present in the path. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L1395 |
|
The parameters:resourceGroupName,fhirServiceName,workspaceName should be kept in the same order as they present in the path. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L1811 |
|
The parameters:resourceGroupName,fhirServiceName,workspaceName should be kept in the same order as they present in the path. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L1870 |
|
Missing identifier id in array item property Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L2335 |
|
Missing identifier id in array item property Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L2790 |
|
Missing identifier id in array item property Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L3777 |
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L2840 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'PrivateEndpointConnections_CreateOrUpdate' Request Model: 'PrivateEndpointConnection' Response Model: 'PrivateEndpointConnectionDescription' Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L444 |
|
| Based on the response model schema, operation 'PrivateLinkResources_ListByService' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L546 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'ServicesDescription', must have a list by immediate parent operation. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L2689 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'Workspace', must have a list by immediate parent operation. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L2689 |
|
| The child tracked resource, 'privateLinkResources' with immediate parent 'ServicesDescription', must have a list by immediate parent operation. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L2704 |
|
| The child tracked resource, 'privateLinkResources' with immediate parent 'Workspace', must have a list by immediate parent operation. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L2704 |
|
| Guid used in model definition 'ServiceManagedIdentity' for property 'principalId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L3157 |
|
| Guid used in model definition 'UserAssignedIdentity' for property 'principalId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L3202 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: smartProxyEnabled Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L2387 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: allowCredentials Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L2429 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L2665 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L2814 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: fillGapWithZero Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L3015 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: toBeExportedForShoebox Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L3046 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: smartProxyEnabled Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L3835 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: allowCredentials Location: Microsoft.HealthcareApis/stable/2022-05-15/healthcare-apis.json#L3878 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌~[Staging] 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-05-15'. 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'." |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️Cross-Version Breaking Changes: 4 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.9.3)
- current:stable/2022-05-15/healthcare-apis.json compared with base:stable/2021-11-01/healthcare-apis.json
- current:stable/2022-05-15/healthcare-apis.json compared with base:preview/2022-01-31-preview/healthcare-apis.json
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
Swagger Generation Artifacts
|
This was referenced Apr 28, 2022
This was referenced Apr 28, 2022
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @poadhika your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
raosuhas
added
ARMSignedOff
dustinburson
reviewed
May 2, 2022
| @@ -3669,7 +3673,7 @@ | |||
| }, | |||
| "corsConfiguration": { | |||
| "description": "Fhir Service Cors configuration.", | |||
| "$ref": "#/definitions/FhirServiceCorsConfiguration" | |||
There was a problem hiding this comment.
Unfortunately, we can't make this change. It causes breaking changes with the SDKs.
There was a problem hiding this comment.
Unfortunately, we can't make this change. It causes breaking changes with the SDKs.
Thank you for pointing this out. Updated,
lirenhe
approved these changes
May 11, 2022
|
@poadhika , I saw one open comment so let me know if this PR is ready to merge. |
This was referenced May 23, 2022
This was referenced May 23, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
May 23, 2022
…ft.HealthcareApis to add version stable/2022-05-15 (#2381) Create to sync Azure/azure-rest-api-specs#18855 [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.
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 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.