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

CLI: conduit processor-plugins describe PLUGIN #2028

Closed
raulb opened this issue Dec 18, 2024 · 0 comments · Fixed by #2088
Closed

CLI: conduit processor-plugins describe PLUGIN #2028

raulb opened this issue Dec 18, 2024 · 0 comments · Fixed by #2088
Assignees
Labels
feature New feature or request triage Needs to be triaged

Comments

@raulb
Copy link
Member

raulb commented Dec 18, 2024

Feature description

This command will describe the processor plugin configuration available.

It does require having Conduit previously running.

Arguments

Name Description Required Default Value
plugin processor plugin name Yes

--help

$ conduit processor-plugins describe PLUGIN

EXAMPLE:

$ conduit processor-plugins describe avro.decode
# auth.basic.password
type: string
description: This option is required if auth.basic.username contains a value. If both auth.basic.username and auth.basic.password are empty basic authentication is disabled.

# auth.basic.username
type: string
...

Note:

Something important to mention is that the endpoint will be the same of for listing plugins, but it'll use a regex to filter by a processor plugin name. e.g.: .*debezium.*) being possible to maybe list only by builtin ones, etc


Part of #1911

@raulb raulb added feature New feature or request triage Needs to be triaged labels Dec 18, 2024
@raulb raulb mentioned this issue Dec 18, 2024
42 tasks
@raulb raulb moved this from Triage to Todo in Conduit Main Dec 18, 2024
@maha-hajja maha-hajja self-assigned this Jan 22, 2025
This was referenced Jan 22, 2025
@maha-hajja maha-hajja moved this from Todo to Ready for review in Conduit Main Jan 22, 2025
@github-project-automation github-project-automation bot moved this from Ready for review to Done in Conduit Main Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request triage Needs to be triaged
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants