EventGrid - AzureHealthcareApis swagger update for GA by arunmk-ms · Pull Request #23592 · Azure/azure-rest-api-specs

arunmk-ms · 2023-04-17T22:35:26Z

Data Plane API - Pull Request

Add new event types for the DICOM service to healthcareapis eventgrid schema.

API Info: The Basics

The DICOM service is a child service of a Healthcare Data Services workspace, similar to a FHIR service which is sending the existing event types.
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

Link to API Spec engagement record issue:

Is this review for (select one):

a private preview
a public preview
GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.}

Design Document:
Previous API Spec Doc: https://microsofthealth.visualstudio.com/Health/_git/health-paas-docs?path=/specs/DICOM/DICOMevents.md&_a=preview
Updated paths:

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

💬 Teams Channel
💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting
Open API Hub

Guidelines & Specifications

Helpful Links

Azure DevTools Wiki

openapi-pipeline-app · 2023-04-17T22:35:31Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
HealthcareApis.json	2018-01-01(44226a1)	2018-01-01(main)

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

compared tags (via openapi-validator v2.0.0)	new version	base version
package-2018-01	package-2018-01(44226a1)	package-2018-01(main)

️️✔️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.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView 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).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2023-04-17T22:35:31Z

Hi, @arunmk-ms Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

openapi-pipeline-app · 2023-04-17T22:35:32Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️❌ azure-sdk-for-net-track2 failed [Detail]

❌Failed [Logs]Release - Generate from e8e7765. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:712
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 712 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to build sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m

❌Azure.Messaging.EventGrid [View full logs] [Release SDK Changes] Breaking Change Detected

Azure.Messaging.EventGrid.4.16.0-alpha.20230505.1.nupkg

info	[Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public Azure.Messaging.EventGrid.SystemEvents.HealthcareDicomImageDeletedEventData Azure.Messaging.EventGrid.EventGridModelFactory.HealthcareDicomImageDeletedEventData(System.String, System.String, System.String, System.String, System.Nullable<System.Int64>)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/eventgrid/Azure.Messaging.EventGrid/src/Azure.Messaging.EventGrid.csproj::TargetFramework=netstandard2.0],
info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.Messaging.EventGrid/Debug/netstandard2.0/Azure.Messaging.EventGrid.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/eventgrid/Azure.Messaging.EventGrid/src/Azure.Messaging.EventGrid.csproj::TargetFramework=netstandard2.0]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-04-17T22:35:32Z

Generated ApiView

Language	Package Name	ApiView Link
.Net	Azure.Messaging.EventGrid	https://apiview.dev/Assemblies/Review/2eb76301963440c7897d2c69f24f9df0

...osoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_created.json

JoshLove-msft

LGTM @lmazuel can you please merge?

Update swagger for Dicom update events

693f4d2

AzureRestAPISpecReview added the data-plane label Apr 17, 2023

azure-sdk mentioned this pull request Apr 17, 2023

[AutoPR Azure.Messaging.EventGrid] EventGrid - AzureHealthcareApis swagger update for GA azure-sdk/azure-sdk-for-net#3589

Closed

Added partition to Dicom events

d3e6a11

jnlycklama reviewed Apr 27, 2023

View reviewed changes

...osoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_created.json Outdated Show resolved Hide resolved

arunmk-ms added 2 commits May 2, 2023 13:34

Added partition to subject

ba8e531

Renamed partition name to default

44226a1

arunmk-ms marked this pull request as ready for review May 2, 2023 21:32

arunmk-ms requested review from Kishp01 and ahamad-MS as code owners May 2, 2023 21:32

openapi-assignment-bot bot assigned lmazuel May 2, 2023

JoshLove-msft approved these changes May 4, 2023

View reviewed changes

lmazuel merged commit e8e7765 into Azure:main May 5, 2023

azure-sdk mentioned this pull request May 5, 2023

[ReleasePR Azure.Messaging.EventGrid] change the event type of tags from string to object Azure/azure-sdk-for-net#28153

Closed

arunmk-ms deleted the healthcareapis/dicomupdate-swagger branch May 12, 2023 18:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

EventGrid - AzureHealthcareApis swagger update for GA#23592

EventGrid - AzureHealthcareApis swagger update for GA#23592
lmazuel merged 4 commits intoAzure:mainfrom
arunmk-ms:healthcareapis/dicomupdate-swagger

arunmk-ms commented Apr 17, 2023 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Apr 17, 2023 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Apr 17, 2023

Uh oh!

openapi-pipeline-app bot commented Apr 17, 2023 •

edited

Loading

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app bot commented Apr 17, 2023 •

edited

Loading

Uh oh!

Uh oh!

JoshLove-msft left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Comments

Conversation

arunmk-ms commented Apr 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Data Plane API - Pull Request

API Info: The Basics

Change Scope

❔Got questions? Need additional info?? We are here to help!

Tooling

Guidelines & Specifications

Helpful Links

Uh oh!

openapi-pipeline-app bot commented Apr 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-workflow-bot bot commented Apr 17, 2023

Uh oh!

openapi-pipeline-app bot commented Apr 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app bot commented Apr 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

Uh oh!

JoshLove-msft left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

arunmk-ms commented Apr 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 17, 2023 •

edited

Loading