open api specs

Author: matusdrobuliak66

packages/postgres-database/src/simcore_postgres_database/models/comp_run_collections.py renamed to packages/postgres-database/src/simcore_postgres_database/models/comp_runs_collections.py

@@ -10711,7 +10711,7 @@
           "ABORTED"
         ],
         "title": "RunningState",
-        "description": "State of execution of a project's computational workflow\n\nSEE StateType for task state"
+        "description": "State of execution of a project's computational workflow\n\nSEE StateType for task state\n\n# Computational backend states explained:\n- UNKNOWN - The backend doesn't know about the task anymore, it has disappeared from the system or it was never created (eg. when we are asking for the task)\n- NOT_STARTED - Default state when the task is created\n- PUBLISHED - The task has been submitted to the computational backend (click on \"Run\" button in the UI)\n- PENDING - Task has been transferred to the Dask scheduler and is waiting for a worker to pick it up (director-v2 --> Dask scheduler)\n   - But! it is also transition state (ex. PENDING -> WAITING_FOR_CLUSTER -> PENDING -> WAITING_FOR_RESOURCES -> PENDING -> STARTED)\n- WAITING_FOR_CLUSTER - No cluster (Dask scheduler) is available to run the task; waiting for one to become available\n- WAITING_FOR_RESOURCES - No worker (Dask worker) is available to run the task; waiting for one to become available\n- STARTED - A worker has picked up the task and is executing it\n- SUCCESS - Task finished successfully\n- FAILED - Task finished with an error\n- ABORTED - Task was aborted before completion"
       },
       "ServicePricingPlanGetLegacy": {
         "properties": {

services/api-server/openapi.json

@@ -2806,7 +2806,7 @@
           "ABORTED"
         ],
         "title": "RunningState",
-        "description": "State of execution of a project's computational workflow\n\nSEE StateType for task state"
+        "description": "State of execution of a project's computational workflow\n\nSEE StateType for task state\n\n# Computational backend states explained:\n- UNKNOWN - The backend doesn't know about the task anymore, it has disappeared from the system or it was never created (eg. when we are asking for the task)\n- NOT_STARTED - Default state when the task is created\n- PUBLISHED - The task has been submitted to the computational backend (click on \"Run\" button in the UI)\n- PENDING - Task has been transferred to the Dask scheduler and is waiting for a worker to pick it up (director-v2 --> Dask scheduler)\n   - But! it is also transition state (ex. PENDING -> WAITING_FOR_CLUSTER -> PENDING -> WAITING_FOR_RESOURCES -> PENDING -> STARTED)\n- WAITING_FOR_CLUSTER - No cluster (Dask scheduler) is available to run the task; waiting for one to become available\n- WAITING_FOR_RESOURCES - No worker (Dask worker) is available to run the task; waiting for one to become available\n- STARTED - A worker has picked up the task and is executing it\n- SUCCESS - Task finished successfully\n- FAILED - Task finished with an error\n- ABORTED - Task was aborted before completion"
       },
       "SchedulerData": {
         "properties": {

services/director-v2/openapi.json

@@ -15946,10 +15946,22 @@ components:
       - FAILED
       - ABORTED
       title: RunningState
-      description: 'State of execution of a project''s computational workflow
-
-
-        SEE StateType for task state'
+      description: "State of execution of a project's computational workflow\n\nSEE\
+        \ StateType for task state\n\n# Computational backend states explained:\n\
+        - UNKNOWN - The backend doesn't know about the task anymore, it has disappeared\
+        \ from the system or it was never created (eg. when we are asking for the\
+        \ task)\n- NOT_STARTED - Default state when the task is created\n- PUBLISHED\
+        \ - The task has been submitted to the computational backend (click on \"\
+        Run\" button in the UI)\n- PENDING - Task has been transferred to the Dask\
+        \ scheduler and is waiting for a worker to pick it up (director-v2 --> Dask\
+        \ scheduler)\n   - But! it is also transition state (ex. PENDING -> WAITING_FOR_CLUSTER\
+        \ -> PENDING -> WAITING_FOR_RESOURCES -> PENDING -> STARTED)\n- WAITING_FOR_CLUSTER\
+        \ - No cluster (Dask scheduler) is available to run the task; waiting for\
+        \ one to become available\n- WAITING_FOR_RESOURCES - No worker (Dask worker)\
+        \ is available to run the task; waiting for one to become available\n- STARTED\
+        \ - A worker has picked up the task and is executing it\n- SUCCESS - Task\
+        \ finished successfully\n- FAILED - Task finished with an error\n- ABORTED\
+        \ - Task was aborted before completion"
     SelectBox:
       properties:
         structure:

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -41,7 +41,7 @@
     get_project_uuids_by_root_parent_project_id,
 )
 from ..rabbitmq import get_rabbitmq_rpc_client
-from ._comp_run_collections_service import get_comp_run_collection_or_none_by_id
+from ._comp_runs_collections_service import get_comp_run_collection_or_none_by_id
 
 
 async def _get_projects_metadata(

services/web/server/src/simcore_service_webserver/director_v2/_comp_run_collections_models.py renamed to services/web/server/src/simcore_service_webserver/director_v2/_comp_runs_collections_models.py

@@ -34,8 +34,8 @@
 from ...utils_aiohttp import envelope_json_response, get_api_base_url
 from .. import _director_v2_service
 from .._client import DirectorV2RestClient
-from .._comp_run_collections_models import CompRunCollectionDBGet
-from .._comp_run_collections_service import (
+from .._comp_runs_collections_models import CompRunCollectionDBGet
+from .._comp_runs_collections_service import (
     create_comp_run_collection,
     get_comp_run_collection_or_none_by_client_generated_id,
 )