Class AsyncApiChannelOptions

Namespace: Ratatoskr.AsyncApi.Config

Assembly: Ratatoskr.dll

AsyncAPI documentation options for a channel. Configure via .WithAsyncApi(x => x.WithDescription("...")) on a ChannelBuilder.

public class AsyncApiChannelOptions

Inheritance: object

AsyncApiChannelOptions

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Description: Optional detailed description of the channel.

Operation: When set, all messages on this channel are grouped into a single operation. When not set, each message gets its own operation (default).

Summary: Optional short summary of the channel.

Title: Optional title for the channel in the AsyncAPI document.

Methods

WithDescription(string): Sets the channel description and returns this instance for chaining.

WithOperation(Action<AsyncApiOperationOptions>): Configures a channel-level operation, grouping all messages into one operation. The operationId defaults to the channel name unless overridden with WithId().

WithSummary(string): Sets the channel summary and returns this instance for chaining.

WithTitle(string): Sets the channel title and returns this instance for chaining.

Edit this page