Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,8 @@
</PackageReference>
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\..\src\LEGO.AsyncAPI.Readers\LEGO.AsyncAPI.Readers.csproj" />
</ItemGroup>

</Project>
2 changes: 1 addition & 1 deletion examples/LEGO.AsyncAPI.Readers.JsonExample/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ static async Task Main()

if (diagnostic.HasError)
{
Console.WriteLine($"Error during spec parsing: {diagnostic.Error}");
Console.WriteLine($"Error during spec parsing: {diagnostic.Errors.First()}");
}
else
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,9 @@
<PackageReference Include="LEGO.AsyncAPI.Writers" Version="*-*" />
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\..\src\LEGO.AsyncAPI.Readers\LEGO.AsyncAPI.Readers.csproj" />
<ProjectReference Include="..\..\src\LEGO.AsyncAPI.Writers\LEGO.AsyncAPI.Writers.csproj" />
</ItemGroup>

</Project>
14 changes: 10 additions & 4 deletions src/LEGO.AsyncAPI.Readers/AsyncApiDiagnostic.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
namespace LEGO.AsyncAPI.Readers
{
using System;
using System.Collections.Generic;
using System.Linq;

/// <summary>
/// Object containing errors that happened during AsyncApi parsing.
Expand All @@ -15,17 +17,21 @@ public class AsyncApiDiagnostic
/// <param name="e"></param>
public AsyncApiDiagnostic(Exception e = null)
{
this.Error = e;
this.Errors = new List<Exception>();
if (e is not null)
{
this.Errors.Add(e);
}
}

/// <summary>
/// Returns true if Error value is not null.
/// </summary>
public bool HasError => this.Error != null;
public bool HasError => this.Errors.Any();

/// <summary>
/// Gets an error.
/// </summary>
public Exception Error { get; }
public List<Exception> Errors { get; }
}
}
}
11 changes: 6 additions & 5 deletions src/LEGO.AsyncAPI/NewtonUtils/JTokenExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace LEGO.AsyncAPI.NewtonUtils
{
using System;
using System.Globalization;
using System.Linq;
using Newtonsoft.Json.Linq;
Expand Down Expand Up @@ -32,6 +33,10 @@ public static void ResolveReferences(this JToken root)
{
refObj.Replace(original);
}
else
{
throw new Exception($"Reference '{path}' could not be found.");
}
}
}
while (container.Descendants().OfType<JObject>().Where(IsRefObject).Any());
Expand Down Expand Up @@ -74,7 +79,7 @@ private static JToken ResolveRef(JToken token, string path)
if (token is JObject obj)
{
token = obj[component];
if (token["$id"] != null && count == components.Length)
if (token?["$id"] != null && count == components.Length)
{
token = obj[component].DeepClone();
token["$id"].Parent.Remove();
Expand All @@ -84,10 +89,6 @@ private static JToken ResolveRef(JToken token, string path)
{
token = token[int.Parse(component, NumberFormatInfo.InvariantInfo)];
}
else
{
return null;
}
}

return token;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
<EmbeddedResource Include="Readers\Samples\AsyncApi\CompleteUsingComponentReferences.json" />
<EmbeddedResource Include="Readers\Samples\AsyncApi\CompleteKafkaSpec.yml" />
<EmbeddedResource Include="Readers\Samples\AsyncApi\Minimal.json" />
<EmbeddedResource Include="Readers\Samples\AsyncApi\MissingRefCompleteKafkaSpec.json" />
<EmbeddedResource Include="Readers\Samples\AsyncApi\schema-v2.3.0.json" />
<None Remove="Readers\Samples\AsyncApi\CompleteKafkaSpec.json" />
<None Remove="Readers\Samples\AsyncApi\CompleteKafkaSpec.yml" />
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,232 @@
{
"asyncapi": "2.3.0",
"info": {
"title": "Streetlights Kafka API",
"version": "1.0.0",
"description": "The Smartylighting Streetlights API allows you to remotely manage the city lights.\n",
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0"
}
},
"servers": {
"test": {
"url": "test.mykafkacluster.org:8092",
"protocol": "kafka-secure",
"description": "Test broker",
"security": [
{
"saslScram": []
}
]
}
},
"defaultContentType": "application/json",
"channels": {
"smartylighting.streetlights.1.0.event.{streetlightId}.lighting.measured": {
"description": "The topic on which measured values may be produced and consumed.",
"parameters": {
"streetlightId": {
"$ref": "#/components/parameters/streetlightId"
}
},
"publish": {
"summary": "Inform about environmental lighting conditions of a particular streetlight.",
"operationId": "receiveLightMeasurement",
"traits": [
{
"$ref": "#/components/operationTraits/kafka"
}
],
"message": {
"$ref": "#/components/messages/lightMeasured"
}
}
},
"smartylighting.streetlights.1.0.action.{streetlightId}.turn.on": {
"parameters": {
"streetlightId": {
"$ref": "#/components/parameters/streetlightId"
}
},
"subscribe": {
"operationId": "turnOn",
"traits": [
{
"$ref": "#/components/operationTraits/kafka"
}
],
"message": {
"$ref": "#/components/messages/turnOnOff"
}
}
},
"smartylighting.streetlights.1.0.action.{streetlightId}.turn.off": {
"parameters": {
"streetlightId": {
"$ref": "#/components/parameters/streetlightId"
}
},
"subscribe": {
"operationId": "turnOff",
"traits": [
{
"$ref": "#/components/operationTraits/kafka"
}
],
"message": {
"$ref": "#/components/messages/turnOnOff"
}
}
},
"smartylighting.streetlights.1.0.action.{streetlightId}.dim": {
"parameters": {
"streetlightId": {
"$ref": "#/components/parameters/streetlightId"
}
},
"subscribe": {
"operationId": "dimLight",
"traits": [
{
"$ref": "#/components/operationTraits/kafka"
}
],
"message": {
"$ref": "#/components/messages/dimLight"
}
}
}
},
"components": {
"messages": {
"lightMeasured": {
"name": "lightMeasured",
"title": "Light measured",
"summary": "Inform about environmental lighting conditions of a particular streetlight.",
"contentType": "application/json",
"traits": [
{
"$ref": "#/components/messageTraits/commonHeaders"
}
],
"payload": {
"$ref": "#/components/schemas/lightMeasuredPayload"
}
},
"turnOnOff": {
"name": "turnOnOff",
"title": "Turn on/off",
"summary": "Command a particular streetlight to turn the lights on or off.",
"traits": [
{
"$ref": "#/components/messageTraits/commonHeaders"
}
],
"payload": {
"$ref": "#/components/schemas/turnOnOffPayload"
}
},
"dimLight": {
"name": "dimLight",
"title": "Dim light",
"summary": "Command a particular streetlight to dim the lights.",
"traits": [
{
"$ref": "#/components/messageTraits/commonHeaders"
}
],
"payload": {
"$ref": "#/components/schemas/dimLightPayload"
}
}
},
"schemas": {
"lightMeasuredPayload": {
"type": "object",
"properties": {
"lumens": {
"type": "integer",
"minimum": "0",
"description": "Light intensity measured in lumens."
},
"sentAt": {
"$ref": "#/components/schemas/sentAt"
}
}
},
"turnOnOffPayload": {
"type": "object",
"properties": {
"command": {
"type": "string",
"enum": [ "on", "off" ],
"description": "Whether to turn on or off the light."
},
"sentAt": {
"$ref": "#/components/schemas/sentAt"
}
}
},
"dimLightPayload": {
"type": "object",
"properties": {
"percentage": {
"type": "integer",
"description": "Percentage to which the light should be dimmed to.",
"minimum": "0",
"maximum": "100"
},
"sentAt": {
"$ref": "#/components/schemas/sentAt"
}
}
},
"sentAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when the message was sent."
}
},
"securitySchemes": {
"saslScram": {
"type": "scramSha256",
"description": "Provide your username and password for SASL/SCRAM authentication"
}
},
"parameters": {
"StreetlightId": {
"description": "The ID of the streetlight.",
"schema": {
"type": "string"
}
}
},
"messageTraits": {
"commonHeaders": {
"headers": {
"type": "object",
"properties": {
"my-app-header": {
"type": "integer",
"minimum": "0",
"maximum": "100"
}
}
}
}
},
"operationTraits": {
"kafka": {
"bindings": {
"kafka": {
"clientId": {
"type": "string",
"enum": [ "my-app-id" ]
}
}
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
namespace LEGO.AsyncAPI.E2E.Tests.Readers.Samples.AsyncApi
{
using System;
using System.Linq;
using LEGO.AsyncAPI.Models;
using LEGO.AsyncAPI.Models.Bindings.OperationBindings;
Expand Down Expand Up @@ -53,6 +54,12 @@ public void CompleteJsonWithKafkaSpecExampleData()
this.AssertKafkaSpecExample(output);
}

[Fact]
public void CompleteJsonWithMissingRefKafkaSpecExampleData()
{
Assert.Throws<Exception>(() => this.AsyncApiAsyncApiReader.Read(this.GetStream("MissingRefCompleteKafkaSpec.json")));
}

[Fact]
public void CompleteJsonWithKafkaSpecExampleDataDeserializedTwice()
{
Expand Down