dp3.api.routers.control

refresh_on_entity_creation async

refresh_on_entity_creation(etype: str) -> SuccessResponse

Sends the action refresh_on_entity_creation into execution queue.

This action is only accepted with the etype parameter.

Source code in dp3/api/routers/control.py

@router.get("/refresh_on_entity_creation")
async def refresh_on_entity_creation(etype: str) -> SuccessResponse:
    """Sends the action `refresh_on_entity_creation` into execution queue.

    This action is only accepted with the `etype` parameter.
    """
    CONTROL_WRITER.broadcast_task(
        ControlMessage(action=ControlAction.refresh_on_entity_creation, kwargs={"etype": etype})
    )
    return SuccessResponse(detail="Action sent.")

refresh_module_config async

refresh_module_config(module: EnabledModules) -> SuccessResponse

Sends the action refresh_module_config into execution queue.

This action is only accepted with the module parameter.

Source code in dp3/api/routers/control.py

@router.get("/refresh_module_config")
async def refresh_module_config(module: EnabledModules) -> SuccessResponse:
    """Sends the action `refresh_module_config` into execution queue.

    This action is only accepted with the `module` parameter.
    """
    CONTROL_WRITER.broadcast_task(
        ControlMessage(action=ControlAction.refresh_module_config, kwargs={"module": module.value})
    )
    return SuccessResponse(detail="Action sent.")

execute_action async

execute_action(action: ControlAction) -> SuccessResponse

Sends the given action into execution queue.

Source code in dp3/api/routers/control.py

@router.get("/{action}")
async def execute_action(action: ControlAction) -> SuccessResponse:
    """Sends the given action into execution queue."""
    CONTROL_WRITER.put_task(ControlMessage(action=action))
    return SuccessResponse(detail="Action sent.")