streamlit-octostar-utils 0.5.0.dev17__tar.gz → 0.5.0.dev18__tar.gz

{streamlit_octostar_utils-0.5.0.dev17 → streamlit_octostar_utils-0.5.0.dev18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: streamlit-octostar-utils
-Version: 0.5.0.dev17
+Version: 0.5.0.dev18
 Summary: 
 License: MIT
 License-File: LICENSE

{streamlit_octostar_utils-0.5.0.dev17 → streamlit_octostar_utils-0.5.0.dev18}/pyproject.toml

@@ -5,7 +5,7 @@ include = '\.pyi?$'
 
 [tool.poetry]
 name = "streamlit-octostar-utils"
-version = "0.5.0-dev.17"
+version = "0.5.0-dev.18"
 description = ""
 license = "MIT"
 authors = ["Octostar"]

{streamlit_octostar_utils-0.5.0.dev17 → streamlit_octostar_utils-0.5.0.dev18}/streamlit_octostar_utils/api_crafter/celery.py

@@ -983,6 +983,11 @@ class FastAPICeleryTaskRoute(Route):
             path="/task/{task_id}",
             methods=["DELETE"],
             summary="Cancel a queued or running task.",
+            description=(
+                "Terminate a task by its ID. If the task is still queued "
+                "(AWAITING) it is revoked; if it is running (STARTED) the "
+                "worker process is interrupted."
+            ),
             status_code=200,
             responses=DefaultErrorRoute.error_responses,
         )
@@ -995,7 +1000,14 @@ class FastAPICeleryTaskRoute(Route):
             self,
             path="/task/{task_id}",
             methods=["GET"],
-            summary="Get task status (and result if available).",
+            summary="Get task status, progress, and result.",
+            description=(
+                "Poll a running or completed task. Returns task_state "
+                "(AWAITING, STARTED, SUCCESS, FAILURE, etc.), and when "
+                "STARTED may include a 'progress' dict with task-specific "
+                "metrics (e.g. nodes_done / nodes_total). When SUCCESS, "
+                "the 'data' field contains the task result."
+            ),
             status_code=200,
             responses=DefaultErrorRoute.error_responses,
         )

{streamlit_octostar_utils-0.5.0.dev17 → streamlit_octostar_utils-0.5.0.dev18}/streamlit_octostar_utils/api_crafter/nifi.py

@@ -1526,7 +1526,12 @@ class NifiRoute(Route):
         self.endpoints[op.strip("/")] = nifi_task
 
     def define_routes(self):
-        @Route.route(self, path="/task-state/{task_id}")
+        @Route.route(
+            self,
+            path="/task-state/{task_id}",
+            summary="Get NiFi task state.",
+            description="Return the current state of a task as a plain string (e.g. AWAITING, STARTED, SUCCESS).",
+        )
         async def get_task_status(task_id: str) -> JSONResponse:
             try:
                 task_status = await self.tasks_routes.get_task(task_id, pop=False)
@@ -1535,7 +1540,12 @@ class NifiRoute(Route):
                 raise ValueError(f"Could not fetch task state for task id {task_id}!\n{e}")
             return JSONResponse(task_status)
 
-        @Route.route(self, path="/task-result/{task_id}")
+        @Route.route(
+            self,
+            path="/task-result/{task_id}",
+            summary="Get NiFi task result.",
+            description="Return the result payload of a completed task and remove it from the backend.",
+        )
         async def get_task_result(task_id: str) -> JSONResponse:
             try:
                 return_data = await self.tasks_routes.get_task(task_id, pop=True)
@@ -1544,15 +1554,20 @@ class NifiRoute(Route):
                 raise ValueError(f"Could not fetch task result for task id {task_id}\n{e}!")
             return JSONResponse(return_data)
 
-        @Route.route(self, path="/{op}", methods=["POST"])
+        @Route.route(
+            self,
+            path="/{op}",
+            methods=["POST"],
+            summary="Submit a NiFi processing task.",
+            description=(
+                "Entry point for NiFi requests. The 'op' path parameter "
+                "selects the processing route (e.g. extract-text, summarize). "
+                "The body is a list of entities in NiFi format. Query "
+                "parameters are read from the entity config at "
+                "'request.config.<<processor_name>>.<<route_name>>.<<suffix_name>>'."
+            ),
+        )
         async def send_task(op: str, request: Request) -> str:
-            """
-            Any request coming from Nifi should enter from here.
-            Note that:
-            - The **op** parameter should be any of the other endpoints, including path parameters
-            - The body parameters should be a list of entities in Nifi format, which also replace form parameters
-            - The query parameters should be set in the 'request.config.<<processor_name>>.<<route_name>>.<<suffix_name>>' entry of the entities
-            """
             path_params = []
             op = op.split("/")
             if len(op) > 1: