diff options
Diffstat (limited to 'old/moon_manager/moon_manager/api/models.py')
-rw-r--r-- | old/moon_manager/moon_manager/api/models.py | 117 |
1 files changed, 117 insertions, 0 deletions
diff --git a/old/moon_manager/moon_manager/api/models.py b/old/moon_manager/moon_manager/api/models.py new file mode 100644 index 00000000..c72396cf --- /dev/null +++ b/old/moon_manager/moon_manager/api/models.py @@ -0,0 +1,117 @@ +# Copyright 2015 Open Platform for NFV Project, Inc. and its contributors +# This software is distributed under the terms and conditions of the 'Apache-2.0' +# license which can be found in the file 'LICENSE' in this package distribution +# or at 'http://www.apache.org/licenses/LICENSE-2.0'. +""" +Models aggregate multiple meta rules +""" + +from flask import request +from flask_restful import Resource +import logging +from python_moonutilities.security_functions import check_auth +from python_moondb.core import ModelManager +from python_moonutilities.security_functions import validate_input + +__version__ = "4.3.2" + +logger = logging.getLogger("moon.manager.api." + __name__) + + +class Models(Resource): + """ + Endpoint for model requests + """ + + __urls__ = ( + "/models", + "/models/", + "/models/<string:uuid>", + "/models/<string:uuid>/", + ) + + @validate_input("get", kwargs_state=[False, False]) + @check_auth + def get(self, uuid=None, user_id=None): + """Retrieve all models + + :param uuid: uuid of the model + :param user_id: user ID who do the request + :return: { + "model_id1": { + "name": "...", + "description": "... (optional)", + "meta_rules": ["meta_rule_id1", ] + } + } + :internal_api: get_models + """ + data = ModelManager.get_models(user_id=user_id, model_id=uuid) + + return {"models": data} + + @validate_input("post", body_state={"name": True, "meta_rules": False}) + @check_auth + def post(self, uuid=None, user_id=None): + """Create model. + + :param uuid: uuid of the model (not used here) + :param user_id: user ID who do the request + :request body: { + "name": "name of the model (mandatory)", + "description": "description of the model (optional)", + "meta_rules": ["meta_rule_id1", ] + } + :return: { + "model_id1": { + "name": "name of the model", + "description": "description of the model (optional)", + "meta_rules": ["meta_rule_id1", ] + } + } + :internal_api: add_model + """ + data = ModelManager.add_model( + user_id=user_id, model_id=uuid, value=request.json) + + return {"models": data} + + @validate_input("delete", kwargs_state=[True, False]) + @check_auth + def delete(self, uuid=None, user_id=None): + """Delete a model + + :param uuid: uuid of the model to delete + :param user_id: user ID who do the request + :return: { + "result": "True or False", + "message": "optional message (optional)" + } + :internal_api: delete_model + """ + + data = ModelManager.delete_model(user_id=user_id, model_id=uuid) + + return {"result": True} + + @validate_input("patch", kwargs_state=[True, False], + body_state={"name": True, "meta_rules": False}) + @check_auth + def patch(self, uuid=None, user_id=None): + """Update a model + + :param uuid: uuid of the model to update + :param user_id: user ID who do the request + :return: { + "model_id1": { + "name": "name of the model", + "description": "... (optional)", + "meta_rules": ["meta_rule_id1", ] + } + } + :internal_api: update_model + """ + data = ModelManager.update_model( + user_id=user_id, model_id=uuid, value=request.json) + + return {"models": data} |