api/types: rename container.StatsResponse to StatsResponseReader #48041
Conversation
This file contains hidden or 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
commit 17c3269 moved the ContainerStats type to the container package, and renamed it to StatsResponse. However, this name is chosen poorly, as it documents it to be the response of the API endpoint, but is more accurately a wrapper around a reader, used to read a (stream of) StatsJSON. We want to change StatsJSON to StatsResponse, as it's more consistent with other response types. As 17c3269 did not make it into a non-pre-release, we can still change this. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
vvoland
approved these changes
Jun 20, 2024
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.
api/types: move stats-types to api/types/container
commit 17c3269 moved the ContainerStats type to the container package, and renamed it to StatsResponse. However, this name is chosen poorly, as it documents it to be the response of the API endpoint, but is more accurately a wrapper around a reader, used to read a (stream of) StatsJSON. We want to change StatsJSON to StatsResponse, as it's more consistent with other response types.
As 17c3269 did not make it into a non-pre-release, we can still change this.
- A picture of a cute animal (not mandatory but encouraged)