EventGridv2 TypeSpec Api Preview

specification/eventgrid/typespec/main.tsp

@@ -0,0 +1,227 @@
+import "@typespec/http";
+import "@typespec/rest";
+import "@typespec/versioning";
+import "@azure-tools/typespec-autorest";
+import "@azure-tools/typespec-azure-core";
+
+enum ServiceApiVersions {
+  v2022_05_01: "2023-06-01-preview"
+}
+
+@useAuth(
+  ApiKeyAuth<ApiKeyLocation.header, "aeg-sas-key"> | OAuth2Auth<[{
+    type: OAuth2FlowType.implicit,
+    authorizationUrl: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize",
+    scopes: ["https://eventgrid.azure.net/.default"],
+  }]>
+)
+
+@service({
+  title: "AzureMessagingEventGridClient",
+  version: "2023-06-01-preview"
+})
+
+//
+// Supported operations.
+//
+// POST https://{namespaceName}.{region}.eventgrid.azure.net/topics/{topicName}:publish?api-version={apiVersion}}
+// POST https://{namespaceName}.{region}.eventgrid.azure.net/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:receive?api-Version={apiVersion}&timeout=60&maxEvents={maxEvents}
+// POST https://{namespaceName}.{region}.eventgrid.azure.net/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:acknowledge?api-Version={apiVersion}
+// POST https://{namespaceName}.{region}.eventgrid.azure.net/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:release?api-version={apiVersion}
+//
+
+@server(
+  "{endpoint}",
+  "The host name of the topic",
+  {
+    @doc("The host name of the namespace, e.g. namespaceName1.westus-1.eventgrid.azure.net")
+    endpoint: url,
+  }
+)
+
+@doc("Azure Messaging EventGrid Client")
+@versioned(ServiceApiVersions)
+namespace AzureMessagingEventGrid {
+  using TypeSpec.Http;
+  using TypeSpec.Rest;
+  using TypeSpec.Versioning;
+  using Azure.Core;
+  using Azure.Core.Foundations;
+
+  @doc("Properties of an event published to an Azure Messaging EventGrid Namespace topic using the CloudEvent 1.0 Schema.")
+  model CloudEventEvent {
+    @doc("An identifier for the event. The combination of id and source must be unique for each distinct event.")
+    id: string;
+
+    @doc("Identifies the context in which an event happened. The combination of id and source must be unique for each distinct event.")
+    source: string;
+
+    @doc("Event data specific to the event type.")
+    data?: object;
+
+    @doc("Type of event related to the originating occurrence.")
+    type: string;
+
+    @doc("The time (in UTC) the event was generated, in RFC3339 format.")
+    time?: zonedDateTime;
+
+    @doc("The version of the CloudEvents specification which the event uses.")
+    specVersion: string;
+
+    @doc("Identifies the schema that data adheres to.")
+    dataSchema?: string;
+
+    @doc("Content type of data value.")
+    dataContentType?: string;
+
+    @doc("This describes the subject of the event in the context of the event producer (identified by source).")
+    subject?: string;
+  }
+
+  @doc("LockToken information.")
+  model LockToken {
+    @doc("The token used to lock the event.")
+    lockToken: string;
+  }
+
+  @doc("Properties of the Event Broker operation.")
+  model BrokerProperties {
+    @doc("The token used to lock the event.")
+    lockToken: LockToken;
+  }
+
+  @doc("Receive operation details per Cloud Event.") 
+  model ReceiveDetails {
+    @doc("The Event Broker details.")
+    brokerProperties: BrokerProperties;
+
+    @doc("Cloud Event details.")
+    event: CloudEventEvent;
+  }
+
+  @doc("Details of the Receive operation response.")
+  model ReceiveResponse {
+    @doc("Array of receive responses, one per cloud event.")
+    value: ReceiveDetails[];
+  }
+
+  @doc("Failed LockToken information.")
+  model FailedLockToken {
+    @doc("LockToken value")
+    lockToken: LockToken;
+
+    @doc("Error code")
+    errorCode: int32;
+
+    @doc("Description of the error")
+    errorDescription: string; 
+  }
+
+  @doc("Details of the LockTokens information. This is used for both Acknowledge and Release operation response.")
+  model LockTokensResponse {
+    @doc("Array of LockToken values for failed cloud events.")
+    failedLockTokens: FailedLockToken[];
+
+    @doc("Array of LockToken values for succeeded cloud events.")
+    succeededLockTokens: string[];
+  }
+
+  // POST https://{namespaceName}.{region}.eventgrid.azure.net/topics/{topicName}:publish?api-version={apiVersion}}
+
+  @doc("Publish Single Cloud Event to namespace topic.")
+  @route("/topics/{topicName}:publish", {shared: true})
+  @post op PublishCloudEvent is Azure.Core.RpcOperation<{
+    @doc("content type")
+    @header("content-type")
+    contentType: "application/cloudevents+json; charset=utf-8";
+
+    @doc("Topic Name.")
+    @path
+    topicName: string;
+
+    @doc("Single Cloud Event being published.")
+    @body 
+    event: CloudEventEvent;
+  }, {} >;
+
+
+  @doc("Publish Batch of Cloud Events to namespace topic.")
+  @route("/topics/{topicName}:publish", {shared: true})
+  @post op PublishBatchOfCloudEvents is Azure.Core.RpcOperation<{
+    @doc("content type")
+    @header("content-type")
+    contentType: "application/cloudevents-batch+json; charset=utf-8";
+
+    @doc("Topic Name.")
+    @path
+    topicName: string;
+
+    @doc("Array of Cloud Events being published.")
+    @body
+    events: CloudEventEvent[];
+  }, {} >;
+
+  @doc("Receive Batch of Cloud Events from the Event Subscription.")
+  @route("/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:receive")
+  @post op ReceiveBatchOfCloudEvents is Azure.Core.RpcOperation<{
+    @doc("Topic Name.")
+    @path
+    topicName: string;
+
+    @doc("Event Subscription Name.")
+    @path
+    eventSubscriptionName: string;
+
+    @doc("Max Events count to be received.")
+    @query
+    maxEvents: int32;
+
+    @doc("Timeout value for receive operation in Seconds. Default is 60 seconds.")
+    @query
+    timeout: int32;
+  }, ReceiveResponse >;
+
+  // POST https://{namespaceName}.{region}.eventgrid.azure.net/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:acknowledge&apiVersion={apiVersion}
+
+  @doc("Acknowledge Cloud Events.")
+  @route("/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:acknowledge")
+  @post op AcknowledgeBatchOfCloudEvents is Azure.Core.RpcOperation<{
+    @doc("content type")
+    @header("content-type")
+    contentType: "application/json; charset=utf-8";
+
+    @doc("Topic Name.")
+    @path
+    topicName: string;
+
+    @doc("Event Subscription Name.")
+    @path
+    eventSubscriptionName: string;
+
+    @doc("Array of LockTokens for the corresponding received Cloud Events to be acknowledged.")
+    @body
+    lockTokens: string[];
+  }, LockTokensResponse >;
+
+  // POST https://{namespaceName}.{region}.eventgrid.azure.net/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:release?api-version={apiVersion}
+
+  @doc("Release Cloud Events.")
+  @route("/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:release")
+  @post op ReleaseBatchOfCloudEvents is Azure.Core.RpcOperation<{
+    @doc("content type")
+    @header("content-type")
+    contentType: "application/json; charset=utf-8";
+
+    @doc("Topic Name.")
+    @path
+    topicName: string;
+
+    @doc("Event Subscription Name.")
+    @path
+    eventSubscriptionName: string;
+
+    @doc("Array of LockTokens for the corresponding received Cloud Events to be acknowledged.")
+    @body    
+    tokens : LockToken[];
+  }, LockTokensResponse >;
+}