howler-api 4.1.0.dev1577__tar.gz → 4.1.0.dev1582__tar.gz

{howler_api-4.1.0.dev1577 → howler_api-4.1.0.dev1582}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: howler-api
-Version: 4.1.0.dev1577
+Version: 4.1.0.dev1582
 Summary: Howler - API server
 License: MIT
 Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs

{howler_api-4.1.0.dev1577 → howler_api-4.1.0.dev1582}/howler/api/v1/action.py

@@ -4,6 +4,7 @@ from flask import Response, request
 
 import howler.actions as actions
 from howler.api import bad_request, created, forbidden, internal_error, make_subapi_blueprint, no_content, not_found, ok
+from howler.api.v1.utils.etag import add_etag
 from howler.api.v1.utils.params import parse_parameters, parse_refresh
 from howler.common.exceptions import HowlerException
 from howler.common.loader import datastore
@@ -46,6 +47,34 @@ def get_actions(**_) -> Response:
     return ok(datastore().action.search("*:*", as_obj=False)["items"])
 
 
+@generate_swagger_docs()
+@action_api.route("/<id>", methods=["GET"])
+@api_login(
+    audit=True,
+    check_xsrf_token=False,
+    required_type=["admin", "automation_basic", "automation_advanced", "actionrunner_basic", "actionrunner_advanced"],
+)
+@add_etag(getter=action_service.get_action)
+def get_action(id: str, record: Action | None, server_version: str, **kwargs) -> Response | tuple[Response, str]:
+    """Get an existing action.
+
+    Variables:
+    id  => The id of the action to retrieve
+
+    Optional Arguments:
+    None
+
+    Result Example:
+    {
+        ...action   # The requested action
+    }
+    """
+    if not record:
+        return not_found(err="The specified action does not exist")
+
+    return ok(record), server_version
+
+
 @generate_swagger_docs()
 @action_api.route("/", methods=["POST"])
 @api_login(audit=False, check_xsrf_token=False, required_type=["admin", "automation_basic", "automation_advanced"])

{howler_api-4.1.0.dev1577 → howler_api-4.1.0.dev1582}/howler/services/action_service.py

@@ -1,7 +1,7 @@
 import json
 from collections import defaultdict
 from importlib.util import find_spec
-from typing import Any, Optional, TypedDict
+from typing import Any, Literal, Optional, TypedDict, overload
 
 from cryptography.exceptions import InvalidTag
 from flask import Response, has_request_context, request
@@ -35,6 +35,41 @@ class TriggeredAction(TypedDict):
 _action_queues: dict[str, NamedQueue[TriggeredAction]] = {}
 
 
+@overload
+def get_action(
+    id: str, as_odm: Literal[True], version: Literal[True], user: User | None = None
+) -> tuple[Action, str]: ...
+
+
+@overload
+def get_action(id: str, as_odm: Literal[True], version: Literal[False]) -> Action: ...
+
+
+@overload
+def get_action(id: str, as_odm: Literal[True]) -> Action: ...
+
+
+@overload
+def get_action(id: str) -> Action: ...
+
+
+@overload
+def get_action(id: str, as_odm: Literal[False], version: Literal[True]) -> tuple[dict[str, Any], str]: ...
+
+
+@overload
+def get_action(id: str, as_odm: Literal[False], version: Literal[False]) -> dict[str, Any]: ...
+
+
+@overload
+def get_action(id: str, as_odm: Literal[False]) -> dict[str, Any]: ...
+
+
+def get_action(id: str, as_odm=False, version=False, user: User | None = None):
+    """Retrieve an action from the datastore as an ODM object or dictionary."""
+    return datastore().action.get_if_exists(key=id, as_obj=as_odm, version=version)
+
+
 def _is_builtin_operation(operation_id: str) -> bool:
     """Return whether an operation is implemented by Howler's built-in actions package."""
     return find_spec(f"howler.actions.{operation_id}") is not None

{howler_api-4.1.0.dev1577 → howler_api-4.1.0.dev1582}/pyproject.toml

@@ -152,7 +152,7 @@ suppress-none-returning = true
 [tool.poetry]
 package-mode = true
 name = "howler-api"
-version = "4.1.0.dev1577"
+version = "4.1.0.dev1582"
 description = "Howler - API server"
 authors = [
     "Canadian Centre for Cyber Security <howler@cyber.gc.ca>",