-
Notifications
You must be signed in to change notification settings - Fork 5k
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
Dev tongwu healthcareapis microsoft.healthcare apis stable 2022 06 01 #19496
Dev tongwu healthcareapis microsoft.healthcare apis stable 2022 06 01 #19496
Conversation
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
|
Rule | Message |
---|---|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: initialImportMode Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2460 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2465 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isInternal Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L3057 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableRegionalMdmAccount Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L3069 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: initialImportMode Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L3985 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L3990 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2363 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2426 |
R4037 - MissingTypeObject |
The schema 'ServiceAccessPolicyEntry' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2346 |
R4037 - MissingTypeObject |
The schema 'ServicesResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2546 |
R4039 - 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 |
R4039 - 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#L1134 |
R4039 - ParametersOrder |
The parameters:resourceGroupName,iotConnectorName,workspaceName should be kept in the same order as they present in the path. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L1336 |
R4039 - ParametersOrder |
The parameters:resourceGroupName,iotConnectorName,workspaceName should be kept in the same order as they present in the path. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L1395 |
R4039 - ParametersOrder |
The parameters:resourceGroupName,fhirServiceName,workspaceName should be kept in the same order as they present in the path. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L1811 |
R4039 - ParametersOrder |
The parameters:resourceGroupName,fhirServiceName,workspaceName should be kept in the same order as they present in the path. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L1870 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2339 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2815 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L3826 |
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2865 |
|
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-06-01/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-06-01/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-06-01/healthcare-apis.json#L2714 |
|
The child tracked resource, 'privateEndpointConnections' with immediate parent 'Workspace', must have a list by immediate parent operation. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2714 |
|
The child tracked resource, 'privateLinkResources' with immediate parent 'ServicesDescription', must have a list by immediate parent operation. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2729 |
|
The child tracked resource, 'privateLinkResources' with immediate parent 'Workspace', must have a list by immediate parent operation. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2729 |
|
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-06-01/healthcare-apis.json#L3202 |
|
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-06-01/healthcare-apis.json#L3247 |
|
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-06-01/healthcare-apis.json#L2391 |
|
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-06-01/healthcare-apis.json#L2433 |
|
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-06-01/healthcare-apis.json#L2690 |
|
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-06-01/healthcare-apis.json#L2839 |
|
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-06-01/healthcare-apis.json#L3040 |
|
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-06-01/healthcare-apis.json#L3091 |
|
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-06-01/healthcare-apis.json#L3481 |
|
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-06-01/healthcare-apis.json#L3884 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
API Readiness check failed. Please make sure your service is deployed. |
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.HealthcareApis' for api version '2022-06-01'. 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'." |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
- Compared Swaggers (Based on Oad v0.9.5)
- current:stable/2022-06-01/healthcare-apis.json compared with base:stable/2022-05-15/healthcare-apis.json
- current:stable/2022-06-01/healthcare-apis.json compared with base:preview/2022-01-31-preview/healthcare-apis.json
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
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
|
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). |
For these boolean, have you considered if they can be enum: https://armwiki.azurewebsites.net/rp_onboarding/process/api_review_best_practices.html Refers to: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json:2460 in 7273b6c. [](commit_id = 7273b6c, deletion_comment = False) |
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
Thanks for the comments. The initialImportMode is a settings for customer to run import in this special mode, it is more like a true/false value instead of a enum. |
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.