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

doc: Add documentation on how to directly interact with the schema registry #149

Open
nickchomey opened this issue Oct 2, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@nickchomey
Copy link
Contributor

The schema registry doc says

work directly with the schema registry (for example, in cases where automatic schema extraction isn't enough and a schema needs to be built manually using the information from a source)

But I dont really see much information on how to do that anywhere.

I see that there's a REST API for the Schema Registry

There is a schema.go package in the connector sdk and processor sdk. Is that we should use? It seems to have fewer functions than the REST API...

And the schema registry seems to use the franz sr package under the hood. Should that ever be used?

Some more docs on how to use it and especially with some real-world examples/use cases would be very helpful.

@nickchomey
Copy link
Contributor Author

I now see that the REST API is largely incomplete (I didnt notice that they were checkboxes and most are unchecked) and probably reflects the Get and Create functions in the sdks.

@raulb raulb added the documentation Improvements or additions to documentation label Oct 4, 2024
@lovromazgon
Copy link
Member

Yes, as you pointed out, the schema registry in Conduit is still incomplete. It only supports the functionality that's strictly required by Conduit, so that the user doesn't necessarily have to deploy another service to get the benefits that schemas bring.

The schema registry REST API is currently not exposed in Conduit at all, as it's missing a lot of important endpoints expected by a proper schema registry. Currently the only way to access schemas stored in the internal schema registry is through connectors or processors. However, you can configure an external schema registry like the Confluent schema registry or Apicurio and point Conduit to that service, then Conduit will store schemas there and you can use it with any other tool that knows how to work with a schema registry.

For now this means that we don't have much to document about the interaction with the schema registry, since it's not really exposed.

@lovromazgon lovromazgon changed the title Add documentation on how to directly interact with the schema registry doc: Add documentation on how to directly interact with the schema registry Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants