chore: pull main into vnext (#181)

.github/workflows/release-internal.yml

@@ -1,13 +1,5 @@
 name: Publish beta NuGet package
 on:
-  push:
-    branches: [ main ]
-    paths:
-      - 'src/LEGO.AsyncAPI/**'
-      - 'src/LEGO.AsyncAPI.Readers/**'
-      - 'src/LEGO.AsyncAPI.Bindings/**'
-      - ".github/workflows/release-internal.yml"
-      - '!**/*.md' 
   workflow_dispatch:
 
 jobs:

CHANGELOG.md

@@ -1,3 +1,10 @@
+## [5.2.1](https://github.com/LEGO/AsyncAPI.NET/compare/v5.2.0...v5.2.1) (2024-06-12)
+
+
+### Bug Fixes
+
+* inline channel parameters should not deserialize as references ([#172](https://github.com/LEGO/AsyncAPI.NET/issues/172)) ([7fd3af0](https://github.com/LEGO/AsyncAPI.NET/commit/7fd3af0e6669d18e805e0bab9cafac819ea64c1d))
+
 # [5.2.0](https://github.com/LEGO/AsyncAPI.NET/compare/v5.1.1...v5.2.0) (2024-03-30)
 
 

Common.Build.props

@@ -9,5 +9,12 @@
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <RepositoryUrl>https://github.com/LEGO/AsyncAPI.NET</RepositoryUrl>
     <PackageTags>asyncapi .net openapi documentation</PackageTags>
+    <PackageIcon>logo.png</PackageIcon>
+    <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
   </PropertyGroup>
+  <ItemGroup>
+    <None Include="..\..\media\logo.png" Pack="true" PackagePath="\" />
+    <None Include="..\..\README.md" Pack="true" PackagePath="\" />
+    <None Include="..\..\LICENSE.txt" Pack="true" PackagePath="\" />
+  </ItemGroup>
 </Project>

README.md

@@ -15,11 +15,11 @@ The AsyncAPI.NET SDK contains a useful object model for the AsyncAPI specificati
 Install the NuGet packages:
 ### AsyncAPI.NET
 [![Nuget](https://img.shields.io/nuget/v/AsyncAPI.NET?label=AsyncAPI.NET&style=for-the-badge)](https://www.nuget.org/packages/AsyncAPI.NET/)  
-[![Nuget](https://img.shields.io/nuget/vpre/AsyncAPI.NET?label=AsyncAPI.NET&style=for-the-badge)](https://www.nuget.org/packages/AsyncAPI.NET/)  
+[![Nuget](https://img.shields.io/nuget/vpre/AsyncAPI.NET?label=AsyncAPI.NET-Preview&style=for-the-badge)](https://www.nuget.org/packages/AsyncAPI.NET/)  
 
 ### AsyncAPI.Readers
 [![Nuget](https://img.shields.io/nuget/v/AsyncAPI.NET.Readers?label=AsyncAPI.Readers&style=for-the-badge)](https://www.nuget.org/packages/AsyncAPI.NET.Readers/)  
-[![Nuget](https://img.shields.io/nuget/vpre/AsyncAPI.NET.Readers?label=AsyncAPI.Readers&style=for-the-badge)](https://www.nuget.org/packages/AsyncAPI.NET.Readers/)  
+[![Nuget](https://img.shields.io/nuget/vpre/AsyncAPI.NET.Readers?label=AsyncAPI.Readers-Preview&style=for-the-badge)](https://www.nuget.org/packages/AsyncAPI.NET.Readers/)  
 
 ### AsyncAPI.Bindings
 [![Nuget](https://img.shields.io/nuget/v/AsyncAPI.NET.Bindings?label=AsyncAPI.Bindings&style=for-the-badge)](https://www.nuget.org/packages/AsyncAPI.NET.Bindings/)  
@@ -78,6 +78,48 @@ var stream = await httpClient.GetStreamAsync("master/examples/streetlights-kafka
 var asyncApiDocument = new AsyncApiStreamReader().Read(stream, out var diagnostic);
 ```
 
+#### Reading External $ref
+
+You can read externally referenced AsyncAPI documents by setting the `ReferenceResolution` property of the `AsyncApiReaderSettings` object to `ReferenceResolutionSetting.ResolveAllReferences` and providing an implementation for the `IAsyncApiExternalReferenceReader` interface. This interface contains a single method to which the built AsyncAPI.NET reader library will pass the location content contained in a `$ref` property (usually some form of path) and interface will return the content which is retrieved from wherever the `$ref` points to as a `string`. The AsyncAPI.NET reader will then automatically infer the `T` type of the content and recursively parse the external content into an AsyncAPI document as a child of the original document that contained the `$ref`. This means that you can have externally referenced documents that themselves contain external references. 
+
+This interface allows users to load the content of their external reference however and from whereever is required. A new instance of the implementor of `IAsyncApiExternalReferenceReader` should be registered with the `ExternalReferenceReader` property of the `AsyncApiReaderSettings` when creating the reader from which the `GetExternalResource` method will be called when resolving external references.
+
+Below is a very simple example of implementation for `IAsyncApiExternalReferenceReader` that simply loads a file and returns it as a string found at the reference endpoint.
+```csharp
+using System.IO;
+
+public class AsyncApiExternalFileSystemReader : IAsyncApiExternalReferenceReader
+{
+    public string GetExternalResource(string reference)
+    {
+        return File.ReadAllText(reference);
+    }
+}
+```
+
+This can then be configured in the reader as follows:
+```csharp
+var settings = new AsyncApiReaderSettings
+{
+  ReferenceResolution = ReferenceResolutionSetting.ResolveAllReferences,
+  ExternalReferenceReader = new AsyncApiExternalFileSystemReader(),
+};
+var reader = new AsyncApiStringReader(settings);
+```
+
+This would function for a AsyncAPI document with following reference to load the content of `message.yaml` as a `AsyncApiMessage` object inline with the document object.
+```yaml
+asyncapi: 2.3.0
+info:
+  title: test
+  version: 1.0.0
+channels:
+  workspace:
+    publish:
+      message:
+        $ref: "../../../message.yaml"
+```
+
 ### Bindings
 To add support for reading bindings, simply add the bindings you wish to support, to the `Bindings` collection of `AsyncApiReaderSettings`.
 There is a nifty helper to add different types of bindings, or like in the example `All` of them.

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

@@ -5,7 +5,6 @@ namespace LEGO.AsyncAPI.Bindings.AMQP
     using System;
     using System.Collections.Generic;
     using LEGO.AsyncAPI.Models;
-    using LEGO.AsyncAPI.Readers;
     using LEGO.AsyncAPI.Readers.ParseNodes;
     using LEGO.AsyncAPI.Writers;
 

src/LEGO.AsyncAPI.Bindings/BindingsCollection.cs

@@ -45,7 +45,7 @@ public static TCollection Add<TCollection, TItem>(
             return destination;
         }
 
-        public static IEnumerable<IBindingParser<IBinding>> All => new List<IBindingParser<IBinding>>
+        public static ICollection<IBindingParser<IBinding>> All => new List<IBindingParser<IBinding>>
         {
             Pulsar,
             Kafka,
@@ -57,51 +57,51 @@ public static TCollection Add<TCollection, TItem>(
             MQTT,
         };
 
-        public static IEnumerable<IBindingParser<IBinding>> Http => new List<IBindingParser<IBinding>>
+        public static ICollection<IBindingParser<IBinding>> Http => new List<IBindingParser<IBinding>>
         {
             new HttpOperationBinding(),
             new HttpMessageBinding(),
         };
 
-        public static IEnumerable<IBindingParser<IBinding>> Websockets => new List<IBindingParser<IBinding>>
+        public static ICollection<IBindingParser<IBinding>> Websockets => new List<IBindingParser<IBinding>>
         {
             new WebSocketsChannelBinding(),
         };
 
-        public static IEnumerable<IBindingParser<IBinding>> Kafka => new List<IBindingParser<IBinding>>
+        public static ICollection<IBindingParser<IBinding>> Kafka => new List<IBindingParser<IBinding>>
         {
             new KafkaServerBinding(),
             new KafkaChannelBinding(),
             new KafkaOperationBinding(),
             new KafkaMessageBinding(),
         };
 
-        public static IEnumerable<IBindingParser<IBinding>> Pulsar => new List<IBindingParser<IBinding>>
+        public static ICollection<IBindingParser<IBinding>> Pulsar => new List<IBindingParser<IBinding>>
         {
             new PulsarServerBinding(),
             new PulsarChannelBinding(),
         };
 
-        public static IEnumerable<IBindingParser<IBinding>> Sqs => new List<IBindingParser<IBinding>>
+        public static ICollection<IBindingParser<IBinding>> Sqs => new List<IBindingParser<IBinding>>
         {
             new SqsChannelBinding(),
             new SqsOperationBinding(),
         };
 
-        public static IEnumerable<IBindingParser<IBinding>> Sns => new List<IBindingParser<IBinding>>
+        public static ICollection<IBindingParser<IBinding>> Sns => new List<IBindingParser<IBinding>>
         {
             new SnsChannelBinding(),
             new SnsOperationBinding(),
         };
 
-        public static IEnumerable<IBindingParser<IBinding>> AMQP => new List<IBindingParser<IBinding>>
+        public static ICollection<IBindingParser<IBinding>> AMQP => new List<IBindingParser<IBinding>>
         {
             new AMQPChannelBinding(),
             new AMQPOperationBinding(),
             new AMQPMessageBinding(),
         };
 
-        public static IEnumerable<IBindingParser<IBinding>> MQTT => new List<IBindingParser<IBinding>>
+        public static ICollection<IBindingParser<IBinding>> MQTT => new List<IBindingParser<IBinding>>
         {
             new MQTTServerBinding(),
             new MQTTOperationBinding(),

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

@@ -42,7 +42,7 @@ public override void SerializeProperties(IAsyncApiWriter writer)
         protected override FixedFieldMap<HttpMessageBinding> FixedFieldMap => new()
         {
             { "bindingVersion", (a, n) => { a.BindingVersion = n.GetScalarValue(); } },
-            { "headers", (a, n) => { a.Headers = JsonSchemaDeserializer.LoadSchema(n); } },
+            { "headers", (a, n) => { a.Headers = AsyncApiSchemaDeserializer.LoadSchema(n); } },
         };
     }
 }

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

@@ -63,7 +63,7 @@ public override void SerializeProperties(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 = JsonSchemaDeserializer.LoadSchema(n); } },
+            { "query", (a, n) => { a.Query = AsyncApiSchemaDeserializer.LoadSchema(n); } },
         };
 
         public override string BindingKey => "http";

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

@@ -67,7 +67,7 @@ public override void SerializeProperties(IAsyncApiWriter writer)
         protected override FixedFieldMap<KafkaMessageBinding> FixedFieldMap => new()
         {
             { "bindingVersion", (a, n) => { a.BindingVersion = n.GetScalarValue(); } },
-            { "key", (a, n) => { a.Key = JsonSchemaDeserializer.LoadSchema(n); } },
+            { "key", (a, n) => { a.Key = AsyncApiSchemaDeserializer.LoadSchema(n); } },
             { "schemaIdLocation", (a, n) => { a.SchemaIdLocation = n.GetScalarValue(); } },
             { "schemaIdPayloadEncoding", (a, n) => { a.SchemaIdPayloadEncoding = n.GetScalarValue(); } },
             { "schemaLookupStrategy", (a, n) => { a.SchemaLookupStrategy = n.GetScalarValue(); } },

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

@@ -28,8 +28,8 @@ public class KafkaOperationBinding : OperationBinding<KafkaOperationBinding>
         protected override FixedFieldMap<KafkaOperationBinding> FixedFieldMap => new()
         {
             { "bindingVersion", (a, n) => { a.BindingVersion = n.GetScalarValue(); } },
-            { "groupId", (a, n) => { a.GroupId = JsonSchemaDeserializer.LoadSchema(n); } },
-            { "clientId", (a, n) => { a.ClientId = JsonSchemaDeserializer.LoadSchema(n); } },
+            { "groupId", (a, n) => { a.GroupId = AsyncApiSchemaDeserializer.LoadSchema(n); } },
+            { "clientId", (a, n) => { a.ClientId = AsyncApiSchemaDeserializer.LoadSchema(n); } },
         };
 
         /// <summary>

src/LEGO.AsyncAPI.Bindings/LEGO.AsyncAPI.Bindings.csproj

@@ -20,12 +20,7 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
   </ItemGroup>
-  <ItemGroup>
-    <None Include="..\..\README.md">
-      <Pack>True</Pack>
-      <PackagePath>\</PackagePath>
-    </None>
-  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\LEGO.AsyncAPI.Readers\LEGO.AsyncAPI.Readers.csproj" />
     <ProjectReference Include="..\LEGO.AsyncAPI\LEGO.AsyncAPI.csproj" />

src/LEGO.AsyncAPI.Bindings/MQTT/LastWill.cs

@@ -2,9 +2,9 @@
 
 namespace LEGO.AsyncAPI.Bindings.MQTT
 {
+    using System;
     using LEGO.AsyncAPI.Models.Interfaces;
     using LEGO.AsyncAPI.Writers;
-    using System;
 
     public class LastWill : IAsyncApiElement
     {

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

@@ -57,7 +57,7 @@ public override void SerializeProperties(IAsyncApiWriter writer)
         protected override FixedFieldMap<MQTTMessageBinding> FixedFieldMap => new()
         {
             { "payloadFormatIndicator", (a, n) => { a.PayloadFormatIndicator = n.GetIntegerValueOrDefault(); } },
-            { "correlationData", (a, n) => { a.CorrelationData = JsonSchemaDeserializer.LoadSchema(n); } },
+            { "correlationData", (a, n) => { a.CorrelationData = AsyncApiSchemaDeserializer.LoadSchema(n); } },
             { "contentType", (a, n) => { a.ContentType = n.GetScalarValue(); } },
             { "responseTopic", (a, n) => { a.ResponseTopic = n.GetScalarValue(); } },
         };

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

@@ -3,9 +3,6 @@
 namespace LEGO.AsyncAPI.Bindings.MQTT
 {
     using System;
-    using System.Collections.Generic;
-    using LEGO.AsyncAPI.Models;
-    using LEGO.AsyncAPI.Readers;
     using LEGO.AsyncAPI.Readers.ParseNodes;
     using LEGO.AsyncAPI.Writers;
 

src/LEGO.AsyncAPI.Bindings/Sns/Ordering.cs

@@ -11,7 +11,7 @@ namespace LEGO.AsyncAPI.Bindings.Sns
     public class Ordering : IAsyncApiExtensible
     {
         /// <summary>
-        /// What type of SNS Topic is this?
+        /// What type of SNS Topic is this?.
         /// </summary>
         public OrderingType Type { get; set; }
 

src/LEGO.AsyncAPI.Bindings/Sns/Statement.cs

@@ -19,7 +19,7 @@ public class Statement : IAsyncApiExtensible
         public StringOrStringList Principal { get; set; }
 
         /// <summary>
-        /// The SNS permission being allowed or denied e.g. sns:Publish
+        /// The SNS permission being allowed or denied e.g. sns:Publish.
         /// </summary>
         public StringOrStringList Action { get; set; }
 

src/LEGO.AsyncAPI.Bindings/Sqs/Queue.cs

@@ -16,7 +16,7 @@ public class Queue : IAsyncApiExtensible
         public string Name { get; set; }
 
         /// <summary>
-        /// Is this a FIFO queue?
+        /// Is this a FIFO queue?.
         /// </summary>
         public bool FifoQueue { get; set; }
 
@@ -56,7 +56,7 @@ public class Queue : IAsyncApiExtensible
         public RedrivePolicy RedrivePolicy { get; set; }
 
         /// <summary>
-        /// The security policy for the SQS Queue
+        /// The security policy for the SQS Queue.
         /// </summary>
         public Policy Policy { get; set; }
 

src/LEGO.AsyncAPI.Bindings/Sqs/RedrivePolicy.cs

@@ -3,9 +3,9 @@
 namespace LEGO.AsyncAPI.Bindings.Sqs
 {
     using System;
+    using System.Collections.Generic;
     using LEGO.AsyncAPI.Models.Interfaces;
     using LEGO.AsyncAPI.Writers;
-    using System.Collections.Generic;
 
     public class RedrivePolicy : IAsyncApiExtensible
     {

src/LEGO.AsyncAPI.Bindings/Sqs/SqsOperationBinding.cs

@@ -10,7 +10,7 @@ namespace LEGO.AsyncAPI.Bindings.Sqs
     public class SqsOperationBinding : OperationBinding<SqsOperationBinding>
     {
         /// <summary>
-        /// Queue objects that are either the endpoint for an SNS Operation Binding Object, or the deadLetterQueue of the SQS Operation Binding Object
+        /// Queue objects that are either the endpoint for an SNS Operation Binding Object, or the deadLetterQueue of the SQS Operation Binding Object.
         /// </summary>
         public List<Queue> Queues { get; set; }
 

src/LEGO.AsyncAPI.Bindings/Sqs/Statement.cs

@@ -19,7 +19,7 @@ public class Statement : IAsyncApiExtensible
         public StringOrStringList Principal { get; set; }
 
         /// <summary>
-        /// The SNS permission being allowed or denied e.g. sns:Publish
+        /// The SNS permission being allowed or denied e.g. sns:Publish.
         /// </summary>
         public StringOrStringList Action { get; set; }
 

src/LEGO.AsyncAPI.Bindings/WebSockets/WebSocketsChannelBinding.cs

@@ -31,8 +31,8 @@ public class WebSocketsChannelBinding : ChannelBinding<WebSocketsChannelBinding>
         {
             { "bindingVersion", (a, n) => { a.BindingVersion = n.GetScalarValue(); } },
             { "method", (a, n) => { a.Method = n.GetScalarValue(); } },
-            { "query", (a, n) => { a.Query = JsonSchemaDeserializer.LoadSchema(n); } },
-            { "headers", (a, n) => { a.Headers = JsonSchemaDeserializer.LoadSchema(n); } },
+            { "query", (a, n) => { a.Query = AsyncApiSchemaDeserializer.LoadSchema(n); } },
+            { "headers", (a, n) => { a.Headers = AsyncApiSchemaDeserializer.LoadSchema(n); } },
         };
 
         public override void SerializeProperties(IAsyncApiWriter writer)