add incomingcall event swagger by osaghaso · Pull Request #22286 · Azure/azure-rest-api-specs

osaghaso · 2023-01-23T19:55:11Z

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

Helpful Links

Azure DevTools Wiki

openapi-workflow-bot · 2023-01-23T19:55:14Z

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 · 2023-01-23T19:55:17Z

Swagger Validation Report

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

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
common.json	2022-07-13(8ad4590)	2022-07-13(main)
AzureCommunicationServices.json	2018-01-01(8ad4590)	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.0)	new version	base version
package-2022-07-13-stable	package-2022-07-13-stable(8ad4590)	package-2022-07-13-stable(main)
package-2018-01	package-2018-01(8ad4590)	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 'CallingCommunicationIdentifierModel' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Common/stable/2022-07-13/common.json#L87

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#L36
`❌` 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#L45
`❌` 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#L66
`❌` 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#L87
`❌` 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#L113
`❌` 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#L139
`❌` 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#L154
`❌` 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#L169
`❌` 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#L197
`❌` 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#L225
`❌` 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#L244
`❌` 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#L263
`❌` 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#L289
`❌` 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#L315
`❌` 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#L338
`❌` 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#L361
`❌` 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#L389
`❌` 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#L417
`❌` 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#L451
`❌` 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#L470
`❌` 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#L531
`❌` 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#L551
`❌` 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#L571
`❌` 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#L607
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L716
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L720
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Common/stable/2022-07-13/common.json#L174
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L181
⚠️ AdditionalPropertiesObject	additionalProperties with type object is a common error. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L184
⚠️ PropertyDescription	Property should have a description. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L184

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

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

️️✔️~[Staging] CadlAPIView 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.

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

Validation passes for Summary.

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

openapi-pipeline-app · 2023-01-23T19:55:18Z

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] Generate from 4593a5fa85e3fac4e42c2314d7bf6b4354f0d0bf. 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
warn		specification/communication/data-plane/Common/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
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:672
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 672 | �[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 generate sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:760
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 760 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mit does not exist.
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 672 | �[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 generate sdk artifact
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m

❌Azure.Messaging.EventGrid [View full logs] [Preview SDK Changes]
```
info	[Changelog]
```

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

openapi-pipeline-app · 2023-01-23T19:55:20Z

Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

openapi-workflow-bot · 2023-01-23T20:03:35Z

Hi @osaghaso, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

…omingcall_swagger

This reverts commit 82b4ab3.

JoshLove-msft · 2023-02-01T22:31:11Z

package.json

    "tsc": "tsc",
    "multiapi": "ts-node ./scripts/multiapi.ts"
+  },
+  "dependencies": {


This should not be changed.

JoshLove-msft · 2023-02-01T22:31:23Z

package-lock.json

      "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==",
      "dev": true
    },
+    "autorest": {


I think we need to revert this.

JoshLove-msft · 2023-02-06T05:41:37Z

specification/communication/data-plane/Common/stable/2022-07-13/common.json

        "modelAsString": true
      }
    },
+    "CallingCommunicationIdentifierModel": {


Do we need the Model suffix?

I'll note this does seem to match the existing convention used in CommunicationIdentifierModel, CommunicationUserIdentifierModel, etc.

This is missing the "type" property.

JoshLove-msft · 2023-02-06T05:41:54Z

specification/communication/data-plane/Common/stable/2022-07-13/common.json

+        }
+      }
+    },
+    "UnknownIdentifierModel": {


Same question about whether we need Model suffix

JoshLove-msft · 2023-02-07T02:50:12Z

Can you please combine the changes from this PR with #22272 and put them all in one PR? It will make it easier for us to generate API views and the changes are impacting the same swagger.

osaghaso · 2023-02-07T16:29:15Z

We Closing this on pr for now as the service side is still miss a change that, we want to get done before merging.

osaghaso added 3 commits January 11, 2023 15:28

adding incoming call

e76a248

adding incoming call

3df06d9

adding incoming call event to Event grid

0890f5d

osaghaso requested review from a team, Kishp01 and ahamad-MS as code owners January 23, 2023 19:55

osaghaso requested review from BlackRider97 and johanste and removed request for a team January 23, 2023 19:55

openapi-assignment-bot bot assigned lmazuel Jan 23, 2023

ghost added the Event Grid label Jan 23, 2023

AzureRestAPISpecReview added CI-FixRequiredOnFailure data-plane labels Jan 23, 2023

azure-sdk mentioned this pull request Jan 23, 2023

[AutoPR Azure.Messaging.EventGrid] add incomingcall event swagger azure-sdk/azure-sdk-for-net#2500

Closed

osaghaso added 7 commits January 23, 2023 14:04

fixing avocado failure

b061a71

fixing avocado failure

278d374

fixing build failures

dbd9962

fixing build failures

82b4ab3

Merge remote-tracking branch 'origin/main' into user/osaghaso/add_inc…

b5bfa74

…omingcall_swagger

Revert "fixing build failures"

df8ee6a

This reverts commit 82b4ab3.

fixing build failures

8ad4590

JoshLove-msft mentioned this pull request Jan 27, 2023

Board Review: Event Grid System Events Azure/azure-sdk#5447

Closed

JoshLove-msft reviewed Feb 1, 2023

View reviewed changes

JoshLove-msft reviewed Feb 6, 2023

View reviewed changes

osaghaso closed this Feb 7, 2023

Conversation

osaghaso commented Jan 23, 2023

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-workflow-bot bot commented Jan 23, 2023

Uh oh!

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

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented Jan 23, 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 Jan 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openapi-workflow-bot bot commented Jan 23, 2023

Uh oh!

JoshLove-msft Feb 1, 2023

Choose a reason for hiding this comment

Uh oh!

JoshLove-msft Feb 1, 2023

Choose a reason for hiding this comment

Uh oh!

JoshLove-msft Feb 6, 2023

Choose a reason for hiding this comment

Uh oh!

JoshLove-msft Feb 6, 2023

Choose a reason for hiding this comment

Uh oh!

JoshLove-msft Feb 7, 2023

Choose a reason for hiding this comment

Uh oh!

JoshLove-msft Feb 6, 2023

Choose a reason for hiding this comment

Uh oh!

JoshLove-msft commented Feb 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

osaghaso commented Feb 7, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

openapi-pipeline-app bot commented Jan 23, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jan 23, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jan 23, 2023 •

edited

Loading

JoshLove-msft commented Feb 7, 2023 •

edited

Loading