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

feat: integration-service and integration-config-template for AsyncAPI CLI #233

Closed
imabp opened this issue Feb 14, 2022 · 4 comments
Closed
Labels
enhancement New feature or request

Comments

@imabp
Copy link
Member

imabp commented Feb 14, 2022

Reason/Context

Please try answering few of those questions

  • Why we need this improvement?
    Currently, every command has to be separately integrated, like diff, validate, so to avoid this manually adding things everytime, why not design an integration-configuration-template and integrationService which will be used to add more integrations to cli, and probably less work we have to do..

  • How will this change help?
    Devleoper Experience

  • What is the motivation?
    CLI itself.

FLOW

asyncapi integrate add --config="./integrationName.config.json"
This will create an integration service, up and running, folks can use the integration commands using

asyncapi integratationName commandName

To delete an integration
asyncapi integrate delete integrationName

To list out all integrations
asyncapi integrate list

With addition to this, we bring in cli with default integrationConfigs, like validate, new, diff, in an integrations/_default/ directory, which will be used for default integrations, to make sure, CLI is usable in first use.

A great benefit will be, this will make CLI highly customizable, and folks can build more integrations on top of it.

Need some inputs and views from the community, how you feel about this idea, we can brainstorm on this, soon after V1 release? And definitely like to work on it

@imabp imabp added the enhancement New feature or request label Feb 14, 2022
@magicmatatjahu
Copy link
Member

I don't understand one thing, is this integration to be done in cli itself or on the library side? If on the cli side why call it an integration and not a command?

Similar idea: asyncapi/community#249

@imabp
Copy link
Member Author

imabp commented Feb 14, 2022

Yeah, thats the crux, we need to build the integration-config inside the respective libraries, and the format of integration-config will be decided by cli.

I guess by name convention we can name it as commandIntegrationService

@magicmatatjahu
Copy link
Member

Thanks! So I think that we should go with asyncapi/community#249 direction. We don't only have CLI but also Studio and ServerAPI to make integration. Also I'm not fan to create such a command, because it's a copy paste of simple file. We should rather focus on discussing how to do this generically, not just looking at the CLI but at the overall problem of integration in other tools

@imabp
Copy link
Member Author

imabp commented Feb 14, 2022

Yes you are right. We can take the conversation up there :)

@imabp imabp closed this as completed Feb 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants