agent first api

Author: CamDavidsonPilon

CHANGELOG.md

@@ -4,10 +4,19 @@
 
  - Renamed `/api/is_local_access_point_active` to `/api/local_access_point` (now returns `{active: <bool>}`).
  - Consolidated experiment profile routes under `/api/experiment_profiles` and `/api/experiments/<experiment>/experiment_profiles/*`. Removed `/api/contrib/experiment_profiles` and `/api/experiment_profiles/running/experiments/<experiment>`. `PATCH` now targets `/api/experiment_profiles/<filename>`.
+ - Consolidated config API routes under `/api/config/*`: `/api/units/<pioreactor_unit>/configuration` is now `/api/config/units/<pioreactor_unit>`, and `/api/configs` + `/api/configs/<filename>` + `/api/configs/<filename>/history` are now `/api/config/files` + `/api/config/files/<filename>` + `/api/config/files/<filename>/history`.
+ - Removed `/api/contrib/*` endpoints in favor of resource-scoped routes: `/api/automations/descriptors/<automation_type>`, `/api/jobs/descriptors`, `/api/charts/descriptors`, and `/api/datasets/exportable*`.
+ - Renamed `pio jobs remove` to `pio jobs purge`.
+ - Replaced `pio jobs running` with `pio jobs list running` (`list running` is now a running-only filter of `pio jobs list` output).
 
 #### Enhancements
 
  - Added `/api/units/<pioreactor_unit>/jobs/stop/experiments/<experiment>` to mirror worker stop-all behavior.
+ - Normalized calibration route parameter naming to `calibration_name` across API and unit API calibration endpoints for more consistent endpoint templates.
+
+#### Bug fixes
+
+ - Fixed `/api/config/units/$broadcast` to correctly merge each unit's own `config_<unit>.ini` instead of using a shared `config_$broadcast.ini` path.
 
 ### 26.2.3
 

core/pioreactor/cli/pio.py

@@ -495,28 +495,11 @@ def _format_job_history_line(
     )
 
 
-@jobs.command(name="running", short_help="show status of running job(s)")
-def job_running() -> None:
-
-    from pioreactor.utils.job_manager import JobManager
-
-    with JobManager() as jm:
-        jobs = jm.list_jobs(
-            all_jobs=True,
-        )
-
-    for job_name, _pid, found_job_id, *_ in jobs:
-        job_id_label = click.style(f"[job_id={found_job_id}]", fg="cyan")
-        job_name_label = click.style(job_name, fg="green", bold=True)
-        click.echo(f"{job_id_label} {job_name_label} is running.")
-
-
-@jobs.command(name="list", short_help="list jobs current and previous")
-def job_history() -> None:
+def _show_job_history(running_only: bool = False) -> None:
     from pioreactor.utils.job_manager import JobManager
 
     with JobManager() as jm:
-        jobs = jm.list_job_history()
+        jobs = jm.list_job_history(running_only=running_only)
 
     if not jobs:
         click.echo("No jobs recorded.")
@@ -526,6 +509,18 @@ def job_history() -> None:
         click.echo(_format_job_history_line(*job))
 
 
+@jobs.group(name="list", short_help="list jobs current and previous", invoke_without_command=True)
+@click.pass_context
+def job_list(ctx: click.Context) -> None:
+    if ctx.invoked_subcommand is None:
+        _show_job_history()
+
+
+@job_list.command(name="running", short_help="show status of running job(s)")
+def job_list_running() -> None:
+    _show_job_history(running_only=True)
+
+
 def _format_timestamp_to_seconds(timestamp: str | None) -> str:
 
     if timestamp is None:
@@ -618,10 +613,10 @@ def _stringify(val: Any) -> str:
         )
 
 
-@jobs.command(name="remove", short_help="remove a job record")
+@jobs.command(name="purge", short_help="remove a job record")
 @click.option("--job-id", type=click.INT)
 @click.option("--job-name", type=click.STRING)
