updates

specification/webpubsub/Azure.Messaging.WebPubSub/models.tsp

@@ -1,38 +1,60 @@
-import "@typespec/rest";
 import "@typespec/http";
+import "@typespec/rest";
 import "@azure-tools/typespec-azure-core";
 
-using TypeSpec.Rest;
 using TypeSpec.Http;
+using TypeSpec.Rest;
+using Azure.Core;
 
 namespace Azure.Messaging.WebPubSub;
 
-/** The type of Web PubSub client. */
-union WebPubSubClientType {
-  string,
+/**
+ * Details about the client.
+ */
+model ClientDetail {
+  /** User Id */
+  userId?: string;
 
-  /** Default Web PubSub client type */
-  Default: "Default",
+  /** Roles that the connection with the user id has */
+  roles?: string[];
+}
 
-  /** MQTT Web PubSub client type */
-  MQTT: "MQTT",
+/**
+ * The response object containing the client access token
+ */
+model ClientTokenResponse {
+  /** Access token for the client to connect Azure Web PubSub service */
+  token?: string;
 }
 
-/** Web PubSub permission types. */
-union WebPubSubPermission {
-  string,
+/**
+ * Request object to add connections to groups
+ */
+model AddToGroupsRequest {
+  /** Target groups */
+  groups?: string[];
 
-  /** Permission to send messages to a group */
-  sendToGroup: "sendToGroup",
+  /** Following OData filter syntax to filter out the subscribers receiving the messages */
+  filter?: string;
+}
 
-  /** Permission to join or leave a group */
-  joinLeaveGroup: "joinLeaveGroup",
+/**
+ * Request object to remove connections from groups
+ */
+model RemoveFromGroupsRequest {
+  /** Target groups */
+  groups?: string[];
+
+  /** Following OData filter syntax to filter out the subscribers receiving the messages */
+  filter?: string;
 }
 
 /**
  * Content type for upload
  */
 union ContentType {
+  string,
+
   /**
    * Content Type 'application/json'
    */
@@ -50,107 +72,94 @@ union ContentType {
 }
 
 /**
- * The request object containing targets groups and a connection filter
+ * Content type for HTTP headers in message operations (closed union for HTTP compliance)
  */
-model AddToGroupsRequest {
+// @azure-tools/typespec-azure-core/no-closed-literal-union - Intentionally closed for HTTP Content-Type header compliance
+union MessageContentType {
   /**
-   * A list of groups which target connections will be added into
+   * Content Type 'application/json'
    */
-  groups?: string[];
+  "application/json",
 
   /**
-   * An OData filter which target connections satisfy
+   * Content Type 'application/octet-stream'
    */
-  filter?: string;
+  "application/octet-stream",
+
+  /**
+   * Content Type 'text/plain'
+   */
+  "text/plain",
 }
 
 /**
- * The error object.
+ * Content type for response headers (closed union for HTTP compliance)
  */
-@error
-model ErrorDetail {
+// @azure-tools/typespec-azure-core/no-closed-literal-union - Intentionally closed for HTTP Content-Type header compliance
+union ResponseContentType {
   /**
-   * One of a server-defined set of error codes.
+   * Content Type 'application/json'
    */
-  code?: string;
+  "application/json",
 
   /**
-   * A human-readable representation of the error.
+   * Content Type 'text/json'
    */
-  message?: string;
+  "text/json",
+}
 
-  /**
-   * The target of the error.
-   */
-  target?: string;
+/**
+ * Group member
+ */
+model GroupMember {
+  /** User Id */
+  userId?: string;
+}
 
-  /**
-   * An array of details about specific errors that led to this reported error.
-   */
-  details?: ErrorDetail[];
+/**
+ * Paged response for group members
+ */
+model GroupMemberPagedValues {
+  /** The group members */
+  value?: GroupMember[];
 
-  /**
-   * Detailed error
-   */
-  inner?: InnerError;
+  /** The link to the next page of results */
+  nextLink?: string;
 }
 
 /**
- * Detailed error
+ * Error detail information.
  */
 model InnerError {
-  /**
-   * A more specific error code than was provided by the containing error.
-   */
+  /** Error code. */
   code?: string;
 
-  /**
-   * Detailed error
-   */
-  inner?: InnerError;
+  /** Error message. */
+  message?: string;
 }
 
 /**
- * The response object containing the token for the client
+ * Web PubSub permission
  */
-model ClientTokenResponse {
-  /**
-   * The token value for the WebSocket client to connect to the service
-   */
-  token?: string;
-}
+union WebPubSubPermission {
+  string,
 
-/**
- * The request object containing targets groups and a connection filter
- */
-model RemoveFromGroupsRequest {
-  /**
-   * A list of groups which target connections will be removed from
-   */
-  groups?: string[];
+  /** The permission to send messages to groups. */
+  SendToGroup: "sendToGroup",
 
-  /**
-   * An OData filter which target connections satisfy
-   */
-  filter?: string;
+  /** The permission to join/leave groups. */
+  JoinLeaveGroup: "joinLeaveGroup",
 }
 
 /**
- * Represents a page of elements as a LIST REST API result.
+ * Web PubSub client type
  */
-model GroupMemberPagedValues is Azure.Core.Page<GroupMember>;
+union WebPubSubClientType {
+  string,
 
-/**
- * Represents a member in a group.
- */
-model GroupMember {
-  /**
-   * A unique identifier of a connection.
-   */
-  connectionId: string;
+  /** Default value. */
+  Default: "Default",
 
-  /**
-   * The user ID of the connection. A user can have multiple connections.
-   */
-  userId?: string;
+  /** MQTT client. */
+  MQTT: "mqtt",
 }

specification/webpubsub/Azure.Messaging.WebPubSub/routes.tsp

@@ -126,8 +126,8 @@ interface WebPubSubOperationGroup {
       clientType?: WebPubSubClientType = WebPubSubClientType.Default;
     },
     ClientTokenResponse & {
-      @header
-      contentType: "application/json" | "text/json";
+      @header("content-type")
+      contentType: ResponseContentType;
     }
   >;
 
@@ -199,8 +199,8 @@ interface WebPubSubOperationGroup {
       /**
        * Upload file type
        */
-      @header
-      `content-type`: ContentType;
+      @header("content-type")
+      contentType: MessageContentType;
 
       /**
        * The payload body.
@@ -306,8 +306,8 @@ interface WebPubSubOperationGroup {
       /**
        * Upload file type
        */
-      @header
-      `content-type`: ContentType;
+      @header("content-type")
+      contentType: MessageContentType;
 
       /**
        * The payload body.
@@ -464,8 +464,8 @@ interface WebPubSubOperationGroup {
       /**
        * Upload file type
        */
-      @header
-      `content-type`: ContentType;
+      @header("content-type")
+      contentType: MessageContentType;
 
       /**
        * The payload body.
@@ -830,8 +830,8 @@ interface WebPubSubOperationGroup {
       /**
        * Upload file type
        */
-      @header
-      `content-type`: ContentType;
+      @header("content-type")
+      contentType: MessageContentType;
 
       /**
        * The payload body.