api: set last index and request time on alloc stop #16319
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some of the methods in `Allocations()` incorrectly use the `putQuery` in API calls where `put` is more appropriate since they are not reading information back. These methods are also not returning request metadata such as `LastIndex` back to callers, which can be useful to have in some scenarios. They also provide poor developer experience as they take an `*api.Allocation` struct when only the allocation ID is necessary. This can lead consumers to make unnecessary API calls to fetch the full allocation. Fixing these problems require updating the methods' signatures so they take `*WriteOptions` instead of `*QueryOptions` and return `*WriteMeta`, but this is a breaking change that requires advanced notice to consumers. This commit adds a future breaking change notice and also fixes the `Stop` method so it properly returns request metadata in a backwards compatible way.
lgfa29
commented
Mar 3, 2023
| @@ -0,0 +1,3 @@ | |||
| ```release-note:bug | |||
| api: Fix `Allocations().Stop()` method to properly set the request `LastIndex` and `RequestTime` in the response | |||
There was a problem hiding this comment.
This is the only user facing change, but should I note the future breaking changes somehow?
There was a problem hiding this comment.
make cl has a deprecation option, so I think we can add the release-note:deprecation to this file for those.
There was a problem hiding this comment.
Ah nice. I added the deprecation notes and I also remembered that I added RestartAllTasks() method to prevent a breaking change. Since we're breaking things already we may as well clean that up.
tgross
approved these changes
Mar 3, 2023
| @@ -0,0 +1,3 @@ | |||
| ```release-note:bug | |||
| api: Fix `Allocations().Stop()` method to properly set the request `LastIndex` and `RequestTime` in the response | |||
There was a problem hiding this comment.
make cl has a deprecation option, so I think we can add the release-note:deprecation to this file for those.
philrenaud
pushed a commit
that referenced
this pull request
Mar 14, 2023
Some of the methods in `Allocations()` incorrectly use the `putQuery` in API calls where `put` is more appropriate since they are not reading information back. These methods are also not returning request metadata such as `LastIndex` back to callers, which can be useful to have in some scenarios. They also provide poor developer experience as they take an `*api.Allocation` struct when only the allocation ID is necessary. This can lead consumers to make unnecessary API calls to fetch the full allocation. Fixing these problems require updating the methods' signatures so they take `*WriteOptions` instead of `*QueryOptions` and return `*WriteMeta`, but this is a breaking change that requires advanced notice to consumers. This commit adds a future breaking change notice and also fixes the `Stop` method so it properly returns request metadata in a backwards compatible way.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some of the methods in
Allocations()incorrectly use theputQueryin API calls whereputis more appropriate since they are not reading information back. These methods are also not returning request metadata such asLastIndexback to callers, which can be useful to have in some scenarios.They also provide poor developer experience as they take an
*api.Allocationstruct when only the allocation ID is necessary. This can lead consumers to make unnecessary API calls to fetch the full allocation.Fixing these problems require updating the methods' signatures so they take
*WriteOptionsinstead of*QueryOptionsand return*WriteMeta, but this is a breaking change that requires advanced notice to consumers.This commit adds a future breaking change notice and also fixes the
Stopmethod so it properly returns request metadata in a backwards compatible way.