-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
docs/deprecated: update status of short cid alias deprecation #4949
Conversation
Starting with API v1.45, the container short ID is removed from the container Aliases. Signed-off-by: Albin Kerouanton <[email protected]>
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #4949 +/- ##
=======================================
Coverage 61.43% 61.43%
=======================================
Files 289 289
Lines 20241 20241
=======================================
Hits 12435 12435
Misses 6904 6904
Partials 902 902 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Do we need to mention that it's deprecated for API XX, but older API versions still having it? |
Is that something we usually do in |
It's a bit similar to #4893 (comment) - we don't recommend We should probably look (as discussed in the other PR) to more prominently add a link to the API history, as that's effectively the source of truth for API changes (including deprecations) |
Then, should we mention that only newer CLI versions are affected, ie. CLI v26 and above? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Glancing at previous deprecations, this should be sufficient on the CLI side.
The 1.45 deprecation does not mention the change telegraphed in 1.44:
I think all we need to do is make sure to add the change to API 1.45; with that change, this LGTM.
- What I did
Starting with API v1.45, the container short ID is removed from the container Aliases. Update the status for that deprecation.