Let asset chart data rest on the registry of chart types

documentation/api/change_log.rst

@@ -8,6 +8,8 @@ API change log
 v3.0-35 | XX, 2026
 """"""""""""""""""
 - ``GET /api/v3_0/assets/<id>/chart`` now takes the public names of the asset chart types as ``chart-type``: ``default`` (the default) and ``charge-point-sessions``. The values it took so far, ``chart_for_multiple_sensors`` and ``chart_for_chargepoint_sessions``, are still accepted, as legacy values for ``default`` and ``charge-point-sessions``, respectively.
+- ``GET /api/v3_0/assets/<id>/chart_data`` now accepts ``chart-type``, as ``GET /api/v3_0/assets/<id>/chart`` does, with the same values, and then returns only the data that chart type draws. For ``default``, that leaves out the sensors which appear only in a graph titled "Charge Point sessions"; for ``charge-point-sessions``, it is the charging-session sensors, ``charge points power`` from "Power flow by type", and the "Prices" sensors. An unknown ``chart-type`` gets a ``422``. Without ``chart-type``, or with an empty one, it returns the data of every sensor in the asset's ``sensors_to_show``, as before.
+- ``GET /api/v3_0/assets/<id>/chart`` with ``include-data`` now likewise inlines only the data of the sensors the chosen chart type draws, where it used to inline the data of every sensor in the asset's ``sensors_to_show``. Without ``chart-type``, that is the ``default`` chart type.
 
 v3.0-34 | November 05, 2026
 """"""""""""""""""""""""""""

documentation/changelog.rst

@@ -10,6 +10,7 @@ v1.2.0 | December xx , 2026
 New features
 -------------
 * Asset and sensor charts have public chart type names (``default`` and ``charge-point-sessions`` for assets; ``bar-chart``, ``histogram``, ``daily-heatmap`` and ``weekly-heatmap`` for sensors), which the chart endpoints document and check, while they still accept the names they took so far; plugins can register their own asset and sensor chart types, which the asset and sensor pages offer where they apply [see `PR #2803 <https://www.github.com/FlexMeasures/flexmeasures/pull/2803>`_]
+* The data of an asset's chart can be asked for by the public chart type names, of the built-in chart types and of those that plugins register, and holds only the data of the sensors that chart type draws, also in an asset chart's CSV export and in a chart requested with its data from the API [see `PR #2805 <https://www.github.com/FlexMeasures/flexmeasures/pull/2805>`_]
 
 Infrastructure / Support
 -------------------------

flexmeasures/api/v3_0/assets.py

@@ -265,6 +265,7 @@ class AssetChartDataKwargsSchema(EventWindowSchema, BeliefTimeFilterSchema):
         "use_latest_version_per_event": "use-latest-version-per-event",
         "most_recent_beliefs_only": "most-recent-beliefs-only",
         "compress_json": "compress-json",
+        "chart_type": "chart-type",
     }
 
     use_latest_version_per_event = fields.Boolean(
@@ -289,15 +290,15 @@ class AssetChartDataKwargsSchema(EventWindowSchema, BeliefTimeFilterSchema):
             description="If true, compress the JSON response.",
         ),
     )
-    # For the asset page only, so left out of the API docs (see AssetChartDataOpenAPISchema):
-    # it takes the public chart type names the asset page sends, and the names of the chart functions it sent in v1.1.0,
-    # but is not yet validated against the registry of asset chart types (see issue #2802).
-    chart_type = fields.Str(
+    chart_type = AssetChartTypeField(
         data_key="chart-type",
         required=False,
+        accept_legacy_names=True,
+        empty_means_absent=True,
         metadata=dict(
-            description="Return only the data that this chart type draws, e.g. 'default' or 'charge-point-sessions'; without it, return the data of every sensor in the asset's sensors_to_show.",
-            example="default",
+            description=f"Return only the data of the sensors that this chart type draws: {describe_asset_chart_types(include_legacy_names=True)}. "
+            "Without it, or with an empty value, return the data of every sensor in the asset's sensors_to_show.",
+            example=DEFAULT_ASSET_CHART_TYPE,
         ),
     )
 
@@ -329,16 +330,10 @@ def __init__(self, *args, **kwargs):
 
 
 class AssetChartDataOpenAPISchema(AssetChartDataKwargsSchema):
-    """Doc-only variant of `AssetChartDataKwargsSchema`; see `AssetChartOpenAPISchema`.
-
-    It also hides `chart_type`, which only the asset page uses for now.
-    """
+    """Doc-only variant of `AssetChartDataKwargsSchema`; see `AssetChartOpenAPISchema`."""
 
     def __init__(self, *args, **kwargs):
-        kwargs["exclude"] = list(kwargs.get("exclude", [])) + [
-            "beliefs_after",
-            "chart_type",
-        ]
+        kwargs["exclude"] = list(kwargs.get("exclude", [])) + ["beliefs_after"]
         super().__init__(*args, **kwargs)