Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Migrate to target arch #212

Open
2 tasks done
yurvon-screamo opened this issue May 21, 2024 · 2 comments
Open
2 tasks done

[FEATURE] Migrate to target arch #212

yurvon-screamo opened this issue May 21, 2024 · 2 comments
Milestone

Comments

@yurvon-screamo
Copy link
Collaborator

Why do we need this improvement?

  • Ensuring the possibility of development
  • Simplifying the support process

How will this change help?

The adoption of an architectural decision will determine the possible vector of development for the near (or long) time

Screenshots

image

How could it be implemented/designed?

The current architecture proposal is shown in the picture.

The main ideas:

  • separating the implementation of document generation from the delivery of the document in the right form to the right place
  • relying on schema from the LEGO library
  • maintaining the ability to migrate (ideally seamlessly) users from an existing version
  • full openness to new ways of generating documents (both within the framework of our new functionality and within the framework of implementation at the user application level)
  • full openness to new scenarios for using the generated document (both within the framework of our new functionality and within the framework of implementation at the user application level)

I did not aim to reflect the architecture of the current implementation.
On the contrary, the main purpose of this is to turn the library into some kind of platform, open both to implement new ways of converting code into asyncapi document, and to further obtain this document in the desired form.

Please note that this issue does not address the issue of nuget package delivery. Here we will not define a possible list of them or anything else. (However, I believe that adopting such an architecture will greatly simplify this process in the future)

🚧 Breaking changes

Yes

👀 Have you checked for similar open issues?

  • I checked and didn't find a similar issue

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue?

Yes I am willing to submit a PR!

@yurvon-screamo
Copy link
Collaborator Author

I'm waiting for comments from the community and starting to implement

@yurvon-screamo yurvon-screamo added this to the arch milestone May 21, 2024
@yurvon-screamo
Copy link
Collaborator Author

Additionally, I have compiled a list of issue authors for whom this approach would be useful:

#62
#101
#136
#152
#160

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant