Skip to content

UI/UX: Deprecated API Endpoints Lack Clear Deprecation Headers #2238

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

Open
tomaioo wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −2
Open

UI/UX: Deprecated API Endpoints Lack Clear Deprecation Headers #2238

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions flexmeasures/api/v3_0/deprecated.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
from flask_security import auth_required, current_user
from webargs.flaskparser import use_args


def _deprecation_headers():
return {
"Deprecation": "true",
"Sunset": "Sat, 01 Jan 2025 00:00:00 GMT",
"Link": '</sensors/{id}/data>; rel="successor-version"',
}

from flexmeasures.api.common.schemas.sensor_data import (
GetSensorDataSchema,
GetSensorDataSchemaEntityAddress,
Expand Down Expand Up @@ -53,7 +61,7 @@ def get_data_deprecated(self, sensor_data_description: dict):
sensor_data_description
)
d, s = request_processed()
return dict(**response, **d), s
return dict(**response, **d), s, _deprecation_headers()

@route("/data", methods=["POST"])
@use_args(
Expand Down Expand Up @@ -81,4 +89,4 @@ def post_data_deprecated(self, data: dict):
f"User {current_user} called the deprecated endpoint /sensors/data for sensor {sensor_id}. Should start using /sensors/{sensor_id}/data."
)
response, code = save_and_enqueue(bdf)
return response, code
return response, code, _deprecation_headers()
Loading