refactor(bindings)!: binding serialization for AsyncAPI v2/v3

src/ByteBard.AsyncAPI.Bindings/AMQP/AMQPChannelBinding.cs

@@ -53,9 +53,16 @@ public class AMQPChannelBinding : ChannelBinding<AMQPChannelBinding>
  { "vhost", (a, n) => { a.Vhost = n.GetScalarValue(); } },
  };
 
- /// <summary>
- /// Serialize to AsyncAPI V2 document without using reference.
- /// </summary>
+ public override void SerializeV2(IAsyncApiWriter writer)
+ {
+ this.SerializeV3(writer);
+ }
+
+ public override void SerializeV3(IAsyncApiWriter writer)
+ {
+ this.SerializeProperties(writer);
+ }
+
  public override void SerializeProperties(IAsyncApiWriter writer)
  {
  if (writer is null)

src/ByteBard.AsyncAPI.Bindings/AMQP/AMQPMessageBinding.cs

@@ -20,6 +20,16 @@ public class AMQPMessageBinding : MessageBinding<AMQPMessageBinding>
  /// </summary>
  public string MessageType { get; set; }
 
+ public override void SerializeV2(IAsyncApiWriter writer)
+ {
+ this.SerializeV3(writer);
+ }
+
+ public override void SerializeV3(IAsyncApiWriter writer)
+ {
+ this.SerializeProperties(writer);
+ }
+
  public override void SerializeProperties(IAsyncApiWriter writer)
  {
  if (writer is null)

src/ByteBard.AsyncAPI.Bindings/AMQP/AMQPOperationBinding.cs

@@ -72,9 +72,16 @@ public class AMQPOperationBinding : OperationBinding<AMQPOperationBinding>
  { "ack", (a, n) => { a.Ack = n.GetBooleanValue(); } },
  };
 
- /// <summary>
- /// Serialize to AsyncAPI V2 document without using reference.
- /// </summary>
+ public override void SerializeV2(IAsyncApiWriter writer)
+ {
+ this.SerializeV3(writer);
+ }
+
+ public override void SerializeV3(IAsyncApiWriter writer)
+ {
+ this.SerializeProperties(writer);
+ }
+
  public override void SerializeProperties(IAsyncApiWriter writer)
  {
  if (writer is null)

src/ByteBard.AsyncAPI.Bindings/Http/HttpMessageBinding.cs

@@ -1,6 +1,7 @@
 namespace ByteBard.AsyncAPI.Bindings.Http
 {
  using System;
+ using System.Net;
  using ByteBard.AsyncAPI.Models;
  using ByteBard.AsyncAPI.Readers;
  using ByteBard.AsyncAPI.Readers.ParseNodes;
@@ -9,38 +10,78 @@ namespace ByteBard.AsyncAPI.Bindings.Http
  /// <summary>
  /// Binding class for http messaging channels.
  /// </summary>
+ /// <remarks>
+ /// The 'statusCode' field exists in AsyncAPI V3 but not in V2.
+ /// </remarks>
  public class HttpMessageBinding : MessageBinding<HttpMessageBinding>
  {
+ private const string V2BindingVersion = "0.2.0";
+ private const string V3BindingVersion = "0.3.0";
+
  /// <summary>
  /// A Schema object containing the definitions for HTTP-specific headers. This schema MUST be of type object and have a properties key.
  /// </summary>
  public AsyncApiJsonSchema Headers { get; set; }
 
  /// <summary>
- /// Serialize to AsyncAPI V2 document without using reference.
+ /// The HTTP response status code according to RFC 9110. `statusCode` is only relevant for messages referenced by the Operation Reply Object.
+ /// Note: This field is only serialized in AsyncAPI V3.
  /// </summary>
- public override void SerializeProperties(IAsyncApiWriter writer)
+ public HttpStatusCode? StatusCode { get; set; }
+
+ public override string BindingKey => "http";
+
+ protected override FixedFieldMap<HttpMessageBinding> FixedFieldMap => new()
+ {
+ { "bindingVersion", (a, n) => { a.BindingVersion = n.GetScalarValue(); } },
+ { "headers", (a, n) => { a.Headers = AsyncApiJsonSchemaDeserializer.LoadSchema(n); } },
+ { "statusCode", (a, n) =>
+ {
+ if (int.TryParse(n.GetScalarValue(), out var code))
+ {
+ a.StatusCode = (HttpStatusCode)code;
+ }
+ }
+ },
+ };
+
+ public override void SerializeV2(IAsyncApiWriter writer)
  {
  if (writer is null)
  {
  throw new ArgumentNullException(nameof(writer));
  }
 
  writer.WriteStartObject();
-
  writer.WriteOptionalObject(AsyncApiConstants.Headers, this.Headers, (w, h) => h.SerializeV2(w));
- writer.WriteOptionalProperty(AsyncApiConstants.BindingVersion, this.BindingVersion);
+ writer.WriteOptionalProperty(AsyncApiConstants.BindingVersion, this.BindingVersion ?? V2BindingVersion);
  writer.WriteExtensions(this.Extensions);
-
  writer.WriteEndObject();
  }
 
- public override string BindingKey => "http";
+ public override void SerializeV3(IAsyncApiWriter writer)
+ {
+ if (writer is null)
+ {
+ throw new ArgumentNullException(nameof(writer));
+ }
 
- protected override FixedFieldMap<HttpMessageBinding> FixedFieldMap => new()
+ writer.WriteStartObject();
+ writer.WriteOptionalObject(AsyncApiConstants.Headers, this.Headers, (w, h) => h.SerializeV3(w));
+
+ if (this.StatusCode.HasValue)
+ {
+ writer.WriteRequiredProperty(AsyncApiConstants.StatusCode, (int)this.StatusCode.Value);
+ }
+
+ writer.WriteOptionalProperty(AsyncApiConstants.BindingVersion, this.BindingVersion ?? V3BindingVersion);
+ writer.WriteExtensions(this.Extensions);
+ writer.WriteEndObject();
+ }
+
+ public override void SerializeProperties(IAsyncApiWriter writer)
  {
- { "bindingVersion", (a, n) => { a.BindingVersion = n.GetScalarValue(); } },
- { "headers", (a, n) => { a.Headers = AsyncApiJsonSchemaDeserializer.LoadSchema(n); } },
- };
+ this.SerializeV3(writer);
+ }
  }
 }

src/ByteBard.AsyncAPI.Bindings/Http/HttpOperationBinding.cs

@@ -10,8 +10,17 @@ namespace ByteBard.AsyncAPI.Bindings.Http
  /// <summary>
  /// Binding class for http operations.
  /// </summary>
+ /// <remarks>
+ /// The 'type' field exists in AsyncAPI V2 but is removed in V3 (inferred from operation action).
+ /// </remarks>
  public class HttpOperationBinding : OperationBinding<HttpOperationBinding>
  {
+ private const string V2BindingVersion = "0.2.0";
+ private const string V3BindingVersion = "0.3.0";
+
+ /// <summary>
+ /// Represents the HTTP operation type (used in V2 serialization).
+ /// </summary>
  public enum HttpOperationType
  {
  [Display("request")]
@@ -22,12 +31,7 @@ public enum HttpOperationType
  }
 
  /// <summary>
- /// REQUIRED. Type of operation. Its value MUST be either request or response.
- /// </summary>
- public HttpOperationType? Type { get; set; }
-
- /// <summary>
- /// When type is request, this is the HTTP method, otherwise it MUST be ignored. Its value MUST be one of GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS, CONNECT, and TRACE.
+ /// The HTTP method, e.g. GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS, CONNECT, and TRACE.
  /// </summary>
  public string Method { get; set; }
 
@@ -36,10 +40,16 @@ public enum HttpOperationType
  /// </summary>
  public AsyncApiJsonSchema Query { get; set; }
 
- /// <summary>
- /// Serialize to AsyncAPI V2 document without using reference.
- /// </summary>
- public override void SerializeProperties(IAsyncApiWriter writer)
+ public override string BindingKey => "http";
+
+ protected override FixedFieldMap<HttpOperationBinding> FixedFieldMap => new()
+ {
+ { "bindingVersion", (a, n) => { a.BindingVersion = n.GetScalarValue(); } },
+ { "method", (a, n) => { a.Method = n.GetScalarValue(); } },
+ { "query", (a, n) => { a.Query = AsyncApiJsonSchemaDeserializer.LoadSchema(n); } },
+ };
+
+ public override void SerializeV2(IAsyncApiWriter writer)
  {
  if (writer is null)
  {
@@ -48,22 +58,50 @@ public override void SerializeProperties(IAsyncApiWriter writer)
 
  writer.WriteStartObject();
 
- writer.WriteRequiredProperty(AsyncApiConstants.Type, this.Type.GetDisplayName());
+ var typeValue = this.InferTypeFromContext(writer);
+ if (typeValue.HasValue)
+ {
+ writer.WriteRequiredProperty(AsyncApiConstants.Type, typeValue.GetDisplayName());
+ }
+
  writer.WriteOptionalProperty(AsyncApiConstants.Method, this.Method);
  writer.WriteOptionalObject(AsyncApiConstants.Query, this.Query, (w, h) => h.SerializeV2(w));
- writer.WriteOptionalProperty(AsyncApiConstants.BindingVersion, this.BindingVersion);
+ writer.WriteOptionalProperty(AsyncApiConstants.BindingVersion, this.BindingVersion ?? V2BindingVersion);
  writer.WriteExtensions(this.Extensions);
  writer.WriteEndObject();
  }
 
-protected override FixedFieldMap<HttpOperationBinding> FixedFieldMap => new()
+public override void SerializeV3(IAsyncApiWriter writer)
  {
- { "bindingVersion", (a, n) => { a.BindingVersion = n.GetScalarValue(); } },
- { "type", (a, n) => { a.Type = n.GetScalarValue().GetEnumFromDisplayName<HttpOperationType>(); } },
- { "method", (a, n) => { a.Method = n.GetScalarValue(); } },
- { "query", (a, n) => { a.Query = AsyncApiJsonSchemaDeserializer.LoadSchema(n); } },
- };
+ if (writer is null)
+ {
+ throw new ArgumentNullException(nameof(writer));
+ }
 
- public override string BindingKey => "http";
+ writer.WriteStartObject();
+ writer.WriteOptionalProperty(AsyncApiConstants.Method, this.Method);
+ writer.WriteOptionalObject(AsyncApiConstants.Query, this.Query, (w, h) => h.SerializeV3(w));
+ writer.WriteOptionalProperty(AsyncApiConstants.BindingVersion, this.BindingVersion ?? V3BindingVersion);
+ writer.WriteExtensions(this.Extensions);
+ writer.WriteEndObject();
+ }
+
+ public override void SerializeProperties(IAsyncApiWriter writer)
+ {
+ this.SerializeV3(writer);
+ }
+
+ private HttpOperationType? InferTypeFromContext(IAsyncApiWriter writer)
+ {
+ var parentOperation = writer.Workspace?.GetSerializationContext<AsyncApiOperation>();
+ if (parentOperation == null)
+ {
+ return null;
+ }
+
+ return parentOperation.Action == AsyncApiAction.Send
+ ? HttpOperationType.Request
+ : HttpOperationType.Response;
+ }
  }
 }

src/ByteBard.AsyncAPI.Bindings/Kafka/KafkaChannelBinding.cs

@@ -54,9 +54,16 @@ public class KafkaChannelBinding : ChannelBinding<KafkaChannelBinding>
  { "confluent.value.subject.name.strategy", (a, n) => { a.ConfluentValueSubjectName = n.GetScalarValue(); } },
  };
 
- /// <summary>
- /// Serialize to AsyncAPI V2 document without using reference.
- /// </summary>
+ public override void SerializeV2(IAsyncApiWriter writer)
+ {
+ this.SerializeV3(writer);
+ }
+
+ public override void SerializeV3(IAsyncApiWriter writer)
+ {
+ this.SerializeProperties(writer);
+ }
+
  public override void SerializeProperties(IAsyncApiWriter writer)
  {
  if (writer is null)

src/ByteBard.AsyncAPI.Bindings/Kafka/KafkaMessageBinding.cs

@@ -35,6 +35,16 @@ public class KafkaMessageBinding : MessageBinding<KafkaMessageBinding>
  /// The version of this binding. If omitted, "latest" MUST be assumed.
  /// </summary>
 
+ public override void SerializeV2(IAsyncApiWriter writer)
+ {
+ this.SerializeV3(writer);
+ }
+
+ public override void SerializeV3(IAsyncApiWriter writer)
+ {
+ this.SerializeProperties(writer);
+ }
+
  public override void SerializeProperties(IAsyncApiWriter writer)
  {
  if (writer is null)
@@ -54,12 +64,6 @@ public override void SerializeProperties(IAsyncApiWriter writer)
  writer.WriteEndObject();
  }
 
- /// <summary>
- /// Serializes the v2.
- /// </summary>
- /// <param name="writer">The writer.</param>
- /// <exception cref="ArgumentNullException">writer.</exception>
-
  public override string BindingKey => "kafka";
 
  protected override FixedFieldMap<KafkaMessageBinding> FixedFieldMap => new()

src/ByteBard.AsyncAPI.Bindings/Kafka/KafkaOperationBinding.cs

@@ -30,9 +30,16 @@ public class KafkaOperationBinding : OperationBinding<KafkaOperationBinding>
  { "clientId", (a, n) => { a.ClientId = AsyncApiJsonSchemaDeserializer.LoadSchema(n); } },
  };
 
- /// <summary>
- /// Serialize to AsyncAPI V2 document without using reference.
- /// </summary>
+ public override void SerializeV2(IAsyncApiWriter writer)
+ {
+ this.SerializeV3(writer);
+ }
+
+ public override void SerializeV3(IAsyncApiWriter writer)
+ {
+ this.SerializeProperties(writer);
+ }
+
  public override void SerializeProperties(IAsyncApiWriter writer)
  {
  if (writer is null)

src/ByteBard.AsyncAPI.Bindings/Kafka/KafkaServerBinding.cs

@@ -29,9 +29,16 @@ public class KafkaServerBinding : ServerBinding<KafkaServerBinding>
  { "schemaRegistryVendor", (a, n) => { a.SchemaRegistryVendor = n.GetScalarValue(); } },
  };
 
- /// <summary>
- /// Serialize to AsyncAPI V2 document without using reference.
- /// </summary>
+ public override void SerializeV2(IAsyncApiWriter writer)
+ {
+ this.SerializeV3(writer);
+ }
+
+ public override void SerializeV3(IAsyncApiWriter writer)
+ {
+ this.SerializeProperties(writer);
+ }
+
  public override void SerializeProperties(IAsyncApiWriter writer)
  {
  if (writer is null)

src/ByteBard.AsyncAPI.Bindings/MQTT/MQTTMessageBinding.cs

@@ -33,6 +33,16 @@ public class MQTTMessageBinding : MessageBinding<MQTTMessageBinding>
  /// </summary>
  public string ResponseTopic { get; set; }
 
+ public override void SerializeV2(IAsyncApiWriter writer)
+ {
+ this.SerializeV3(writer);
+ }
+
+ public override void SerializeV3(IAsyncApiWriter writer)
+ {
+ this.SerializeProperties(writer);
+ }
+
  public override void SerializeProperties(IAsyncApiWriter writer)
  {
  if (writer is null)

src/ByteBard.AsyncAPI.Bindings/MQTT/MQTTOperationBinding.cs

@@ -34,9 +34,16 @@ public class MQTTOperationBinding : OperationBinding<MQTTOperationBinding>
  { "messageExpiryInterval", (a, n) => { a.MessageExpiryInterval = n.GetIntegerValueOrDefault(); } },
  };
 
- /// <summary>
- /// Serialize to AsyncAPI V2 document without using reference.
- /// </summary>
+ public override void SerializeV2(IAsyncApiWriter writer)
+ {
+ this.SerializeV3(writer);
+ }
+
+ public override void SerializeV3(IAsyncApiWriter writer)
+ {
+ this.SerializeProperties(writer);
+ }
+
  public override void SerializeProperties(IAsyncApiWriter writer)
  {
  if (writer is null)