Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Keep track of sunset endpoints to return HTTP status 410 (Gone) responses #717

Merged
merged 24 commits into from Jun 13, 2023
Merged

Keep track of sunset endpoints to return HTTP status 410 (Gone) responses #717

merged 24 commits into from Jun 13, 2023

Conversation

Flix6x
Copy link
Contributor

@Flix6x Flix6x commented Jun 8, 2023 •
edited

This PR amends our sunset policy, as discussed in the TSC of 11 May 2023. Specifically, we decided to keep track of previously sunset endpoints, so they should always keep returning HTTP status 410 (Gone) rather than HTTP status 404 (Not Found) responses. We did this so we can simplify our sunset policy for FlexMeasures hosts from 4 to 3 phases.

Flix6x added 12 commits June 8, 2023 13:29
@Flix6x
Add docs backref
7978d0b 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
docs: remove deprecation stage 4
f3c5af3 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
remove deprecation stage 4
81d15b7 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
docs: update FLEXMEASURES_API_SUNSET_ACTIVE
e2dd94e 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: create util function for aborting with sunset info
e52ec31 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
feature: abort with sunset info
e2320ad 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: abort with sunset info in a more central place
9047faf 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: move registration of sunset API version to a central place
9ed241f 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: use loop to deprecate and sunset blueprints
e907309 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: collect all sunset routes in a central place
2dc1ef7 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
black
9a2eb2b 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
fix: resolve function name conflict
bf1ca58 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x added this to the 0.14.0 milestone Jun 8, 2023
@Flix6x Flix6x self-assigned this Jun 8, 2023
@Flix6x
docs: update changelog entry
dfb6d5e 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: revert previous refactoring for a function that is now agai…
359b80d 
…n only called once

Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x marked this pull request as ready for review June 8, 2023 19:11
@Flix6x Flix6x requested a review from nhoening June 8, 2023 19:12
nhoening
nhoening requested changes Jun 11, 2023
View reviewed changes
Copy link
Contributor

@nhoening nhoening left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I think I know how to improve readability.

flexmeasures/api/common/utils/deprecation_utils.py Outdated Show resolved Hide resolved
flexmeasures/api/common/utils/deprecation_utils.py Outdated Show resolved Hide resolved
flexmeasures/api/common/utils/deprecation_utils.py Outdated Show resolved Hide resolved
flexmeasures/api/sunset/__init__.py Show resolved Hide resolved
flexmeasures/api/sunset/__init__.py Outdated Show resolved Hide resolved
@Flix6x
Merge remote-tracking branch 'origin/main' into keep-410
24d2274
@Flix6x
Move dates into SUNSET_INFO
aec94b3 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
style: change order of items in SUNSET_INFO
ad3c258 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
style: change parameter name
ba4754e 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
docs: add module docstring
426d0b8 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
docs: clarify docstring
bc3c950 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
style: clarify function name
123a0eb 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
refactor: more legible if-else block by mirroring logic
b6fb0ce 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
fix use of SUNSET_INFO as kwargs
b7f7b07 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x requested a review from nhoening June 12, 2023 21:09
@Flix6x
feat: add test
cf96470 
Signed-off-by: F.N. Claessen <felix@seita.nl>
nhoening
nhoening approved these changes Jun 13, 2023
View reviewed changes
Copy link
Contributor

@nhoening nhoening left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, thanks!

@Flix6x Flix6x merged commit 4185880 into main Jun 13, 2023
7 checks passed
@Flix6x Flix6x deleted the keep-410 branch June 13, 2023 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nhoening nhoening nhoening approved these changes

Assignees

@Flix6x Flix6x

Labels
API deprecation
Projects
None yet
Milestone
0.14.0
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@Flix6x @nhoening