X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=runtime%2Fmodels%2Fapi%2Foptim_request.py;fp=runtime%2Fmodels%2Fapi%2Foptim_request.py;h=4a046d2c3a8df918366d524e739923a9d7ee0f91;hb=de5fdaafad9fccba0b9a7f308d72f26816dd1a0f;hp=0000000000000000000000000000000000000000;hpb=7d4f37c45d50c56dfe438c04dbecea3ca9f7c9d2;p=optf%2Fosdf.git

diff --git a/runtime/models/api/optim_request.py b/runtime/models/api/optim_request.py
new file mode 100644
index 0000000..4a046d2
--- /dev/null
+++ b/runtime/models/api/optim_request.py
@@ -0,0 +1,60 @@
+# -------------------------------------------------------------------------
+#   Copyright (c) 2020 AT&T Intellectual Property
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+# -------------------------------------------------------------------------
+#
+
+from schematics.types import BaseType, DictType, StringType, IntType
+from schematics.types.compound import ModelType
+
+from osdf.models.api.common import OSDFModel
+
+"""
+"""
+class RequestInfo(OSDFModel):
+    """Info for northbound request from client """
+    transactionId = StringType(required=True)
+    requestID = StringType(required=True)
+    callbackUrl = StringType()
+    sourceId = StringType(required=True)
+    timeout = IntType()
+
+
+class DataInfo(OSDFModel):
+    """Optimization data info"""
+    text = StringType()
+    json = DictType(BaseType)
+
+
+class OptimInfo(OSDFModel):
+    """Optimizer request info details."""
+    # ModelId from the database, if its not populated,
+    # assume that solverModel will be populated.
+    modelId = StringType()
+    # type of solver (mzn, or-tools, etc.)
+    solver = StringType()
+    # Arguments for solver
+    solverArgs = DictType(BaseType)
+    # NOTE: a large blob string containing the model (which is not that
+    # problematic since models are fairly small).
+    modelContent = StringType()
+    # Data Payload, input data for the solver
+    optData = ModelType(DataInfo)
+
+
+class OptimizationAPI(OSDFModel):
+    """Request for Optimizer API (specific to optimization and additional metadata"""
+    requestInfo = ModelType(RequestInfo, required=True)
+    optimInfo = ModelType(OptimInfo, required=True)