UI/UX: Deprecated API Endpoints Lack Clear Deprecation Headers#2238
Open
tomaioo wants to merge 1 commit into
Open
UI/UX: Deprecated API Endpoints Lack Clear Deprecation Headers#2238tomaioo wants to merge 1 commit into
tomaioo wants to merge 1 commit into
Conversation
The deprecated SensorEntityAddressAPI endpoints in deprecated.py only log warnings and include deprecation notices in docstrings, but do not send standard HTTP deprecation headers (like Sunset or Deprecation headers) that automated clients and developers rely on to detect deprecated APIs programmatically. Signed-off-by: tomaioo <203048277+tomaioo@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
UI/UX: Deprecated API Endpoints Lack Clear Deprecation Headers
Problem
Severity:
Medium| File:flexmeasures/api/v3_0/deprecated.py:L28The deprecated SensorEntityAddressAPI endpoints in deprecated.py only log warnings and include deprecation notices in docstrings, but do not send standard HTTP deprecation headers (like Sunset or Deprecation headers) that automated clients and developers rely on to detect deprecated APIs programmatically.
Solution
Add HTTP deprecation headers such as 'Deprecation: true', 'Sunset: ', and 'Link: ; rel="successor-version"' to deprecated endpoints. This follows RFC 8594 and improves developer experience by making deprecation machine-readable.
Changes
flexmeasures/api/v3_0/deprecated.py(modified)