Adding incoming call events to swagger

[osaghaso]

Data Plane API - Pull Request

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your engagement record.

• Link to 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 Open API document (swagger) if applicable, and the root paths that have been updated.}

• Design Document:
• Previous Open API Doc:
• 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

• Azure REST API Guidelines
• OpenAPI Style Guidelines
• Azure Breaking Change Policy

Helpful Links

• Azure DevTools Wiki

[openapi-workflow-bot]

Hi, @osaghaso 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]

Swagger Validation Report

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

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
AzureCommunicationServices.json	2018-01-01(03ab280)	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: 1 Errors, 0 Warnings failed [Detail]

compared tags (via openapi-validator v2.0.1)	new version	base version
package-2018-01	package-2018-01(03ab280)	package-2018-01(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
❌ MissingTypeObject	The schema 'AcsIncomingCallEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L10

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule	Message
❌ MissingTypeObject	The schema 'AcsUserDisconnectedEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L45
❌ MissingTypeObject	The schema 'AcsChatMessageReceivedEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L54
❌ MissingTypeObject	The schema 'AcsChatMessageReceivedInThreadEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L75
❌ MissingTypeObject	The schema 'AcsChatMessageEditedEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L96
❌ MissingTypeObject	The schema 'AcsChatMessageEditedInThreadEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L122
❌ MissingTypeObject	The schema 'AcsChatMessageDeletedEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L148
❌ MissingTypeObject	The schema 'AcsChatMessageDeletedInThreadEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L163
❌ MissingTypeObject	The schema 'AcsChatThreadCreatedWithUserEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L178
❌ MissingTypeObject	The schema 'AcsChatThreadCreatedEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L206
❌ MissingTypeObject	The schema 'AcsChatThreadWithUserDeletedEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L234
❌ MissingTypeObject	The schema 'AcsChatThreadDeletedEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L253
❌ MissingTypeObject	The schema 'AcsChatThreadPropertiesUpdatedPerUserEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L272
❌ MissingTypeObject	The schema 'AcsChatThreadPropertiesUpdatedEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L298
❌ MissingTypeObject	The schema 'AcsChatParticipantAddedToThreadWithUserEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L324
❌ MissingTypeObject	The schema 'AcsChatParticipantRemovedFromThreadWithUserEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L347
❌ MissingTypeObject	The schema 'AcsChatParticipantAddedToThreadEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L370
❌ MissingTypeObject	The schema 'AcsChatParticipantRemovedFromThreadEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L398
❌ MissingTypeObject	The schema 'AcsSmsDeliveryReportReceivedEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L426
❌ MissingTypeObject	The schema 'AcsSmsReceivedEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L460
❌ MissingTypeObject	The schema 'AcsRecordingFileStatusUpdatedEventData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L479
❌ MissingTypeObject	The schema 'AcsChatThreadEventBaseProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L651
❌ MissingTypeObject	The schema 'AcsChatThreadEventInThreadBaseProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L671
❌ MissingTypeObject	The schema 'AcsChatMessageEventBaseProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L691
❌ MissingTypeObject	The schema 'AcsChatMessageEventInThreadBaseProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L727
❌ IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L836
❌ IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L840
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L190
⚠️ AdditionalPropertiesObject	additionalProperties with type object is a common error. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L193
⚠️ PropertyDescription	Property should have a description. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L193
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L218

️❌Avocado: 2 Errors, 0 Warnings failed [Detail]

Rule	Message
❌ UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/cloud-events-schema/incoming_call.json
❌ UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/event-grid-schema/incoming_call.json

️️✔️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-pipeline-app]

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 85b43d5. 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:

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

[openapi-pipeline-app]

Generated ApiView

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