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

Kafka topic function arguments not aligned with API Spec #293

Open
steppi91 opened this issue Jun 9, 2022 · 0 comments
Open

Kafka topic function arguments not aligned with API Spec #293

steppi91 opened this issue Jun 9, 2022 · 0 comments

Comments

@steppi91
Copy link

steppi91 commented Jun 9, 2022

What happened?

Using the AivenClient functions for kafka topic handling (creation and updating) I expected a similar interface as in the HTTP API documentation (https://api.aiven.io/doc/#operation/ServiceKafkaTopicCreate, https://api.aiven.io/doc/#operation/ServiceKafkaTopicUpdate)

But the function arguments of AivenClient.create_service_topic and AivenClient.update_service_topic are very different:

Not all config parameters are exposed, and the exposed ones are deprecated since they should be in a config dict (namely min_insync_replicas, retention_bytes, retention_hours, cleanup_policy)

Also most of the parameters are mandatory, while the API lists any but topic_name as optional

What did you expect to happen?

Having the function signature in sync with the backing API, since they are basically only passed as a body to a generic client

What else do we need to know?

Versions:
aiven-client 2.15.0
API version v1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant