CLI-3563: ASYNCAPI 2 Schema registry stand alone module

Open
#1,872 1 comment 1 reaction 1 assignee View on GitHub

Maintainers usually reply within 1 day

@kcorman0 is already working on this.

Since May 9, 2023.

Assessment

This issue has not been assessed yet.

Description

enhancement

We find very useful this new feature, but I doesn't 100% in our use case. To be honest is a great idea, but maybe having and stand alone module to obtain the schema from asyncapi definition could be enough for us.

This is our use case :

Our Current Use Case:
  • Users define their events in avro format in their API repository. When they want to publish their schemas they call a job that executes several actions, some of them being:

    1) A custom library is called that merge all files with the definitions, including both the common metadata for all company events and the specific payload for each project, and generates the schema to be published in the schema registry.
    2) The schema is validated and compatibility (FORWARD_TRANSITIVE) is checked. If compatibility condition is not met the job fails
    3) Once everything has been validated the schema is published in the schema registry
    

  • Our users can define their schemas for both on Prem and Cloud environments (though even for cloud environment we are not using confluent cloud schema registry) and we use a custom subject naming strategy as we need to assign the same subject to multiple topics.
        
Request:    

Being able to allow users to define their events only in AsyncAPI form instead of avro will make their job easier so we would like to be able to use the AsyncAPI CLI tool, having just the tool that converts from AsyncAPI definition into an schema as a stand alone module would also be quite helpful as we would be able to integrate that functionality into our process.

If it's not possible, maybe could be a good point to:

  • Being able to configure some of the process steps like the schema registry endpoint or the subject naming strategy, as we need to be able to call on prem SRs and we use a custom naming strategy.
  • Being able to define which steps we want to execute: There are several steps we don't allow, like automatic topic creation, changing compatibility mode or flag creation.

Please don't hesitate to ask anything,
Thanks
 

Dominant language
Go
Stars
82
Forks
37
Avg merge
1d 13h
Merged PRs (30d)
22

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from confluentinc/cli

All issues in confluentinc/cli

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.