Event Grid MQTT System events

[JoshLove-msft]

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):

• 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:

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.

❔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-pipeline-app]

Next Steps to Merge

⚠️ This is an experimental comment. It may not always be up-to-date. ⚠️

Next steps that must be taken to merge this PR:

• ❌ The required check named Swagger PrettierCheck has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.
• ❌ The required check named Swagger SpellCheck has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.

[openapi-pipeline-app]

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
SystemEvents.json	2018-01-01(79cf385)	2018-01-01(main)

Rule

Message

❌ Runtime Exception

"new":"https://github.com/Azure/azure-rest-api-specs/blob/79cf38508fdf2f287ae2094b92498b1d4d26a5f8/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json", "details":"Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.57/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=/mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp\nERROR: Schema violation: Additional properties not allowed: ?overload=customEvent, ?overload=cloudEvent, ?overload=EventGridEvent\n - file:///mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json:33:2 ($["x-ms-paths"])\nFATAL: swagger-document/individual/schema-validator - FAILED\nFATAL: Error: [OperationAbortedException] Error occurred. Exiting.\nProcess() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting.\n"

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

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 5 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.4)	new version	base version
package-2023-06-01-preview	package-2023-06-01-preview(79cf385)	package-2023-06-01-preview(main)

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

Rule	Message	Related RPC [For API reviewers]
⚠️ SchemaNamesConvention	Schema name should be Pascal case. Location: Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json#L47
⚠️ SchemaNamesConvention	Schema name should be Pascal case. Location: Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json#L95
⚠️ SchemaNamesConvention	Schema name should be Pascal case. Location: Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json#L113
⚠️ SchemaNamesConvention	Schema name should be Pascal case. Location: Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json#L141
⚠️ SchemaNamesConvention	Schema name should be Pascal case. Location: Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json#L236

The following errors/warnings exist before current PR submission:

Rule	Message
❌ XmsPathsMustOverloadPaths	Paths in x-ms-paths must overload a normal path in the paths section, i.e. a path in the x-ms-paths must either be same as a path in the paths section or a path in the paths sections followed by additional parameters. Location: Microsoft.EventGrid/stable/2018-01-01/EventGrid.json#L34
❌ XmsPathsMustOverloadPaths	Paths in x-ms-paths must overload a normal path in the paths section, i.e. a path in the x-ms-paths must either be same as a path in the paths section or a path in the paths sections followed by additional parameters. Location: Microsoft.EventGrid/stable/2018-01-01/EventGrid.json#L73
❌ XmsPathsMustOverloadPaths	Paths in x-ms-paths must overload a normal path in the paths section, i.e. a path in the x-ms-paths must either be same as a path in the paths section or a path in the paths sections followed by additional parameters. Location: Microsoft.EventGrid/stable/2018-01-01/EventGrid.json#L118
❌ XmsParameterLocation	The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.EventGrid/stable/2018-01-01/EventGrid.json#L268
⚠️ MsPaths	Don't use x-ms-paths except where necessary to support legacy APIs. Location: Microsoft.EventGrid/stable/2018-01-01/EventGrid.json#L33
⚠️ AdditionalPropertiesAndProperties	Don't specify additionalProperties as a sibling of properties. Location: Microsoft.EventGrid/stable/2018-01-01/EventGrid.json#L91
⚠️ AdditionalPropertiesAndProperties	Don't specify additionalProperties as a sibling of properties. Location: Microsoft.EventGrid/stable/2018-01-01/EventGrid.json#L260

️️✔️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: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
❌ HowToFix	Code style issues found path: Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json

️❌SpellCheck: 4 Errors, 0 Warnings failed [Detail]

Rule	Message
❌ HowToFix	Unknown word (clientsession), please fix the error or add words to ./custom-words.txt path: Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json#L134:51
❌ HowToFix	Unknown word (clientsession), please fix the error or add words to ./custom-words.txt path: Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json#L137:49
❌ HowToFix	Unknown word (clientsession), please fix the error or add words to ./custom-words.txt path: Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json#L229:51
❌ HowToFix	Unknown word (clientsession), please fix the error or add words to ./custom-words.txt path: Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json#L232:49

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

Swagger Generation Artifacts

️🔄ApiDocPreview inProgress [Detail]

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

Breaking Changes Tracking

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

• ️✔️Succeeded [Logs]Release - Generate from 263caed. 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.18.0-alpha.20230905.1.nupkg

  info	[Changelog]

_{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/5156b6a9bbcf47e0b6a15b78ccf5d999

[openapi-pipeline-app]

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