api end point names

Author: CamDavidsonPilon

core/pioreactor/web/api.py

@@ -458,7 +458,7 @@ def shutdown_unit(pioreactor_unit: str) -> DelayedResponseReturnValue:
 
 
 @api_bp.route("/units/<pioreactor_unit>/system/utc_clock", methods=["GET"])
-def get_clocktime(pioreactor_unit: str) -> DelayedResponseReturnValue:
+def get_unit_utc_clock(pioreactor_unit: str) -> DelayedResponseReturnValue:
     if pioreactor_unit == UNIVERSAL_IDENTIFIER:
         task = broadcast_get_across_cluster("/unit_api/system/utc_clock")
     else:
@@ -467,7 +467,7 @@ def get_clocktime(pioreactor_unit: str) -> DelayedResponseReturnValue:
 
 
 @api_bp.route("/system/utc_clock", methods=["POST"])
-def set_clocktime() -> DelayedResponseReturnValue:
+def set_system_utc_clock() -> DelayedResponseReturnValue:
     # first update the leader:
     task1 = tasks.multicast_post(
         "/unit_api/system/utc_clock", [get_leader_hostname()], json=request.get_json()
@@ -1451,7 +1451,7 @@ def get_all_estimators(pioreactor_unit: str) -> DelayedResponseReturnValue:
 
 
 @api_bp.route("/workers/<pioreactor_unit>/zipped_calibrations", methods=["GET"])
-def get_all_calibrations_as_yamls(pioreactor_unit: str) -> ResponseReturnValue:
+def get_zipped_calibrations(pioreactor_unit: str) -> ResponseReturnValue:
     if pioreactor_unit == UNIVERSAL_IDENTIFIER:
         task = broadcast_get_across_workers("/unit_api/zipped_calibrations", return_raw=True)
     else:
@@ -1501,7 +1501,7 @@ def get_all_calibrations_as_yamls(pioreactor_unit: str) -> ResponseReturnValue:
 
 
 @api_bp.route("/units/<pioreactor_unit>/zipped_dot_pioreactor", methods=["GET"])
-def get_entire_dot_pioreactor(pioreactor_unit: str) -> ResponseReturnValue:
+def get_zipped_dot_pioreactor(pioreactor_unit: str) -> ResponseReturnValue:
     """Download a ZIP of ~/.pioreactor from one or all workers.
 
     - For a specific worker, fetch raw bytes from its unit_api and proxy as a download.
@@ -2038,7 +2038,7 @@ def get_app_versions(pioreactor_unit: str) -> DelayedResponseReturnValue:
 
 
 @api_bp.route("/system/upload", methods=["POST"])
-def upload() -> ResponseReturnValue:
+def upload_system_file() -> ResponseReturnValue:
     if (Path(os.environ["DOT_PIOREACTOR"]) / "DISALLOW_UI_UPLOADS").is_file():
         abort_with(403, "No UI uploads allowed")
 
@@ -2076,7 +2076,7 @@ def upload() -> ResponseReturnValue:
 
 
 @api_bp.route("/automations/descriptors/<automation_type>", methods=["GET"])
-def get_automation_contrib(automation_type: str) -> ResponseReturnValue:
+def get_automation_descriptors(automation_type: str) -> ResponseReturnValue:
     # security to prevent possibly reading arbitrary file
     if automation_type not in {"temperature", "dosing", "led"}:
         abort_with(
@@ -2099,17 +2099,17 @@ def get_automation_contrib(automation_type: str) -> ResponseReturnValue:
                 decoded_yaml = yaml_decode(file.read_bytes(), type=structs.AutomationDescriptor)
                 parsed_yaml[decoded_yaml.automation_name] = decoded_yaml
             except (ValidationError, DecodeError) as e:
-                publish_to_error_log(f"Yaml error in {Path(file).name}: {e}", "get_automation_contrib")
+                publish_to_error_log(f"Yaml error in {Path(file).name}: {e}", "get_automation_descriptors")
 
         return attach_cache_control(jsonify(list(parsed_yaml.values())))
 
     except Exception as e:
-        publish_to_error_log(str(e), "get_automation_contrib")
+        publish_to_error_log(str(e), "get_automation_descriptors")
         abort_with(400, str(e))
 
 
 @api_bp.route("/jobs/descriptors", methods=["GET"])
-def get_job_contrib() -> ResponseReturnValue:
+def get_job_descriptors() -> ResponseReturnValue:
     try:
         job_path_builtins = Path(os.environ["DOT_PIOREACTOR"]) / "ui" / "jobs"
         job_path_plugins = Path(os.environ["DOT_PIOREACTOR"]) / "plugins" / "ui" / "jobs"
@@ -2123,17 +2123,17 @@ def get_job_contrib() -> ResponseReturnValue:
                 decoded_yaml = yaml_decode(file.read_bytes(), type=structs.BackgroundJobDescriptor)
                 parsed_yaml[decoded_yaml.job_name] = decoded_yaml
             except (ValidationError, DecodeError) as e:
-                publish_to_error_log(f"Yaml error in {Path(file).name}: {e}", "get_job_contrib")
+                publish_to_error_log(f"Yaml error in {Path(file).name}: {e}", "get_job_descriptors")
 
         return attach_cache_control(jsonify(list(parsed_yaml.values())))
 
     except Exception as e:
-        publish_to_error_log(str(e), "get_job_contrib")
+        publish_to_error_log(str(e), "get_job_descriptors")
         abort_with(400, str(e))
 
 
 @api_bp.route("/charts/descriptors", methods=["GET"])
-def get_charts_contrib() -> ResponseReturnValue:
+def get_chart_descriptors() -> ResponseReturnValue:
     try:
         chart_path_builtins = Path(os.environ["DOT_PIOREACTOR"]) / "ui" / "charts"
         chart_path_plugins = Path(os.environ["DOT_PIOREACTOR"]) / "plugins" / "ui" / "charts"
@@ -2146,12 +2146,12 @@ def get_charts_contrib() -> ResponseReturnValue:
                 decoded_yaml = yaml_decode(file.read_bytes(), type=structs.ChartDescriptor)
                 parsed_yaml[decoded_yaml.chart_key] = decoded_yaml
             except (ValidationError, DecodeError) as e:
-                publish_to_error_log(f"Yaml error in {Path(file).name}: {e}", "get_charts_contrib")
+                publish_to_error_log(f"Yaml error in {Path(file).name}: {e}", "get_chart_descriptors")
 
         return attach_cache_control(jsonify(list(parsed_yaml.values())))
 
     except Exception as e:
-        publish_to_error_log(str(e), "get_charts_contrib")
+        publish_to_error_log(str(e), "get_chart_descriptors")
         abort_with(400, str(e))
 
 
@@ -2193,7 +2193,7 @@ def get_exportable_datasets() -> ResponseReturnValue:
 
 
 @api_bp.route("/datasets/exportable/<target_dataset>/preview", methods=["GET"])
-def preview_exportable_datasets(target_dataset) -> ResponseReturnValue:
+def preview_exportable_dataset(target_dataset: str) -> 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"))
 
@@ -2217,7 +2217,7 @@ def preview_exportable_datasets(target_dataset) -> ResponseReturnValue:
 
 
 @api_bp.route("/datasets/exportable/export", methods=["POST"])
-def export_datasets() -> ResponseReturnValue:
+def export_exportable_datasets() -> ResponseReturnValue:
     body = request.get_json()
 
     dataset_names: list[str] = body["datasets"]
@@ -2718,7 +2718,7 @@ def update_config_file(filename: str) -> ResponseReturnValue:
 
 
 @api_bp.route("/config/files/<filename>/history", methods=["GET"])
-def get_historical_config_for(filename: str) -> ResponseReturnValue:
+def get_config_file_history(filename: str) -> ResponseReturnValue:
     configs_for_filename = query_app_db(
         "SELECT filename, timestamp, data FROM config_files_histories WHERE filename=? ORDER BY timestamp DESC",
         (filename,),

core/pioreactor/web/unit_api.py

@@ -102,7 +102,7 @@ def check_hardware_for_model() -> DelayedResponseReturnValue:
 
 # Endpoint to check the status of a background task. unit_api is required to ping workers (who only expose unit_api)
 @unit_api_bp.route("/task_results/<task_id>", methods=["GET"])
-def task_status(task_id: str):
+def get_task_status(task_id: str):
     blob = {"task_id": task_id, "result_url_path": "/unit_api/task_results/" + task_id}
     try:
         task = huey.result(task_id)
@@ -214,7 +214,7 @@ def _locked_task_response(lock_name: str) -> ResponseReturnValue:
 
 
 @unit_api_bp.route("/system/update/<target>", methods=["POST", "PATCH"])
-def update_target(target: str) -> DelayedResponseReturnValue:
+def update_software_target(target: str) -> DelayedResponseReturnValue:
     if _task_is_locked("update-lock"):
         return _locked_task_response("update-lock")
 
@@ -239,7 +239,7 @@ def update_target(target: str) -> DelayedResponseReturnValue:
 
 
 @unit_api_bp.route("/system/update", methods=["POST", "PATCH"])
-def update() -> DelayedResponseReturnValue:
+def update_software() -> DelayedResponseReturnValue:
     if _task_is_locked("update-lock"):
         return _locked_task_response("update-lock")
 
@@ -257,7 +257,7 @@ def update() -> DelayedResponseReturnValue:
 
 
 @unit_api_bp.route("/system/reboot", methods=["POST", "PATCH"])
-def reboot() -> DelayedResponseReturnValue:
+def reboot_system() -> DelayedResponseReturnValue:
     """Reboots unit"""
     # TODO: only let requests from the leader do this. Use lighttpd conf for this.
     if _task_is_locked("power-lock"):
@@ -271,7 +271,7 @@ def reboot() -> DelayedResponseReturnValue:
 
 
 @unit_api_bp.route("/system/shutdown", methods=["POST", "PATCH"])
-def shutdown() -> DelayedResponseReturnValue:
+def shutdown_system() -> DelayedResponseReturnValue:
     """Shutdown unit"""
     if _task_is_locked("power-lock"):
         return _locked_task_response("power-lock")
@@ -442,7 +442,7 @@ def set_clock_time() -> DelayedResponseReturnValue:  # type: ignore[return]
 #### DIR
 @unit_api_bp.route("/system/path/", defaults={"req_path": ""})
 @unit_api_bp.route("/system/path/<path:req_path>")
-def dir_listing(req_path: str):
+def list_system_path(req_path: str):
     if os.path.isfile(Path(os.environ["DOT_PIOREACTOR"]) / "DISALLOW_UI_FILE_SYSTEM"):
         abort_with(
             403,
@@ -631,7 +631,7 @@ def get_all_long_running_jobs() -> ResponseReturnValue:
 
 
 @unit_api_bp.route("/jobs/settings/job_name/<job_name>", methods=["GET"])
-def get_settings_for_a_specific_job(job_name: str) -> ResponseReturnValue:
+def get_job_settings(job_name: str) -> ResponseReturnValue:
     """
     {
       "settings": {
@@ -658,7 +658,7 @@ def get_settings_for_a_specific_job(job_name: str) -> ResponseReturnValue:
 
 
 @unit_api_bp.route("/jobs/settings/job_name/<job_name>/setting/<setting>", methods=["GET"])
-def get_specific_setting_for_a_job(job_name: str, setting: str) -> ResponseReturnValue:
+def get_job_setting(job_name: str, setting: str) -> ResponseReturnValue:
     setting_metadata = query_temp_local_metadata_db(
         """
     SELECT s.setting, s.value FROM
@@ -694,7 +694,7 @@ def update_job(job_name: str) -> ResponseReturnValue:
 
 
 @unit_api_bp.route("/capabilities", methods=["GET"])
-def discover_jobs_and_settings_available() -> ResponseReturnValue:
+def get_capabilities() -> ResponseReturnValue:
     from pioreactor.utils.capabilities import collect_capabilities
 
     return jsonify(collect_capabilities())
@@ -747,7 +747,7 @@ def get_installed_plugins() -> ResponseReturnValue:
 
 
 @unit_api_bp.route("/plugins/installed/<filename>", methods=["GET"])
-def get_plugin(filename: str) -> ResponseReturnValue:
+def get_installed_plugin(filename: str) -> ResponseReturnValue:
     """get a specific Python file in the .pioreactor/plugin folder"""
     # security bit: strip out any paths that may be attached, ex: ../../../root/bad
     file = Path(filename).name
@@ -1088,7 +1088,7 @@ def get_all_estimators() -> ResponseReturnValue:
 
 
 @unit_api_bp.route("/zipped_calibrations", methods=["GET"])
-def get_all_calibrations_as_zipped_yaml() -> ResponseReturnValue:
+def get_zipped_calibrations() -> ResponseReturnValue:
     calibration_dir = CALIBRATION_PATH
 
     if not calibration_dir.exists():
@@ -1120,7 +1120,7 @@ def get_all_calibrations_as_zipped_yaml() -> ResponseReturnValue:
 
 
 @unit_api_bp.route("/zipped_dot_pioreactor", methods=["GET"])
-def get_entire_dot_pioreactor_as_zip() -> ResponseReturnValue:
+def get_zipped_dot_pioreactor() -> ResponseReturnValue:
     """Create and return a ZIP of the entire DOT_PIOREACTOR directory.
 
     Notes: