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

Upgrade to Async API 3.0? #7

Open
robert-sykes opened this issue Jan 19, 2024 · 7 comments · May be fixed by #11
Open

Upgrade to Async API 3.0? #7

robert-sykes opened this issue Jan 19, 2024 · 7 comments · May be fixed by #11
Assignees

Comments

@robert-sykes
Copy link
Contributor

Just looking through the code, I see we are aiming at Async API 2.6.0. I don't think 3.0 adds a huge amount to the schema, I'd have to have a look over the changes, but thought I'd check in to see if this is something we want to do?

We could add an addition that allows for selecting a version and generate the schema on that, i.e. Version 2, Version 3 on generate to output the appropriate schema.

Just thought dumping.

@Ferror
Copy link
Owner

Ferror commented Jan 19, 2024

Yeah, Async API 3.0 brings some major changes. I think separating concerns we should abstract the Schema class: https://github.com/Ferror/asyncapi-doc-bundle/blob/master/src/Schema.php

@robert-sykes
Copy link
Contributor Author

I agree, we can have an interface an implement version specific schemas. I imagine the Schema Generator may need abstracting too?

@Ferror Ferror linked a pull request Jan 25, 2024 that will close this issue
@Ferror Ferror self-assigned this Jan 25, 2024
@Ferror
Copy link
Owner

Ferror commented Jan 25, 2024

@robert-sykes I'm starting to build the Schema V3 generator. I need kinda to figure out the Attributes to it does not depend on Channel Type

@robert-sykes
Copy link
Contributor Author

@Ferror Sounds good - i've had a quick look over the related PR, it's looking good. I'll have a think about the Attributes when I get a chance to give this a proper look.

@Ferror
Copy link
Owner

Ferror commented Feb 3, 2024

@robert-sykes, I made the current setup work with Async API v3. It's not ideal, as it does not cover Operations yet, but it enables us to define attributes without thinking about the Schema Version. Feel free to code review PR's post-factum. I made sure created by application schemas are valid for both versions - GitHub action matrix 😄

@robert-sykes
Copy link
Contributor Author

@Ferror Hi fella, sorry, I am just coming back all this after working on a few unrelated projects. Whats the current status on the V3 Update? I can review the PR if it's ready.

@Ferror
Copy link
Owner

Ferror commented Apr 17, 2024

@robert-sykes I remember something is still missing. I will sit down and finish it during the May Holidays 😄

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

Successfully merging a pull request may close this issue.

2 participants