1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
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}
|