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

Allow partial updates in the API #1940

Open
hariso opened this issue Nov 4, 2024 · 0 comments
Open

Allow partial updates in the API #1940

hariso opened this issue Nov 4, 2024 · 0 comments
Labels
feature New feature or request

Comments

@hariso
Copy link
Contributor

hariso commented Nov 4, 2024

Feature description

Currently, our APIs mostly allow full updates only in the sense that, if certain properties are mutable, then the update request updates all of them. One example is the UpdateProcessorRequest:

message Config {
  map<string, string> settings = 1;
  int32 workers = 2;
}

message UpdateProcessorRequest {
  string id = 1;
  Processor.Config config = 2;
}

In the processor service, the whole config is then replaced:

instance.Config = cfg

Link

This implies that, if a client wants to update just the workers (for example), it first needs to first fetch the existing settings, set the new workers count, and then send the update request. We have similar examples in other APIs (pipelines, connectors).

To make the API more convenient to use, it would be good to allow partial updates that allow only certain parts of a configuration to be updated.

@hariso hariso added feature New feature or request triage Needs to be triaged labels Nov 4, 2024
@github-project-automation github-project-automation bot moved this to Triage in Conduit Main Nov 4, 2024
@lovromazgon lovromazgon removed the triage Needs to be triaged label Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants