chore: pull main into vnext (#181)

Co-authored-by: lego-10-01-06[bot] <119427331+lego-10-01-06[bot]@users.noreply.github.com>
LEGO · Jun 14, 2024 · b9de516 · b9de516
1 parent 3355ac9
commit b9de516
Show file tree

Hide file tree

Showing 13 changed files with 73 additions and 28 deletions.
diff --git a/.github/workflows/release-internal.yml b/.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:

diff --git a/CHANGELOG.md b/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)
 
 

diff --git a/Common.Build.props b/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>
diff --git a/LICENSE → LICENSE.txt b/LICENSE → LICENSE.txt
diff --git a/README.md b/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/)  

diff --git a/media/logo.png b/media/logo.png
diff --git a/src/LEGO.AsyncAPI.Bindings/LEGO.AsyncAPI.Bindings.csproj b/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" />

diff --git a/src/LEGO.AsyncAPI.Readers/LEGO.AsyncAPI.Readers.csproj b/src/LEGO.AsyncAPI.Readers/LEGO.AsyncAPI.Readers.csproj
@@ -27,12 +27,6 @@
   <ItemGroup>
     <InternalsVisibleTo Include="LEGO.AsyncAPI.Tests" />
   </ItemGroup>
-  <ItemGroup>
-    <None Include="..\..\README.md">
-      <Pack>True</Pack>
-      <PackagePath>\</PackagePath>
-    </None>
-  </ItemGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\LEGO.AsyncAPI\LEGO.AsyncAPI.csproj" />

diff --git a/src/LEGO.AsyncAPI.Readers/V2/AsyncApiChannelDeserializer.cs b/src/LEGO.AsyncAPI.Readers/V2/AsyncApiChannelDeserializer.cs
@@ -14,7 +14,7 @@ internal static partial class AsyncApiV2Deserializer
             { "servers", (a, n) => { a.Servers = n.CreateSimpleList(s => s.GetScalarValue()); } },
             { "subscribe", (a, n) => { a.Subscribe = LoadOperation(n); } },
             { "publish", (a, n) => { a.Publish = LoadOperation(n); } },
-            { "parameters", (a, n) => { a.Parameters = n.CreateMapWithReference(ReferenceType.Parameter, LoadParameter); } },
+            { "parameters", (a, n) => { a.Parameters = n.CreateMap(LoadParameter); } },
             { "bindings", (a, n) => { a.Bindings = LoadChannelBindings(n); } },
         };
 

diff --git a/src/LEGO.AsyncAPI/LEGO.AsyncAPI.csproj b/src/LEGO.AsyncAPI/LEGO.AsyncAPI.csproj
@@ -26,10 +26,6 @@
 	  </AssemblyAttribute>
   </ItemGroup>
 
-  <ItemGroup>
-    <None Include="..\..\README.md" Pack="true" PackagePath="\" />
-  </ItemGroup>
-
   <ItemGroup>
     <InternalsVisibleTo Include="LEGO.AsyncAPI.Tests" />
   </ItemGroup>

diff --git a/src/LEGO.AsyncAPI/Services/AsyncApiReferenceResolver.cs b/src/LEGO.AsyncAPI/Services/AsyncApiReferenceResolver.cs
@@ -225,7 +225,13 @@ private T ResolveReference<T>(AsyncApiReference reference)
 
             try
             {
-                return this.currentDocument.ResolveReference(reference) as T;
+                var resolvedReference = this.currentDocument.ResolveReference(reference) as T;
+                if (resolvedReference == null)
+                {
+                    throw new AsyncApiException($"Cannot resolve reference '{reference.Reference}' to '{typeof(T).Name}'.");
+                }
+
+                return resolvedReference;
             }
             catch (AsyncApiException ex)
             {

diff --git a/test/LEGO.AsyncAPI.Tests/AsyncApiReaderTests.cs b/test/LEGO.AsyncAPI.Tests/AsyncApiReaderTests.cs
@@ -5,6 +5,7 @@ namespace LEGO.AsyncAPI.Tests
     using System;
     using System.Collections.Generic;
     using System.Linq;
+    using System.Text.Json.Nodes;
     using FluentAssertions;
     using LEGO.AsyncAPI.Exceptions;
     using LEGO.AsyncAPI.Models;
@@ -428,6 +429,32 @@ public void Read_WithBasicPlusSecuritySchemeDeserializes()
             Assert.AreEqual("Provide your username and password for SASL/SCRAM authentication", scheme.Value.Description);
         }
 
+        [Test]
+        public void Read_WithWrongReference_AddsError()
+        {
+            var yaml = 
+                """
+                asyncapi: 2.3.0
+                info:
+                  title: test
+                  version: 1.0.0
+                channels:
+                  workspace:
+                    publish:
+                      message:
+                        $ref: '#/components/securitySchemes/saslScram'
+                components:
+                  securitySchemes:
+                    saslScram:
+                      type: scramSha256
+                      description: Provide your username and password for SASL/SCRAM authentication
+                """;
+            var reader = new AsyncApiStringReader();
+            var doc = reader.Read(yaml, out var diagnostic);
+            diagnostic.Errors.Should().NotBeEmpty();
+            doc.Channels.Values.First().Publish.Message.First().Should().BeNull();
+        }
+
         [Test]
         public void Read_WithBasicPlusOAuthFlowDeserializes()
         {

diff --git a/test/LEGO.AsyncAPI.Tests/Models/AsyncApiChannel_Should.cs b/test/LEGO.AsyncAPI.Tests/Models/AsyncApiChannel_Should.cs
@@ -3,15 +3,36 @@
 namespace LEGO.AsyncAPI.Tests.Models
 {
     using System.Collections.Generic;
+    using System.Linq;
     using FluentAssertions;
     using LEGO.AsyncAPI.Bindings.Kafka;
     using LEGO.AsyncAPI.Bindings.WebSockets;
     using LEGO.AsyncAPI.Models;
     using LEGO.AsyncAPI.Models.Interfaces;
+    using LEGO.AsyncAPI.Readers;
     using NUnit.Framework;
 
     public class AsyncApiChannel_Should : TestBase
     {
+        [Test]
+        public void AsyncApiChannel_WithInlineParameter_DoesNotCreateReference()
+        {
+            var input =
+                """
+                    parameters:
+                      id:
+                        description: ids
+                        schema:
+                          type: string
+                          enum:
+                            - 08735ae0-6a1a-4578-8b4a-35aa26d15993
+                            - 97845c62-329c-4d87-ad24-4f611b909a10
+                """;
+
+            var channel = new AsyncApiStringReader().ReadFragment<AsyncApiChannel>(input, AsyncApiVersion.AsyncApi2_0, out var _ );
+            channel.Parameters.First().Value.Reference.Should().BeNull();
+        }
+
         [Test]
         public void AsyncApiChannel_WithWebSocketsBinding_Serializes()
         {