[Azure Event Grid] API Review

[azure-sdk]

New API Review meeting has been requested.

Service Name: Azure Event Grid
Review Created By: Javier Fernandez @jfggdl
Review Date: 1/10/2023 1:00 PM PT
PR:
Hero Scenarios Link: Not Provided
Core Concepts Doc Link: Not Provided

Description: Event Grid has new APIs to publish and pull (client connects to EG) events. We are planning to have a swagger for a first review during the meeting.

Detailed meeting information and documents provided can be accessed here
For more information that will help prepare you for this review, the requirements, and office hours, visit the documentation here

[mikekistler]

Minutes of Jan 10 API Review

Link to API Design doc: https://microsoft.sharepoint.com/:w:/t/EventGrid/EQNBCnir-NJEqZucliuTAG0BHVwcbUyD9CkLZwa4BdsV1Q?e=dQeIbE

• Moving to a new model where events have "topics" (string) within a "namespace" (ARM resource).
• Will be added alongside existing Event Grid capability
• "Old" events do not interoperate with "new" events
• The "namespace" will be part of the domain for the service.
• Public preview in 1H23. Will support HTTP. AMQP support will come later.
• All operations are post actions since HTTP verbs do not map well to this event delivery architecture
• We don't want to send or receive bare arrays in request/response bodies
  • But this is the cloud event standard. And we want to adhere to this (including the content-type).
  • But use an object for request/response bodies not defined by Cloud Events
• There is no expectation of idempotency for these APIs.
• Should you use 429 for too many events in the payload? They don't -- too many events in payload is 413.
• Should include the standard Azure error response body.
• Probably want to drop the "charset=utf-8" from media type
• "locktoken" should be "lockToken" (camel-case)
• "maxEvents" -- use camel-case and query param is fine.

[mikekistler]

@jfggdl Can you please update on your progress to incorporate the feedback above and submit a PR for the REST API?

[jfggdl]

+ Kishore and Balmukund - Javier Sent from Outlook<http://aka.ms/weboutlook>

…

________________________________ From: Mike Kistler ***@***.***> Sent: Monday, February 6, 2023 6:00 AM To: Azure/azure-rest-api-specs ***@***.***> Cc: Javier Fernandez ***@***.***>; Mention ***@***.***> Subject: Re: [Azure/azure-rest-api-specs] [Azure Event Grid] API Review (Issue #21880) @jfggdl<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fjfggdl&data=05%7C01%7Cjafernan%40microsoft.com%7C714da81048bf47fdc7b208db084a76c7%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638112888137432469%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=hWgWFmvHlfBRQlk%2FfktQtMgxl4QDkhjp503LFHh05G8%3D&reserved=0> Can you please update on your progress to incorporate the feedback above and submit a PR for the REST API? — Reply to this email directly, view it on GitHub<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FAzure%2Fazure-rest-api-specs%2Fissues%2F21880%23issuecomment-1419126037&data=05%7C01%7Cjafernan%40microsoft.com%7C714da81048bf47fdc7b208db084a76c7%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638112888137432469%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=31mmCkfkcCnn01G2%2BtZHL23pPlMggI7XuTqEBVfMbGU%3D&reserved=0>, or unsubscribe<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FABWCNSN2CZZNOYFJ7DIYQLDWWD7WXANCNFSM6AAAAAAS5T4ZCI&data=05%7C01%7Cjafernan%40microsoft.com%7C714da81048bf47fdc7b208db084a76c7%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638112888137432469%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=5zbCXdBdNcncYsZnMLO7rcFAuTgAz7LFiZ9B7P%2FcPLw%3D&reserved=0>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[batrived]

@mikekistler We have incorporated all the feedback in our service. We will raise a PR for swagger.

[mikekistler]

@batrived Please link the new PR here when it is ready for review.

[lmazuel]

A new review including the TypeSpec has been scheduled here: #23200