-def job_remove(job_id: int | None, job_name: str | None) -> None:
+def job_purge(job_id: int | None, job_name: str | None) -> None:
     if job_id is None and job_name is None:
         click.echo("Provide --job-id or --job-name.")
         return

core/pioreactor/config.py

@@ -166,7 +166,7 @@ def get_config() -> ConfigParserMod:
             global_config_path = "/home/pioreactor/.pioreactor/config.ini"
 
     if os.environ.get("LOCAL_CONFIG") is not None:
-        local_config_path = os.environ["GLOBAL_CONFIG"]
+        local_config_path = os.environ["LOCAL_CONFIG"]
     elif os.environ.get("DOT_PIOREACTOR") is not None:
         local_config_path = os.environ["DOT_PIOREACTOR"] + "/unit_config.ini"
     else:

core/pioreactor/web/api.py

@@ -1643,12 +1643,12 @@ def get_calibrations(pioreactor_unit: str, device: str) -> DelayedResponseReturn
     return create_task_response(task)
 
 
-@api_bp.route("/workers/<pioreactor_unit>/calibrations/<device>/<cal_name>", methods=["GET"])
-def get_calibration(pioreactor_unit: str, device: str, cal_name: str) -> DelayedResponseReturnValue:
+@api_bp.route("/workers/<pioreactor_unit>/calibrations/<device>/<calibration_name>", methods=["GET"])
+def get_calibration(pioreactor_unit: str, device: str, calibration_name: str) -> DelayedResponseReturnValue:
     if pioreactor_unit == UNIVERSAL_IDENTIFIER:
-        task = broadcast_get_across_workers(f"/unit_api/calibrations/{device}/{cal_name}")
+        task = broadcast_get_across_workers(f"/unit_api/calibrations/{device}/{calibration_name}")
     else:
-        task = tasks.multicast_get(f"/unit_api/calibrations/{device}/{cal_name}", [pioreactor_unit])
+        task = tasks.multicast_get(f"/unit_api/calibrations/{device}/{calibration_name}", [pioreactor_unit])
     return create_task_response(task)
 
 
@@ -1864,12 +1864,15 @@ def abort_calibration_session(pioreactor_unit: str, session_id: str) -> Response
     )
 
 
-@api_bp.route("/workers/<pioreactor_unit>/active_calibrations/<device>/<cal_name>", methods=["PATCH"])
-def set_active_calibration(pioreactor_unit, device, cal_name) -> DelayedResponseReturnValue:
+@api_bp.route("/workers/<pioreactor_unit>/active_calibrations/<device>/<calibration_name>", methods=["PATCH"])
+def set_active_calibration(pioreactor_unit, device, calibration_name) -> DelayedResponseReturnValue:
     if pioreactor_unit == UNIVERSAL_IDENTIFIER:
-        task = broadcast_patch_across_workers(f"/unit_api/active_calibrations/{device}/{cal_name}")
+        task = broadcast_patch_across_workers(f"/unit_api/active_calibrations/{device}/{calibration_name}")
     else:
-        task = tasks.multicast_patch(f"/unit_api/active_calibrations/{device}/{cal_name}", [pioreactor_unit])
+        task = tasks.multicast_patch(
+            f"/unit_api/active_calibrations/{device}/{calibration_name}",
+            [pioreactor_unit],
+        )
     return create_task_response(task)
 
 
@@ -1902,12 +1905,15 @@ def remove_active_status_estimator(pioreactor_unit, device) -> DelayedResponseRe
     return create_task_response(task)
 
 
-@api_bp.route("/workers/<pioreactor_unit>/calibrations/<device>/<cal_name>", methods=["DELETE"])
-def delete_calibration(pioreactor_unit, device, cal_name) -> DelayedResponseReturnValue:
+@api_bp.route("/workers/<pioreactor_unit>/calibrations/<device>/<calibration_name>", methods=["DELETE"])
+def delete_calibration(pioreactor_unit, device, calibration_name) -> DelayedResponseReturnValue:
     if pioreactor_unit == UNIVERSAL_IDENTIFIER:
-        task = broadcast_delete_across_workers(f"/unit_api/calibrations/{device}/{cal_name}")
+        task = broadcast_delete_across_workers(f"/unit_api/calibrations/{device}/{calibration_name}")
     else:
-        task = tasks.multicast_delete(f"/unit_api/calibrations/{device}/{cal_name}", [pioreactor_unit])
+        task = tasks.multicast_delete(
+            f"/unit_api/calibrations/{device}/{calibration_name}",
+            [pioreactor_unit],
+        )
     return create_task_response(task)
 
 
@@ -2069,7 +2075,7 @@ def upload() -> ResponseReturnValue:
     return jsonify({"message": "File successfully uploaded", "save_path": save_path}), 200
 
 
-@api_bp.route("/contrib/automations/<automation_type>", methods=["GET"])
+@api_bp.route("/automations/descriptors/<automation_type>", methods=["GET"])
 def get_automation_contrib(automation_type: str) -> ResponseReturnValue:
     # security to prevent possibly reading arbitrary file
     if automation_type not in {"temperature", "dosing", "led"}:
@@ -2102,7 +2108,7 @@ def get_automation_contrib(automation_type: str) -> ResponseReturnValue:
         abort_with(400, str(e))
 
 
-@api_bp.route("/contrib/jobs", methods=["GET"])
+@api_bp.route("/jobs/descriptors", methods=["GET"])
 def get_job_contrib() -> ResponseReturnValue:
     try:
         job_path_builtins = Path(os.environ["DOT_PIOREACTOR"]) / "ui" / "jobs"
@@ -2126,7 +2132,7 @@ def get_job_contrib() -> ResponseReturnValue:
         abort_with(400, str(e))
 
 
-@api_bp.route("/contrib/charts", methods=["GET"])
+@api_bp.route("/charts/descriptors", methods=["GET"])
 def get_charts_contrib() -> ResponseReturnValue:
     try:
         chart_path_builtins = Path(os.environ["DOT_PIOREACTOR"]) / "ui" / "charts"
@@ -2164,7 +2170,7 @@ def update_app_from_release_archive() -> DelayedResponseReturnValue:
     return create_task_response(task)
 
 
-@api_bp.route("/contrib/exportable_datasets", methods=["GET"])
+@api_bp.route("/datasets/exportable", methods=["GET"])
 def get_exportable_datasets() -> ResponseReturnValue:
     try:
         builtins = sorted((Path(os.environ["DOT_PIOREACTOR"]) / "exportable_datasets").glob("*.y*ml"))
@@ -2186,7 +2192,7 @@ def get_exportable_datasets() -> ResponseReturnValue:
         abort_with(400, str(e))
 
 
-@api_bp.route("/contrib/exportable_datasets/<target_dataset>/preview", methods=["GET"])
+@api_bp.route("/datasets/exportable/<target_dataset>/preview", methods=["GET"])
 def preview_exportable_datasets(target_dataset) -> ResponseReturnValue:
     builtins = sorted((Path(os.environ["DOT_PIOREACTOR"]) / "exportable_datasets").glob("*.y*ml"))
     plugins = sorted((Path(os.environ["DOT_PIOREACTOR"]) / "plugins" / "exportable_datasets").glob("*.y*ml"))
@@ -2210,7 +2216,7 @@ def preview_exportable_datasets(target_dataset) -> ResponseReturnValue:
     )
 
 
-@api_bp.route("/contrib/exportable_datasets/export_datasets", methods=["POST"])
+@api_bp.route("/datasets/exportable/export", methods=["POST"])
 def export_datasets() -> ResponseReturnValue:
     body = request.get_json()
 
@@ -2533,9 +2539,9 @@ def get_experiment(experiment: str) -> ResponseReturnValue:
 ## CONFIG CONTROL
 
 
-@api_bp.route("/units/<pioreactor_unit>/configuration", methods=["GET"])
-def get_configuration_for_pioreactor_unit(pioreactor_unit: str) -> ResponseReturnValue:
-    """get configuration for a pioreactor unit"""
+@api_bp.route("/config/units/<pioreactor_unit>", methods=["GET"])
+def get_config_for_pioreactor_unit(pioreactor_unit: str) -> ResponseReturnValue:
+    """get merged config for a pioreactor unit"""
     if pioreactor_unit == UNIVERSAL_IDENTIFIER:
         pioreactor_units = get_all_units()
     else:
@@ -2547,7 +2553,7 @@ def get_configuration_for_pioreactor_unit(pioreactor_unit: str) -> ResponseRetur
         try:
             global_config_path = Path(os.environ["DOT_PIOREACTOR"]) / "config.ini"
 
-            specific_config_path = Path(os.environ["DOT_PIOREACTOR"]) / f"config_{pioreactor_unit}.ini"
+            specific_config_path = Path(os.environ["DOT_PIOREACTOR"]) / f"config_{unit}.ini"
 
             config_files = [global_config_path, specific_config_path]
             config = configparser.ConfigParser(strict=False)
@@ -2556,14 +2562,14 @@ def get_configuration_for_pioreactor_unit(pioreactor_unit: str) -> ResponseRetur
             result[unit] = {section: dict(config[section]) for section in config.sections()}
 
         except Exception as e:
-            publish_to_error_log(str(e), "get_configuration_for_pioreactor_unit")
+            publish_to_error_log(str(e), "get_config_for_pioreactor_unit")
             abort_with(400, str(e))
 
     return result
 
 
-@api_bp.route("/configs/<filename>", methods=["GET"])
-def get_config(filename: str) -> ResponseReturnValue:
+@api_bp.route("/config/files/<filename>", methods=["GET"])
+def get_config_file(filename: str) -> ResponseReturnValue:
     """get a specific config.ini file in the .pioreactor folder"""
 
     # security bit: strip out any paths that may be attached, ex: ../../../root/bad
@@ -2585,12 +2591,12 @@ def get_config(filename: str) -> ResponseReturnValue:
         )
 
     except Exception as e:
-        publish_to_error_log(str(e), "get_config_of_file")
+        publish_to_error_log(str(e), "get_config_file")
         abort_with(400, str(e))
 
 
-@api_bp.route("/configs", methods=["GET"])
-def get_configs() -> ResponseReturnValue:
+@api_bp.route("/config/files", methods=["GET"])
+def get_config_files() -> ResponseReturnValue:
     """get a list of all config.ini files in the .pioreactor folder, _and_ are part of the inventory _or_ are leader"""
 
     all_workers = query_app_db("SELECT pioreactor_unit FROM workers;")
@@ -2617,8 +2623,8 @@ def allow_file_through(file_name: str):
     )
 
 
-@api_bp.route("/configs/<filename>", methods=["PATCH"])
-def update_config(filename: str) -> ResponseReturnValue:
+@api_bp.route("/config/files/<filename>", methods=["PATCH"])
+def update_config_file(filename: str) -> ResponseReturnValue:
     body = request.get_json()
     code = body["code"]
 
@@ -2673,26 +2679,26 @@ def update_config(filename: str) -> ResponseReturnValue:
 
     except configparser.DuplicateSectionError as e:
         msg = f"Duplicate section [{e.section}] was found. Please fix and try again."
-        publish_to_error_log(msg, "update_config")
+        publish_to_error_log(msg, "update_config_file")
         abort_with(400, msg)
     except configparser.DuplicateOptionError as e:
         msg = f"Duplicate option, `{e.option}`, was found in section [{e.section}]. Please fix and try again."
-        publish_to_error_log(msg, "update_config")
+        publish_to_error_log(msg, "update_config_file")
         abort_with(400, msg)
     except configparser.ParsingError:
         msg = "Incorrect syntax. Please fix and try again."
-        publish_to_error_log(msg, "update_config")
+        publish_to_error_log(msg, "update_config_file")
         abort_with(400, msg)
     except (AssertionError, configparser.NoSectionError, KeyError) as e:
         msg = f"Missing required field(s): {e}"
-        publish_to_error_log(msg, "update_config")
+        publish_to_error_log(msg, "update_config_file")
         abort_with(400, msg)
     except ValueError as e:
         msg = str(e)
-        publish_to_error_log(msg, "update_config")
+        publish_to_error_log(msg, "update_config_file")
         abort_with(400, msg)
     except Exception as e:
-        publish_to_error_log(str(e), "update_config")
+        publish_to_error_log(str(e), "update_config_file")
         msg = "Hm, something went wrong, check Pioreactor logs."
         abort_with(500, msg)
 
@@ -2711,7 +2717,7 @@ def update_config(filename: str) -> ResponseReturnValue:
     return {"status": "success"}, 200
 
 
-@api_bp.route("/configs/<filename>/history", methods=["GET"])
+@api_bp.route("/config/files/<filename>/history", methods=["GET"])
 def get_historical_config_for(filename: str) -> ResponseReturnValue:
     configs_for_filename = query_app_db(
         "SELECT filename, timestamp, data FROM config_files_histories WHERE filename=? ORDER BY timestamp DESC",

core/pioreactor/web/mcp.py

@@ -438,7 +438,7 @@ def db_query_db(query: str) -> list:
 @mcp.tool()
 def get_pioreactor_unit_configuration(pioreactor_unit: str) -> dict:
     """Get merged configuration for a given unit (global config.ini and unit-specific unit_config.ini)."""
-    return get_from_leader(f"/api/units/{pioreactor_unit}/configuration")
+    return get_from_leader(f"/api/config/units/{pioreactor_unit}")
 
 
 for tool, kwargs in registered_mcp_tools():

core/pioreactor/web/unit_api.py

@@ -1333,15 +1333,15 @@ def get_calibrations_by_device(device: str) -> ResponseReturnValue:
     return attach_cache_control(jsonify(calibrations), max_age=10)
 
 
-@unit_api_bp.route("/calibrations/<device>/<cal_name>", methods=["GET"])
-def get_calibration(device: str, cal_name: str) -> ResponseReturnValue:
-    calibration_path = CALIBRATION_PATH / device / f"{cal_name}.yaml"
+@unit_api_bp.route("/calibrations/<device>/<calibration_name>", methods=["GET"])
+def get_calibration(device: str, calibration_name: str) -> ResponseReturnValue:
+    calibration_path = CALIBRATION_PATH / device / f"{calibration_name}.yaml"
 
     if not calibration_path.exists():
         abort_with(
             404,
             "Calibration file does not exist.",
-            cause=f"Calibration '{cal_name}' missing for device '{device}'.",
+            cause=f"Calibration '{calibration_name}' missing for device '{device}'.",
             remediation="List available calibrations for the device and retry.",
         )
 
@@ -1412,10 +1412,10 @@ def get_estimator(device: str, estimator_name: str) -> ResponseReturnValue:
             )
 
 
-@unit_api_bp.route("/active_calibrations/<device>/<cal_name>", methods=["PATCH"])
-def set_active_calibration(device: str, cal_name: str) -> ResponseReturnValue:
+@unit_api_bp.route("/active_calibrations/<device>/<calibration_name>", methods=["PATCH"])
+def set_active_calibration(device: str, calibration_name: str) -> ResponseReturnValue:
     with local_persistent_storage("active_calibrations") as c:
-        c[device] = cal_name
+        c[device] = calibration_name
 
     return {"status": "success"}, 200