cornflow 1.1.5a1__tar.gz → 1.2.0__tar.gz

{cornflow-1.1.5a1/cornflow.egg-info → cornflow-1.2.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.2
 Name: cornflow
-Version: 1.1.5a1
-Summary: Cornflow is an open source multi-solver optimization server with a REST API built using flask.
+Version: 1.2.0
+Summary: cornflow is an open source multi-solver optimization server with a REST API built using flask.
 Home-page: https://github.com/baobabsoluciones/cornflow
 Author: baobab soluciones
 Author-email: cornflow@baobabsoluciones.es
@@ -12,8 +12,9 @@ Classifier: Development Status :: 5 - Production/Stable
 Requires-Python: >=3.9
 Requires-Dist: alembic==1.9.2
 Requires-Dist: apispec<=6.3.0
+Requires-Dist: cachetools==5.3.3
 Requires-Dist: click<=8.1.7
-Requires-Dist: cornflow-client>=1.1.0
+Requires-Dist: cornflow-client>=1.2.0
 Requires-Dist: cryptography<=42.0.5
 Requires-Dist: disposable-email-domains>=0.0.86
 Requires-Dist: Flask==2.3.2
@@ -49,7 +50,7 @@ Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 
-Cornflow
+cornflow
 =========
 
 .. image:: https://github.com/baobabsoluciones/cornflow/workflows/build/badge.svg?style=svg
@@ -69,13 +70,13 @@ Cornflow
 
 .. image:: https://img.shields.io/badge/License-Apache2.0-blue
 
-Cornflow is an open source multi-solver optimization server with a REST API built using `flask <https://flask.palletsprojects.com>`_, `airflow <https://airflow.apache.org/>`_ and `pulp <https://coin-or.github.io/pulp/>`_.
+cornflow is an open source multi-solver optimization server with a REST API built using `flask <https://flask.palletsprojects.com>`_, `airflow <https://airflow.apache.org/>`_ and `pulp <https://coin-or.github.io/pulp/>`_.
 
-While most deployment servers are based on the solving technique (MIP, CP, NLP, etc.), Cornflow focuses on the optimization problems themselves. However, it does not impose any constraint on the type of problem and solution method to use.
+While most deployment servers are based on the solving technique (MIP, CP, NLP, etc.), cornflow focuses on the optimization problems themselves. However, it does not impose any constraint on the type of problem and solution method to use.
 
-With Cornflow you can deploy a Traveling Salesman Problem solver next to a Knapsack solver or a Nurse Rostering Problem solver. As long as you describe the input and output data, you can upload any solution method for any problem and then use it with any data you want.
+With cornflow you can deploy a Traveling Salesman Problem solver next to a Knapsack solver or a Nurse Rostering Problem solver. As long as you describe the input and output data, you can upload any solution method for any problem and then use it with any data you want.
 
-Cornflow helps you formalize your problem by proposing development guidelines. It also provides a range of functionalities around your deployed solution method, namely:
+cornflow helps you formalize your problem by proposing development guidelines. It also provides a range of functionalities around your deployed solution method, namely:
 
 * storage of users, instances, solutions and solution logs.
 * deployment and maintenance of models, solvers and algorithms.
@@ -91,9 +92,9 @@ Cornflow helps you formalize your problem by proposing development guidelines. I
 Installation instructions
 -------------------------------
 
-Cornflow is tested with Ubuntu 20.04, python >= 3.8 and git.
+cornflow is tested with Ubuntu 20.04, python >= 3.8 and git.
 
-Download the Cornflow project and install requirements::
+Download the cornflow project and install requirements::
 
     python3 -m venv venv
     venv/bin/pip3 install cornflow
@@ -109,7 +110,7 @@ initialize the sqlite database::
     flask create_admin_user  -u cornflow -e cornflow_admin@admin.com -p cornflow_admin_password
 
 
-activate the virtual environment and run Cornflow::
+activate the virtual environment and run cornflow::
 
     source venv/bin/activate
     export FLASK_APP=cornflow.app
@@ -120,7 +121,7 @@ activate the virtual environment and run Cornflow::
     export AIRFLOW_PWD=airflow_pwd
     flask run
 
-**Cornflow needs a running installation of Airflow to operate and more configuration**. Check `the installation docs <https://baobabsoluciones.github.io/cornflow/main/install.html>`_ for more details on installing airflow, configuring the application and initializing the database.
+**cornflow needs a running installation of Airflow to operate and more configuration**. Check `the installation docs <https://baobabsoluciones.github.io/cornflow/main/install.html>`_ for more details on installing airflow, configuring the application and initializing the database.
 
 Using cornflow to solve a PuLP model
 ---------------------------------------

{cornflow-1.1.5a1 → cornflow-1.2.0}/README.rst

@@ -1,4 +1,4 @@
-Cornflow
+cornflow
 =========
 
 .. image:: https://github.com/baobabsoluciones/cornflow/workflows/build/badge.svg?style=svg
@@ -18,13 +18,13 @@ Cornflow
 
 .. image:: https://img.shields.io/badge/License-Apache2.0-blue
 
-Cornflow is an open source multi-solver optimization server with a REST API built using `flask <https://flask.palletsprojects.com>`_, `airflow <https://airflow.apache.org/>`_ and `pulp <https://coin-or.github.io/pulp/>`_.
+cornflow is an open source multi-solver optimization server with a REST API built using `flask <https://flask.palletsprojects.com>`_, `airflow <https://airflow.apache.org/>`_ and `pulp <https://coin-or.github.io/pulp/>`_.
 
-While most deployment servers are based on the solving technique (MIP, CP, NLP, etc.), Cornflow focuses on the optimization problems themselves. However, it does not impose any constraint on the type of problem and solution method to use.
+While most deployment servers are based on the solving technique (MIP, CP, NLP, etc.), cornflow focuses on the optimization problems themselves. However, it does not impose any constraint on the type of problem and solution method to use.
 
-With Cornflow you can deploy a Traveling Salesman Problem solver next to a Knapsack solver or a Nurse Rostering Problem solver. As long as you describe the input and output data, you can upload any solution method for any problem and then use it with any data you want.
+With cornflow you can deploy a Traveling Salesman Problem solver next to a Knapsack solver or a Nurse Rostering Problem solver. As long as you describe the input and output data, you can upload any solution method for any problem and then use it with any data you want.
 
-Cornflow helps you formalize your problem by proposing development guidelines. It also provides a range of functionalities around your deployed solution method, namely:
+cornflow helps you formalize your problem by proposing development guidelines. It also provides a range of functionalities around your deployed solution method, namely:
 
 * storage of users, instances, solutions and solution logs.
 * deployment and maintenance of models, solvers and algorithms.
@@ -40,9 +40,9 @@ Cornflow helps you formalize your problem by proposing development guidelines. I
 Installation instructions
 -------------------------------
 
-Cornflow is tested with Ubuntu 20.04, python >= 3.8 and git.
+cornflow is tested with Ubuntu 20.04, python >= 3.8 and git.
 
-Download the Cornflow project and install requirements::
+Download the cornflow project and install requirements::
 
     python3 -m venv venv
     venv/bin/pip3 install cornflow
@@ -58,7 +58,7 @@ initialize the sqlite database::
     flask create_admin_user  -u cornflow -e cornflow_admin@admin.com -p cornflow_admin_password
 
 
-activate the virtual environment and run Cornflow::
+activate the virtual environment and run cornflow::
 
     source venv/bin/activate
     export FLASK_APP=cornflow.app
@@ -69,7 +69,7 @@ activate the virtual environment and run Cornflow::
     export AIRFLOW_PWD=airflow_pwd
     flask run
 
-**Cornflow needs a running installation of Airflow to operate and more configuration**. Check `the installation docs <https://baobabsoluciones.github.io/cornflow/main/install.html>`_ for more details on installing airflow, configuring the application and initializing the database.
+**cornflow needs a running installation of Airflow to operate and more configuration**. Check `the installation docs <https://baobabsoluciones.github.io/cornflow/main/install.html>`_ for more details on installing airflow, configuring the application and initializing the database.
 
 Using cornflow to solve a PuLP model
 ---------------------------------------

{cornflow-1.1.5a1 → cornflow-1.2.0}/airflow_config/airflow_local_settings.py

@@ -19,5 +19,5 @@ STATE_COLORS = {
 from airflow.www.utils import UIAlert
 
 DASHBOARD_UIALERTS = [
-    UIAlert("Welcome! This is the backend of your Cornflow environment. Airflow™ is a platform created by the community to programmatically author, schedule and monitor workflows."),
+    UIAlert("Welcome! This is the backend of your cornflow environment. Airflow™ is a platform created by the community to programmatically author, schedule and monitor workflows."),
 ]

{cornflow-1.1.5a1 → cornflow-1.2.0}/cornflow/app.py

@@ -37,7 +37,7 @@ from cornflow.endpoints.signup import SignUpEndpoint
 from cornflow.shared import db, bcrypt
 from cornflow.shared.compress import init_compress
 from cornflow.shared.const import AUTH_DB, AUTH_LDAP, AUTH_OID
-from cornflow.shared.exceptions import initialize_errorhandlers
+from cornflow.shared.exceptions import initialize_errorhandlers, ConfigurationError
 from cornflow.shared.log_config import log_config
 
 
@@ -62,11 +62,11 @@ def create_app(env_name="development", dataconn=None):
     CORS(app)
     bcrypt.init_app(app)
     db.init_app(app)
-    migrate = Migrate(app=app, db=db)
+    Migrate(app=app, db=db)
 
     if "sqlite" in app.config["SQLALCHEMY_DATABASE_URI"]:
 
-        def _fk_pragma_on_connect(dbapi_con, con_record):
+        def _fk_pragma_on_connect(dbapi_con, _con_record):
             dbapi_con.execute("pragma foreign_keys=ON")
 
         with app.app_context():
@@ -100,6 +100,11 @@ def create_app(env_name="development", dataconn=None):
         api.add_resource(LoginEndpoint, "/login/", endpoint="login")
     elif auth_type == AUTH_OID:
         api.add_resource(LoginOpenAuthEndpoint, "/login/", endpoint="login")
+    else:
+        raise ConfigurationError(
+            error="Invalid authentication type",
+            log_txt="Error while configuring authentication. The authentication type is not valid."
+        )
 
     initialize_errorhandlers(app)
     init_compress(app)

{cornflow-1.1.5a1 → cornflow-1.2.0}/cornflow/cli/migrations.py

@@ -3,7 +3,7 @@ import os.path
 
 import click
 from cornflow.shared import db
-from flask_migrate import Migrate, migrate, upgrade, init
+from flask_migrate import Migrate, migrate, upgrade, downgrade, init
 
 from .utils import get_app
 
@@ -28,7 +28,27 @@ def migrate_migrations():
 
 
 @migrations.command(name="upgrade", help="Apply migrations")
-def upgrade_migrations():
+@click.option(
+    "-r", "--revision", type=str, help="The revision to upgrade to", default="head"
+)
+def upgrade_migrations(revision="head"):
+    app = get_app()
+    external = int(os.getenv("EXTERNAL_APP", 0))
+    if external == 0:
+        path = "./cornflow/migrations"
+    else:
+        path = f"./{os.getenv('EXTERNAL_APP_MODULE', 'external_app')}/migrations"
+
+    with app.app_context():
+        migration_client = Migrate(app=app, db=db, directory=path)
+        upgrade(revision=revision)
+
+
+@migrations.command(name="downgrade", help="Downgrade migrations")
+@click.option(
+    "-r", "--revision", type=str, help="The revision to downgrade to", default="-1"
+)
+def downgrade_migrations(revision="-1"):
     app = get_app()
     external = int(os.getenv("EXTERNAL_APP", 0))
     if external == 0:
@@ -38,7 +58,7 @@ def upgrade_migrations():
 
     with app.app_context():
         migration_client = Migrate(app=app, db=db, directory=path)
-        upgrade()
+        downgrade(revision=revision)
 
 
 @migrations.command(

{cornflow-1.1.5a1 → cornflow-1.2.0}/cornflow/cli/service.py

@@ -6,6 +6,7 @@ from logging import error
 
 
 import click
+from .utils import get_db_conn
 import cornflow
 from cornflow.app import create_app
 from cornflow.commands import (
@@ -16,7 +17,14 @@ from cornflow.commands import (
     update_schemas_command,
     update_dag_registry_command,
 )
-from cornflow.shared.const import AUTH_DB, ADMIN_ROLE, SERVICE_ROLE
+from cornflow.shared.const import (
+    AUTH_DB,
+    AUTH_LDAP,
+    AUTH_OID,
+    ADMIN_ROLE,
+    SERVICE_ROLE,
+    PLANNER_ROLE,
+)
 from cornflow.shared import db
 from cryptography.fernet import Fernet
 from flask_migrate import Migrate, upgrade
@@ -49,15 +57,8 @@ def init_cornflow_service():
     os.environ["SECRET_KEY"] = os.getenv("FERNET_KEY", Fernet.generate_key().decode())
 
     # Cornflow db defaults
-    cornflow_db_host = os.getenv("CORNFLOW_DB_HOST", "cornflow_db")
-    cornflow_db_port = os.getenv("CORNFLOW_DB_PORT", "5432")
-    cornflow_db_user = os.getenv("CORNFLOW_DB_USER", "cornflow")
-    cornflow_db_password = os.getenv("CORNFLOW_DB_PASSWORD", "cornflow")
-    cornflow_db = os.getenv("CORNFLOW_DB", "cornflow")
-    cornflow_db_conn = os.getenv(
-        "cornflow_db_conn",
-        f"postgresql://{cornflow_db_user}:{cornflow_db_password}@{cornflow_db_host}:{cornflow_db_port}/{cornflow_db}",
-    )
+    os.environ["DEFAULT_POSTGRES"] = "1"
+    cornflow_db_conn = get_db_conn()
     os.environ["DATABASE_URL"] = cornflow_db_conn
 
     # Platform auth config and service users
@@ -83,11 +84,11 @@ def init_cornflow_service():
     os.environ["SIGNUP_ACTIVATED"] = str(signup_activated)
     user_access_all_objects = os.getenv("USER_ACCESS_ALL_OBJECTS", 0)
     os.environ["USER_ACCESS_ALL_OBJECTS"] = str(user_access_all_objects)
-    default_role = os.getenv("DEFAULT_ROLE", 2)
+    default_role = int(os.getenv("DEFAULT_ROLE", PLANNER_ROLE))
     os.environ["DEFAULT_ROLE"] = str(default_role)
 
     # Check LDAP parameters for active directory and show message
-    if os.getenv("AUTH_TYPE") == 2:
+    if os.getenv("AUTH_TYPE") == AUTH_LDAP:
         print(
             "WARNING: Cornflow will be deployed with LDAP Authorization. Please review your ldap auth configuration."
         )
@@ -129,10 +130,11 @@ def init_cornflow_service():
         app = create_app(environment, cornflow_db_conn)
         with app.app_context():
             path = f"{os.path.dirname(cornflow.__file__)}/migrations"
-            migrate = Migrate(app=app, db=db, directory=path)
+            Migrate(app=app, db=db, directory=path)
             upgrade()
             access_init_command(verbose=False)
-            if auth == 1 or auth == 0:
+            if auth == AUTH_DB or auth == AUTH_OID:
+                # create cornflow admin user
                 create_user_with_role(
                     cornflow_admin_user,
                     cornflow_admin_email,
@@ -188,7 +190,7 @@ def init_cornflow_service():
             migrate = Migrate(app=app, db=db, directory=path)
             upgrade()
             access_init_command(verbose=False)
-            if auth == 1 or auth == 0:
+            if auth == AUTH_DB or auth == AUTH_OID:
                 # create cornflow admin user
                 create_user_with_role(
                     cornflow_admin_user,

cornflow-1.2.0/cornflow/cli/utils.py

@@ -0,0 +1,41 @@
+import os
+import sys
+from importlib import import_module
+import warnings
+
+
+def get_app():
+    env = os.getenv("FLASK_ENV", "development")
+    data_conn = get_db_conn()
+    if env == "production":
+        warnings.filterwarnings("ignore")
+    external = int(os.getenv("EXTERNAL_APP", 0))
+    if external == 0:
+        from cornflow.app import create_app
+    else:
+        sys.path.append("./")
+        external_app = os.getenv("EXTERNAL_APP_MODULE", "external_app")
+        external_module = import_module(external_app)
+        create_app = external_module.create_wsgi_app
+
+    if data_conn is None:
+        app = create_app(env)
+    else:
+        app = create_app(env, data_conn)
+
+    return app
+
+
+def get_db_conn():
+    if int(os.getenv("DEFAULT_POSTGRES", 0)) == 0:
+        return os.getenv("DATABASE_URL", "sqlite:///cornflow.db")
+    else:
+        cornflow_db_host = os.getenv("CORNFLOW_DB_HOST", "cornflow_db")
+        cornflow_db_port = os.getenv("CORNFLOW_DB_PORT", "5432")
+        cornflow_db_user = os.getenv("CORNFLOW_DB_USER", "cornflow")
+        cornflow_db_password = os.getenv("CORNFLOW_DB_PASSWORD", "cornflow")
+        cornflow_db = os.getenv("CORNFLOW_DB", "cornflow")
+        return os.getenv(
+            "cornflow_db_conn",
+            f"postgresql://{cornflow_db_user}:{cornflow_db_password}@{cornflow_db_host}:{cornflow_db_port}/{cornflow_db}",
+        )

{cornflow-1.1.5a1 → cornflow-1.2.0}/cornflow/config.py

@@ -1,5 +1,5 @@
 import os
-from .shared.const import AUTH_DB, PLANNER_ROLE
+from .shared.const import AUTH_DB, PLANNER_ROLE, AUTH_OID
 from apispec import APISpec
 from apispec.ext.marshmallow import MarshmallowPlugin
 
@@ -28,7 +28,7 @@ class DefaultConfig(object):
     SIGNUP_ACTIVATED = int(os.getenv("SIGNUP_ACTIVATED", 1))
     CORNFLOW_SERVICE_USER = os.getenv("CORNFLOW_SERVICE_USER", "service_user")
 
-    # If service user is allow to log with username and password
+    # If service user is allowed to log with username and password
     SERVICE_USER_ALLOW_PASSWORD_LOGIN = int(
         os.getenv("SERVICE_USER_ALLOW_PASSWORD_LOGIN", 1)
     )
@@ -59,15 +59,13 @@ class DefaultConfig(object):
     LDAP_PROTOCOL_VERSION = int(os.getenv("LDAP_PROTOCOL_VERSION", 3))
     LDAP_USE_TLS = os.getenv("LDAP_USE_TLS", "False")
 
-    # OpenID login -> Default Azure
-    OID_PROVIDER = os.getenv("OID_PROVIDER", 0)
-    OID_CLIENT_ID = os.getenv("OID_CLIENT_ID")
-    OID_TENANT_ID = os.getenv("OID_TENANT_ID")
-    OID_ISSUER = os.getenv("OID_ISSUER")
+    # OpenID Connect configuration
+    OID_PROVIDER = os.getenv("OID_PROVIDER")
+    OID_EXPECTED_AUDIENCE = os.getenv("OID_EXPECTED_AUDIENCE")
 
     # APISPEC:
     APISPEC_SPEC = APISpec(
-        title="Cornflow API docs",
+        title="cornflow API docs",
         version="v1",
         plugins=[MarshmallowPlugin()],
         openapi_version="2.0.0",
@@ -127,8 +125,9 @@ class TestingOpenAuth(Testing):
     """
     Configuration class for testing some edge cases with Open Auth login
     """
-
-    AUTH_TYPE = 0
+    AUTH_TYPE = AUTH_OID
+    OID_PROVIDER = "https://test-provider.example.com"
+    OID_EXPECTED_AUDIENCE = "test-audience-id"
 
 
 class TestingApplicationRoot(Testing):
@@ -158,5 +157,5 @@ app_config = {
     "testing": Testing,
     "production": Production,
     "testing-oauth": TestingOpenAuth,
-    "testing-root": TestingApplicationRoot,
+    "testing-root": TestingApplicationRoot
 }

{cornflow-1.1.5a1 → cornflow-1.2.0}/cornflow/endpoints/__init__.py

@@ -3,8 +3,9 @@ Initialization file for the endpoints module
 All references to endpoints should be imported from here
 The login resource gets created on app startup as it depends on configuration
 """
+
 from .action import ActionListEndpoint
-from .alarms import AlarmsEndpoint
+from .alarms import AlarmsEndpoint, AlarmDetailEndpoint
 from .apiview import ApiViewListEndpoint
 from .case import (
     CaseEndpoint,
@@ -225,6 +226,11 @@ alarms_resources = [
         urls="/alarms/",
         endpoint="alarms",
     ),
+    dict(
+        resource=AlarmDetailEndpoint,
+        urls="/alarms/<int:idx>/",
+        endpoint="alarms-detail",
+    ),
     dict(
         resource=MainAlarmsEndpoint,
         urls="/main-alarms/",

cornflow-1.2.0/cornflow/endpoints/alarms.py

@@ -0,0 +1,123 @@
+# Imports from libraries
+from flask import current_app
+from flask_apispec import doc, marshal_with, use_kwargs
+
+# Import from internal modules
+from cornflow.endpoints.meta_resource import BaseMetaResource
+from cornflow.models import AlarmsModel
+from cornflow.schemas.alarms import (
+    AlarmEditRequest,
+    AlarmsResponse,
+    AlarmsPostRequest,
+    QueryFiltersAlarms,
+)
+from cornflow.shared.authentication import Auth, authenticate
+from cornflow.shared.exceptions import AirflowError, ObjectDoesNotExist, InvalidData
+from cornflow.shared.const import SERVICE_ROLE
+
+
+class AlarmsEndpoint(BaseMetaResource):
+    """
+    Endpoint used to manage the table alarms.
+    Available methods: [get, post]
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.data_model = AlarmsModel
+        self.unique = ["id"]
+
+    @doc(
+        description="Get list of all the elements in the table",
+        tags=["None"],
+    )
+    @authenticate(auth_class=Auth())
+    @marshal_with(AlarmsResponse(many=True))
+    @use_kwargs(QueryFiltersAlarms, location="query")
+    def get(self, **kwargs):
+        """
+        API method to get all the rows of the table.
+        It requires authentication to be passed in the form of a token that has to be linked to
+        an existing session (login) made by a user.
+        :return: A list of objects with the data, and an integer with the HTTP status code.
+        :rtype: Tuple(dict, integer)
+        """
+        return self.get_list(**kwargs)
+
+    @doc(
+        description="Add a new row to the table",
+        tags=["None"],
+    )
+    @authenticate(auth_class=Auth())
+    @marshal_with(AlarmsResponse)
+    @use_kwargs(AlarmsPostRequest, location="json")
+    def post(self, **kwargs):
+        """
+        API method to add a row to the table.
+        It requires authentication to be passed in the form of a token that has to be linked to
+        an existing session (login) made by a user.
+        :return: An object with the data for the created row,
+        and an integer with the HTTP status code.
+        :rtype: Tuple(dict, integer)
+        """
+        return self.post_list(data=kwargs)
+
+
+class AlarmDetailEndpointBase(BaseMetaResource):
+    """
+    Endpoint used to get the information of a certain alarm. But not the data!
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.data_model = AlarmsModel
+        self.unique = ["id"]
+
+
+class AlarmDetailEndpoint(AlarmDetailEndpointBase):
+    @doc(description="Get details of an alarm", tags=["None"], inherit=False)
+    @authenticate(auth_class=Auth())
+    @marshal_with(AlarmsResponse)
+    @BaseMetaResource.get_data_or_404
+    def get(self, idx):
+        """
+        API method to get an execution created by the user and its related info.
+        It requires authentication to be passed in the form of a token that has to be linked to
+        an existing session (login) made by a user.
+
+        :param str idx: ID of the execution.
+        :return: A dictionary with a message (error if authentication failed, or the execution does not exist or
+          the data of the execution) and an integer with the HTTP status code.
+        :rtype: Tuple(dict, integer)
+        """
+        current_app.logger.info(
+            f"User {self.get_user()} gets details of execution {idx}"
+        )
+        return self.get_detail(idx=idx)
+
+    @doc(description="Edit an execution", tags=["Executions"], inherit=False)
+    @authenticate(auth_class=Auth())
+    @use_kwargs(AlarmEditRequest, location="json")
+    def put(self, idx, **data):
+        """
+        Edit an existing alarm
+
+        :param string idx: ID of the alarm.
+        :return: A dictionary with a message (error if authentication failed, or the alarm does not exist or
+          a message) and an integer with the HTTP status code.
+        :rtype: Tuple(dict, integer)
+        """
+        current_app.logger.info(f"User {self.get_user()} edits alarm {idx}")
+        return self.put_detail(data, track_user=False, idx=idx)
+
+    @doc(description="Disable an alarm", tags=["None"])
+    @authenticate(auth_class=Auth())
+    def delete(self, idx):
+        """
+        :param int alarm_id: Alarm id.
+        :return:
+        :rtype: Tuple(dict, integer)
+        """
+
+        current_app.logger.info(f"Alarm {idx} was disabled by user {self.get_user()}")
+        return self.disable_detail(idx=idx)