add x-ms-identifiers for healthcareapi #19960
Merged
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, @j-zhong-ms 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.9.7)] | new version | base version |
|---|---|---|
| healthcare-apis.json | 2022-06-01(d35fb5f) | 2022-06-01(main) |
️️✔️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 v1.13.0) | new version | base version |
|---|---|---|
| package-2022-06 | package-2022-06(d35fb5f) | 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 |
|---|---|
|
The integer type does not have a format, please add it. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2366 |
|
The integer type does not have a format, please add it. Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2429 |
|
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#L2349 |
|
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#L2549 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HealthcareApis/stable/2022-06-01/healthcare-apis.json#L2871 |
|
| 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#L2717 |
|
| 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#L2717 |
|
| 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#L2732 |
|
| 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#L2732 |
|
| 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#L3208 |
|
| 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#L3253 |
|
| 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#L2394 |
|
| 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#L2436 |
|
| 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#L2463 |
|
| 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#L2468 |
|
| 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#L2693 |
|
| 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#L2845 |
|
| 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#L3046 |
|
| 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#L3063 |
|
| 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#L3075 |
|
| 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#L3097 |
|
| 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#L3487 |
️️✔️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.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/d35fb5f90a7fdae0ea6545cef6f41a5f80744195/specification/healthcareapis/resource-manager/readme.md#tag-package-2022-06">healthcareapis/resource-manager/readme.md#package-2022-06
| Rule | Message |
|---|---|
| "readme":"healthcareapis/resource-manager/readme.md", "tag":"package-2022-06", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
|
| "readme":"healthcareapis/resource-manager/readme.md", "tag":"package-2022-06", "details":"OpenAPI spec has a security definition but autorest security config is defined. Security config from autorest will be used." |
️️✔️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
|
This was referenced Jul 26, 2022
Closed
Closed
|
Hello @jianyexi could you please review this pr? Thanks! |
jianyexi
approved these changes
Aug 9, 2022
|
Hi @jianyexi thanks for approving. Could you help get it merged? It is not a breaking change. |
|
Hi @tongwu-msft could you please review this pr? The change should not be breaking. Thanks! |
|
Hi @jianyexi @tongwu-msft could you help get this pr merged? Thanks! The code changes are not breaking |
|
Hi, @j-zhong-ms. 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 |
ghost
added
|
Hi @jianyexi could you please help merge this pr? Thanks! |
|
Hi, @j-zhong-ms. 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 @jianyexi could you please merge this pr? Thanks! |
|
/azp run |
Generated ApiView
|
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
@akning-ms could you help force merge this PR , as there is a known issue of 'license/cla' |
|
Hi, @j-zhong-ms. 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 |
|
@akning-ms could you help force merge this PR thanks |
This was referenced Nov 11, 2022
anandanthony
pushed a commit
to anandMicro/azure-rest-api-specs
that referenced
this pull request
Dec 16, 2022
kayousef-zz
pushed a commit
to kayousef-zz/azure-rest-api-specs
that referenced
this pull request
Dec 21, 2022
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:
About this Change
APIs will need to start indicating item uniqueness in arrays. By default, uniqueness is the string property called "id" of items in an array. When that property does not exist, the x-ms-identifiers extension property must be used to specify the identifying property(s) or lack thereof. This pull request is my best guess effort to ease resource providers into the new requirement before it becomes enforced. Compliance and accuracy will need to be owned and maintained by the resource provider going forward.
See https://github.com/Azure/autorest/tree/main/docs/extensions#x-ms-identifiers.
You can also make changes after this PR is checked in. At this point, this annotation is only used by Change Analysis for change computation, so making changes afterwards shouldn’t be a breaking change.
2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- [ ] SDK of .NET (need service team to ensure code readiness)
- [ ] SDK of Python
- [ ] SDK of Java
- [ ] SDK of Js
- [ ] SDK of Go
- [ ] PowerShell
- [ ] CLI
- [ ] Terraform
- [x] No refresh required for updates in this PR
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.