I was taking a crack at this and trying to break it up into phases. The first step was trying to make a Migration system for the Json Nodes. Take in the json node tree and apply transformations to migrate them up or down. This would work like the JS tool asyncapi/converter-js. This would allow the library to read 3.0.0 but users would still only be able to consume the 2.6.0 models. This gets us a step in the right direction.

The next part is more annoying but also I think it allows the project to be cleaned up a bit. I would suggest the following to be done.

Move the readers and their helpers from AsyncAPI.Readers into AsyncAPI.
Move the models and deserializers from from AsycnAPI.Reader into it's own library AsyncApi.Models.2
Add migrations between versions inside of AsyncApi.
Move the writers from AsyncApi into AsyncApi.Models.2.
Create new library AsycnApi.Models.3.

The idea would be that the base AsyncApiLibrary would have the helper types, readers and base writer classes defined. Then each of the model libraries could add extension methods for reading and righting to their own version.

using LEGO.AsyncApi;
using LEGO.AsyncApi.Models.2;
using LEGO.AsyncApi.Models.3;
using AsyncApiDocument2 = LEGO.AsyncApi.Models.2.AsyncApiDocument;
using AsyncApiDocument3 = LEGO.AsyncApi.Models.3AsyncApiDocument;

public static class Example 
{
   public static async Task Writing()
   {
       AsyncApiWriter writer = new AsyncApiWriter();
       AsyncApiDocument2  doc2= new AsyncApiDocument2 ();
       AsyncApiDocument3 doc3 = new AsyncApiDocument3 ();

       // I doubt we would need this generic extensions since at the end of the day we are just saving json/yaml 
        await writer.WriteAsync(doc2);  // Extension method added by Models.2
        await writer.WriteAsync(doc3 ); // Extension method added by Models.2
   }
   
   public static void Read(Stream stream) 
   {
         AsyncApiReader reader = new AsyncApiReader();

         // Generic read
         AsyncApiDocumentBase baseDic = await reader.ReadAsync(stream);
         // Explicit read 
         AsyncApiDocument2  doc2 = awaitReader.ReadV2Async(stream); // extension method  by Models.2
         AsyncApiDocument3  doc3 = awaitReader.ReadV3Async(stream); // extension method by Models.3
    }
}

To do the GenericRead version we would have to do a plugin model and switch on the Version property in the doc.

There are other directions that can be taken as well, this was just my 2c

Add support for AsyncAPI v3 #167

Description

Metadata

Metadata

Assignees

Labels

Type

Fields

Projects

Milestone

Relationships

Development

Issue actions