Class AsyncApiMessageOptions

Namespace: Ratatoskr.AsyncApi.Config

Assembly: Ratatoskr.dll

AsyncAPI documentation options for a message registration. Configure via .WithAsyncApi(x => x.WithVersion("1.0.0")) on a MessageBuilder.

public class AsyncApiMessageOptions

Inheritance: object

AsyncApiMessageOptions

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 message.

Operation: Operation options for this specific message. Only applies when the channel does not have a channel-level operation configured (per-message mode). Messages sharing the same operationId are merged into a single operation.

Summary: Optional short summary of the message.

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

Version: EventCatalog message version (x-eventcatalog-message-version). Defaults to "1.0.0" if not specified.

Methods

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

WithOperation(Action<AsyncApiOperationOptions>): Customizes the operation generated for this message. Ignored if the channel has a channel-level WithOperation() configured.

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

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

WithVersion(string): Sets the EventCatalog message version and returns this instance for chaining.

Edit this page