-
Notifications
You must be signed in to change notification settings - Fork 11
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
CLOUDP-277336: update endpoint removed change entries to include the sunset date #302
Conversation
@@ -126,7 +126,7 @@ func TestNewOasDiffEntriesFromSunsetEndpoints(t *testing.T) { | |||
Operation: "GET", | |||
OperationID: "listStreamInstances", | |||
Path: "/api/atlas/v2/groups/{id}/streams", | |||
Text: "endpoint removed", | |||
Text: "endpoint with API Version '2023-02-01' was removed as it has reached its sunset date '2023-07-12'", |
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.
I think from CL pov this might be confused, we're saying "endpoint removed" from the current version in the changelog.
maybe "endpoint removed (sunset date x)" to make it simple?
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.
I am not sure what is the suggested message 🤔
do you mean from endpoint with API Version '2023-02-01' was removed as it has reached its sunset date '2023-07-12'
to endpoint with API Version '2023-02-01' was removed (sunset date '2023-07-12)'
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.
no, only endpoint removed (sunset date '2023-07-12)'
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.
I think including the API version is important; otherwise, it may give the impression that the entire endpoint was removed, when in fact only a specific version was removed. Am I missing something?
Proposed changes
Jira ticket: CLOUDP-277336
This PR proposes the following changes:
newOasDiffEntriesFromSunsetEndpoints
to add only one changelog entry when the endpoint has reached sunset.I was able to test the fixes by following these steps: