feat: add version deprecation and sunset eligibility #90
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
cmars
force-pushed
the
feat/deprecated-by-sunset
branch
from
64cb8e1
to
a16fd18
Compare
jcsackett
approved these changes
Dec 6, 2021
version.go
Outdated
| // DeprecatedBy returns true if the given version deprecates the caller target | ||
| // version. | ||
| func (v *Version) DeprecatedBy(vr *Version) bool { | ||
| return v.Compare(vr) < 0 |
There was a problem hiding this comment.
Why do < 0 here? The returns from Compare are only -1, 0, or 1, so == -1 makes more sense to me to show it's a particular value.
This is fine by me if your preference is to stick w/ < -- I'm curious if we would ever add any other values coming from Compare?
There was a problem hiding this comment.
We wouldn't, a direct == -1 would suffice here. Looking at this more carefully now, I'm now wondering, does a version deprecate itself? I'm thinking it probably shouldn't!
API documentation needs to represent a "changelog" per resource endpoint: a list of versions in which a change to a given resource endpoint was released. This change adds a list of other resource release versions in which a particular path was declared for such navigation purposes. Implements snyk#78.
cmars
force-pushed
the
feat/deprecated-by-sunset
branch
from
a16fd18
to
5ee777c
Compare
Annotate paths in a given resource version with the newer release version that deprecates it, and when the deprecated version may be sunset. This may be used in linting, middleware, and documentation. Implements snyk#86.
cmars
force-pushed
the
feat/deprecated-by-sunset
branch
from
5ee777c
to
6f6cb54
Compare
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.
Annotate paths in a given resource version with the newer release
version that deprecates it, and when the deprecated version may be
sunset.
This may be used in linting, middleware, and documentation.
Implements #86.
Stacked on #89.