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 REQUEST] Support flatbuffers schema files #163

Closed
mpe85 opened this issue Feb 26, 2019 · 15 comments
Closed

[FEATURE REQUEST] Support flatbuffers schema files #163

mpe85 opened this issue Feb 26, 2019 · 15 comments
Labels

Comments

@mpe85
Copy link

mpe85 commented Feb 26, 2019

It would be nice to be able to document flatbuffers payload using AsyncApi.
I think this shouldn't be a big deal, because protobuf (which is similar to flatbuffers) support is already announced for 2.0.
Have you already thought about this?

@fmvilas
Copy link
Member

fmvilas commented Feb 26, 2019

I heard about flatbuffers once but didn't pay so much attention because nobody ever told me they were using it. I do see the value of having support but we're a small team and already have a lot to do in front of us. You're right, using it on version 2.0.0 would be possible because we don't restrict payloads to any language. However, there needs to be tooling supporting it. The only piece I see missing is a flatbuffers->jsonschema converter. Would you like to participate in the development of the flatbuffers support?

@mpe85
Copy link
Author

mpe85 commented Feb 26, 2019

There is the possibility to convert a flatbuffers fbl fbs file to a JSON schema file by specifying the option --jsonschema when running the flatbuffers compiler (flatc).
See here google/flatbuffers#4369
Maybe this could be used somehow by AsyncApi?

@fmvilas
Copy link
Member

fmvilas commented Feb 27, 2019

Yeah, I see this is possible using the CLI, but we'd need to have it as a separate library for the parser to understand it. I see it's C++ and we're currently writing the parser in Go. It shouldn't be very different though. We can do it ourselves but again, it would be much appreciated if you could help to contributing to this effort. Even if it's just created such library so we can afterward create the schema parser.

@mpe85
Copy link
Author

mpe85 commented Feb 28, 2019

Are there any guidelines or specifications about how such a library should look like?

@fmvilas
Copy link
Member

fmvilas commented Feb 28, 2019

Not really. I was talking about a generic library that's capable of transforming flatbuffers to jsonschema. Something totally unrelated to AsyncAPI but that AsyncAPI would use. You can take as an example existing libraries to translate from protobuf to jsonschema, for example.

@mpe85
Copy link
Author

mpe85 commented Mar 1, 2019

I guess a Java library would be of no use for you?

Since I'm very deep in the Java world, I am probably able to implement it in Java very quickly.
My C/C++ skills got very rusty over the years (about 10 years ago I used it the last time), and concerning Go I have no experience at all.

@fmvilas
Copy link
Member

fmvilas commented Mar 1, 2019

I hear ya! Neither we have experience in Go but we chose it because it's good compiling to C libraries, performant, and its ever-growing community. So, in short, yes, it has to be written in Go.

@stale
Copy link

stale bot commented Oct 29, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Oct 29, 2019
@fmvilas fmvilas removed the stale label Oct 30, 2019
@stale
Copy link

stale bot commented Dec 29, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Dec 29, 2019
@stale stale bot closed this as completed Jan 5, 2020
@zamazan4ik
Copy link

zamazan4ik commented Dec 3, 2021

@fmvilas sorry for necroposting but my question is the same: Does AsyncAPI now support Flatbuffers? We are investigating the possibility to describe our event-based API with AsyncAPI, and our underlying format will be Flatbuffers.

@jonaslagoni
Copy link
Member

@zamazan4ik you might want to take a look at #622. I think that will enable your use-case. For all schemas, protobuf, Flatbuffers, whatever you need.

@jonaslagoni jonaslagoni reopened this Dec 3, 2021
@zamazan4ik
Copy link

Thanks! It seems like exactly what I need. I just suggest don't close this issue until the proposal will not be merged. I think it will be more convenient for other people with the same question.

@github-actions github-actions bot removed the stale label Dec 4, 2021
@github-actions
Copy link

github-actions bot commented Apr 4, 2022

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

Copy link

github-actions bot commented Dec 8, 2023

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Dec 8, 2023
@smoya
Copy link
Member

smoya commented Feb 5, 2024

@zamazan4ik we do have now support for protobuf but not for flatbuffers. I see this issue has not have any activity since time ago, so I'm gonna close it as won't do for now.

Please open a new request or RFC if you believe support for flatbuffers should happen. Thanks.

@smoya smoya closed this as completed Feb 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants