User/osaghaso/adding router job by osaghaso · Pull Request #24153 · Azure/azure-rest-api-specs

osaghaso · 2023-05-24T21:10:45Z

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 API Spec engagement record.

Link to API Spec engagement record issue:

Is this review for (select one):
link to Schema

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:
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-05-24T21:10:48Z

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-05-24T21:10:51Z

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(02e9ba1)	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: 2 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.6)	new version	base version
package-2023-06-01-preview	package-2023-06-01-preview(02e9ba1)	package-2023-06-01-preview(main)

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

Rule	Message	Related RPC [For API reviewers]
⚠️ 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: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L343
⚠️ 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: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L467

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L1688
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L1692
⚠️ AdditionalPropertiesObject	additionalProperties with type object is a common error. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L963
⚠️ PropertyDescription	Property should have a description. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L963
⚠️ AdditionalPropertiesObject	additionalProperties with type object is a common error. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L992
⚠️ PropertyDescription	Property should have a description. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L992
⚠️ AdditionalPropertiesObject	additionalProperties with type object is a common error. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L1066
⚠️ PropertyDescription	Property should have a description. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L1066
⚠️ AdditionalPropertiesObject	additionalProperties with type object is a common error. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L1093
⚠️ PropertyDescription	Property should have a description. Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L1093

️️✔️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 · 2023-05-24T21:10:52Z

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 succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from c280892. 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

️✔️Azure.Messaging.EventGrid [View full logs] [Release SDK Changes]
- Azure.Messaging.EventGrid.4.19.0-alpha.20231006.1.nupkg
```
info	[Changelog]
```

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

openapi-pipeline-app · 2023-05-24T21:10:53Z

Generated ApiView

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

openapi-workflow-bot · 2023-05-24T21:48:21Z

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.

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json

JoshLove-msft · 2023-09-28T21:21:13Z

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json

+        }
+      ],
+      "properties": {
+        "queueInfo": {


Can this still be renamed? If so we should use queueDetails. If not we can add "x-ms-client-name" and set it to queueDetails.

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json

heaths · 2023-10-06T17:53:34Z

There are conflicts from preventing this from being merged, and since this is going to main, that means it's ready for a final review. Have you scheduled a review with the REST API Stewardship Board? Otherwise, if it's a work in progress, you should use a feature branch. See https://eng.ms/docs/products/azure-developer-experience/onboard/requirements.

JoshLove-msft · 2023-10-06T17:55:50Z

There are conflicts from preventing this from being merged, and since this is going to main, that means it's ready for a final review. Have you scheduled a review with the REST API Stewardship Board? Otherwise, if it's a work in progress, you should use a feature branch. See https://eng.ms/docs/products/azure-developer-experience/onboard/requirements.

These events have already been reviewed by the arch board - they don't go through a REST API review.

package-lock.json

openapi-pipeline-app · 2023-10-06T23:09:13Z

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

osaghaso added 2 commits May 24, 2023 13:47

Adding Job router to EG SDK

ff55a39

Adding Job router to EG SDK

14b24ee

osaghaso requested review from Kishp01 and ahamad-MS as code owners May 24, 2023 21:10

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

ghost added the Event Grid label May 24, 2023

azure-sdk mentioned this pull request May 24, 2023

[AutoPR Azure.Messaging.EventGrid] User/osaghaso/adding router job azure-sdk/azure-sdk-for-net#3998

Closed

Adding examples

fc65f88

AzureRestAPISpecReview added CI-FixRequiredOnFailure data-plane labels May 24, 2023

Adding examples

1858dae

JoshLove-msft reviewed May 24, 2023

View reviewed changes

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json Show resolved Hide resolved

JoshLove-msft reviewed May 24, 2023

View reviewed changes

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json Show resolved Hide resolved

JoshLove-msft reviewed May 24, 2023

View reviewed changes

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json Show resolved Hide resolved

JoshLove-msft reviewed May 24, 2023

View reviewed changes

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json Outdated Show resolved Hide resolved

JoshLove-msft reviewed May 24, 2023

View reviewed changes

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json Show resolved Hide resolved

JoshLove-msft mentioned this pull request May 26, 2023

Azure SDK Review - [Azure SDK] Azure/azure-sdk#5985

Closed

JoshLove-msft reviewed May 26, 2023

View reviewed changes

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json Outdated Show resolved Hide resolved

JoshLove-msft reviewed May 26, 2023

View reviewed changes

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json Outdated Show resolved Hide resolved

osaghaso added 2 commits May 26, 2023 13:50

Adding examples

29c9ac4

Adding Job router to EG SDK

1fbbebb

JoshLove-msft reviewed May 30, 2023

View reviewed changes

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json Outdated Show resolved Hide resolved

osaghaso added 2 commits May 30, 2023 12:52

adding x-ms-enum to dispostionCode

15e25e5

adding x-ms-enum to dispostionCode

d12b667

JoshLove-msft reviewed May 30, 2023

View reviewed changes

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json Show resolved Hide resolved

osaghaso added 2 commits September 27, 2023 17:17

addressing feedback from SDK Review

b97bd38

adding the disposition code comments

1c8f698

JoshLove-msft reviewed Sep 28, 2023

View reviewed changes

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json Outdated Show resolved Hide resolved

osaghaso added 3 commits September 28, 2023 14:53

addressing comments

06557e6

addressing comments

3531de9

addressing comments

04b8677

JoshLove-msft reviewed Oct 3, 2023

View reviewed changes

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json Outdated Show resolved Hide resolved

addressing comments

9d81545

JoshLove-msft reviewed Oct 3, 2023

View reviewed changes

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json Show resolved Hide resolved

addressing comments

6c1e015

JoshLove-msft reviewed Oct 3, 2023

View reviewed changes

...entgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json Outdated Show resolved Hide resolved

osaghaso added 4 commits October 5, 2023 09:12

addressing comments

e2d3c56

addressing comments

08ac2c7

addressing comments

1f6c7e6

addressing comments

ea4a9fb

JoshLove-msft approved these changes Oct 6, 2023

View reviewed changes

jsquire approved these changes Oct 6, 2023

View reviewed changes

JoshLove-msft reviewed Oct 6, 2023

View reviewed changes

package-lock.json Outdated Show resolved Hide resolved

osaghaso added 7 commits October 6, 2023 11:58

reference examples

d1992a1

reference examples

3b0a69f

reference examples

ada294c

running prettier

62cd056

running prettier

ad70273

running prettier

1097f1c

running prettier

02e9ba1

azure-sdk mentioned this pull request Oct 6, 2023

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

Closed

Conversation

osaghaso commented May 24, 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 May 24, 2023

Uh oh!

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

Uh oh!

Generated ApiView

Uh oh!

openapi-workflow-bot bot commented May 24, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JoshLove-msft Sep 28, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

heaths commented Oct 6, 2023

Uh oh!

JoshLove-msft commented Oct 6, 2023

Uh oh!

Uh oh!

openapi-pipeline-app bot commented Oct 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

openapi-pipeline-app bot commented May 24, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 24, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 24, 2023 •

edited

Loading