Skip to content
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/2023-09-06 #25583

Conversation

rajithaalurims
Copy link
Contributor

@rajithaalurims rajithaalurims commented Aug 29, 2023

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

Getting help

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 29, 2023

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 29, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 2 Errors, 16 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
healthcare-apis.json 2023-09-06(c3d50e9) 2023-02-28(main)
healthcare-apis.json 2023-09-06(c3d50e9) 2022-10-01-preview(main)

The following breaking changes are detected by comparison with the latest stable version:

Rule Message
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'FhirServiceAccessPolicies' removed or renamed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L2287:3
Old: Microsoft.HealthcareApis/stable/2023-02-28/healthcare-apis.json#L2287:3
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'accessPolicies' renamed or removed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L3765:7
Old: Microsoft.HealthcareApis/stable/2023-02-28/healthcare-apis.json#L3765:7


The following breaking changes are detected by comparison with the latest preview version:

Rule Message
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/analyticsconnectors' removed or restructured?
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2202:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/analyticsconnectors/{analyticsConnectorName}' removed or restructured?
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2247:5
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'FhirServiceAccessPolicies' removed or renamed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L2287:3
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorPatchResource' removed or renamed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L2287:3
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AnalyticsConnector' removed or renamed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L2287:3
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorProperties' removed or renamed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L2287:3
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorDataSource' removed or renamed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L2287:3
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorFhirServiceDataSource' removed or renamed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L2287:3
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorMapping' removed or renamed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L2287:3
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorFhirToParquetMapping' removed or renamed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L2287:3
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorDataDestination' removed or renamed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L2287:3
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorDataLakeDataDestination' removed or renamed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L2287:3
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'subscriptionId' removed or renamed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L4101:3
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L4582:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'apiVersion' removed or renamed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L4101:3
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L4582:3
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'analyticsConnectorName' removed or renamed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L4101:3
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L4582:3
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'accessPolicies' renamed or removed?
New: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L3765:7
Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L4009:7
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.4) new version base version
package-2023-09 package-2023-09(c3d50e9) default(main)

The following errors/warnings exist before current PR submission:

Rule Message
ParametersOrder The parameters:resourceGroupName,dicomServiceName,workspaceName should be kept in the same order as they present in the path.
Location: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L1081
ParametersOrder The parameters:resourceGroupName,dicomServiceName,workspaceName should be kept in the same order as they present in the path.
Location: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L1140
ParametersOrder The parameters:resourceGroupName,iotConnectorName,workspaceName should be kept in the same order as they present in the path.
Location: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L1342
ParametersOrder The parameters:resourceGroupName,iotConnectorName,workspaceName should be kept in the same order as they present in the path.
Location: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L1401
ParametersOrder The parameters:resourceGroupName,fhirServiceName,workspaceName should be kept in the same order as they present in the path.
Location: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L1817
ParametersOrder The parameters:resourceGroupName,fhirServiceName,workspaceName should be kept in the same order as they present in the path.
Location: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L1876
MissingTypeObject The schema 'ServiceAccessPolicyEntry' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L2355
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L2372
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L2440
MissingTypeObject The schema 'ServicesResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L2560
TrackedResourcePatchOperation Tracked resource 'IotFhirDestination' must have patch operation that at least supports the update of tags.
Location: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L3657
⚠️ PageableOperation Based on the response model schema, operation 'PrivateLinkResources_ListByService' might be pageable. Consider adding the x-ms-pageable extension.
Location: Microsoft.HealthcareApis/stable/2023-09-06/healthcare-apis.json#L552
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 29, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

azure-sdk-for-go - sdk/resourcemanager/healthcareapis/armhealthcareapis - Approved - 2.0.0
+	Field `AccessPolicies` of struct `FhirServiceProperties` has been removed
+	Struct `FhirServiceAccessPolicyEntry` has been removed
azure-sdk-for-js - @azure/arm-healthcareapis - Approved - 3.0.0
+	Interface FhirService no longer has parameter accessPolicies
azure-sdk-for-python-track2 - track2_azure-mgmt-healthcareapis - Approved - 1.1.0
+	Model FhirService no longer has parameter access_policies
️🔄 azure-sdk-for-net-track2 inProgress [Detail]
️🔄 azure-sdk-for-python-track2 inProgress [Detail]
️🔄 azure-sdk-for-java inProgress [Detail]
️🔄 azure-sdk-for-go inProgress [Detail]
️🔄 azure-sdk-for-js inProgress [Detail]
️🔄 azure-resource-manager-schemas inProgress [Detail]
️🔄 azure-powershell inProgress [Detail]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 29, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/healthcareapis/armhealthcareapis https://apiview.dev/Assemblies/Review/9e6f60bcf4a4449486c01b0aeae197a4
Java azure-resourcemanager-healthcareapis https://apiview.dev/Assemblies/Review/9643b5c2962f46b2bbc467387ff10cb6
.Net Azure.ResourceManager.HealthcareApis https://apiview.dev/Assemblies/Review/b9fe5e521ddc4bbabebacaeca7d7688b
JavaScript @azure/arm-healthcareapis https://apiview.dev/Assemblies/Review/baeac9e97ccb458bb364b76662c4bb8a

@AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version resource-manager labels Aug 29, 2023
@rajithaalurims rajithaalurims marked this pull request as ready for review August 29, 2023 21:12
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test labels Aug 29, 2023
@openapi-workflow-bot
Copy link

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

@JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Aug 31, 2023
@rajithaalurims rajithaalurims removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Aug 31, 2023
@openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 31, 2023
@Alancere Alancere added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Sep 14, 2023
@rajithaalurims
Copy link
Contributor Author

We are waiting on ARM manifest rollout before merging this PR.

@rajithaalurims
Copy link
Contributor Author

/pr RequestMerge

@zizw123 zizw123 self-assigned this Nov 6, 2023
@zizw123 zizw123 self-requested a review November 6, 2023 18:53
@zizw123 zizw123 merged commit d12a457 into main Nov 6, 2023
28 of 30 checks passed
@zizw123 zizw123 deleted the rajithaalurims-healthcareapis-Microsoft.HealthcareApis-2023-09-06-b1 branch November 6, 2023 18:54
Copy link

Swagger pipeline restarted successfully, please wait for status update in this comment.

jnlycklama pushed a commit that referenced this pull request Nov 8, 2023
zman-ms pushed a commit that referenced this pull request Jan 10, 2024
…rsion stable/2023-09-06 (#25583)

* Adds base for updating Microsoft.HealthcareApis from version stable/2023-02-28 to version 2023-09-06

* Updates readme

* Updates API version in new specs and examples

* accessPolicies removed from schema
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-JavaScript Approved-SdkBreakingChange-Python ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants