4 "description": "This is the ONAP Optimization Engine (Generic Solver) API",
6 "title": "ONAP Optimization ENGINE API",
8 "email": "vikas.varma@att.com"
12 "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
15 "securityDefinitions": {
18 "description": "HTTP Basic Auth"
30 "Generic Solver Optimization"
32 "summary": "Call the Generic Optimization engine",
33 "operationId": "optimizationRequest",
34 "description": "call optimization engine",
44 "name": "optimizationRequest",
45 "description": "optimization request",
47 "$ref": "#/definitions/OptimizationRequest"
55 "$ref": "#/definitions/OptimizationResponse"
59 "description": "An optimization request is accepted"
62 "description": "bad request"
65 "description": "Request body is not compliant with the API definition"
68 "description": "The server cannot find the requested URI"
71 "description": "The requested method is not supported by a server."
74 "description": "The server encountered an internal server error or timed out"
82 "Request to add the Optimizer model, metadata"
84 "summary": "Add/Insert the optimization models in the database",
85 "operationId": "optimModelRequestAPI",
86 "description": "Request to add update the Optimizer model, metadata",
96 "name": "optimModelRequest",
97 "description": "optimization model request",
99 "$ref": "#/definitions/OptimModelRequest"
107 "$ref": "#/definitions/OptimModelResponse"
111 "description": "bad request"
114 "description": "Request body is not compliant with the API definition"
117 "description": "The server cannot find the requested URI"
120 "description": "The requested method is not supported by a server."
123 "description": "The server encountered an internal server error or timed out"
129 "Request to update the Optimizer model, metadata"
131 "summary": "Add/update the optimization models in the database",
132 "operationId": "updateModelRequestAPI",
133 "description": "Request to add update the Optimizer model, metadata",
143 "name": "optimModelRequest",
144 "description": "optimization model request",
146 "$ref": "#/definitions/OptimModelRequest"
154 "$ref": "#/definitions/OptimModelResponse"
158 "description": "bad request"
161 "description": "Request body is not compliant with the API definition"
164 "description": "The server cannot find the requested URI"
167 "description": "The requested method is not supported by a server."
170 "description": "The server encountered an internal server error or timed out"
176 "Retrieve all models"
178 "summary": "Gets all Optim Model data",
179 "description": "Retrieves all Optim Models",
180 "operationId": "getAllOptModelData",
188 "$ref": "#/definitions/ArrayOfOptimModelResponse"
192 "description": "bad request"
195 "description": "Request body is not compliant with the API definition"
198 "description": "The server cannot find the requested URI"
201 "description": "The requested method is not supported by a server."
204 "description": "The server encountered an internal server error or timed out"
209 "/optmodel/v1/{model_id}": {
212 "Retrieve Model Data"
214 "summary": "Gets the Optim Model data",
215 "description": "Retrieves the Optim Model data given modelId",
216 "operationId": "getOptModelById",
221 "description": "Model ID",
230 "$ref": "#/definitions/OptimModelResponse"
234 "description": "bad request"
237 "description": "Request body is not compliant with the API definition"
240 "description": "The server cannot find the requested URI"
243 "description": "The requested method is not supported by a server."
246 "description": "The server encountered an internal server error or timed out"
254 "summary": "Delete the Optim Model data",
255 "description": "Deletes the Optim Model data given modelId",
256 "operationId": "deleteOptModelById",
261 "description": "Model ID",
270 "$ref": "#/definitions/DeleteModelResponse"
274 "description": "bad request"
277 "description": "Request body is not compliant with the API definition"
280 "description": "The server cannot find the requested URI"
283 "description": "The requested method is not supported by a server."
286 "description": "The server encountered an internal server error or timed out"
293 "OptimizationResponse": {
304 "description": "unique ID to track an ONAP transaction",
305 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
310 "description": "A unique ID to track multiple requests associated with a transaction",
311 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
315 "description": "request status (accepted, done, completed,failed)",
320 "description": "Status message (incomplete, complete, unsatisfiable, unknown, unbounded, unsat_or_unbounded, error)",
321 "example": "complete"
324 "additionalProperties": {
343 "OptimizationRequest": {
351 "$ref": "#/definitions/RequestInfo"
354 "$ref": "#/definitions/OptimInfo"
369 "description": "unique ID to track an ONAP transaction",
370 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
375 "description": "A unique ID to track multiple requests associated with a transaction",
376 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
381 "description": "The end point of a callback service where recommendations are posted.",
382 "example": "myDomain.com/myCallback"
386 "description": "The unique ID of a client making an optimization call.",
387 "example": "son-handler"
391 "description": "A tolerance window (in second) for expecting solutions",
401 "description": "ModelId from the database, if its not populated, assume that solverModel will be populated",
402 "example": "pci_model1"
406 "description": "type of solver (mzn, py, etc.)",
411 "description": "Arguments for solver",
412 "additionalProperties": {
422 "description": "a large blob string containing the model (which is not that problematic since models are fairly small)."
425 "$ref": "#/definitions/DataInfo"
431 "description": "Data Payload, input data for the solver, either text or json",
435 "description": "Solver data as a string",
436 "example": "flour = 8000; \r\nbanana = 11;\r\n "
440 "description": "Solver data as a json",
441 "additionalProperties": {
451 "OptimModelRequest": {
459 "$ref": "#/definitions/ModelRequestInfo"
462 "$ref": "#/definitions/OptimModelInfo"
466 "ModelRequestInfo": {
477 "description": "unique ID to track an ONAP transaction",
478 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
483 "description": "A unique ID to track multiple requests associated with a transaction",
484 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
488 "description": "The unique ID of a client making an optimization call.",
489 "example": "optf-osdf"
504 "description": "ModelId from the database",
505 "example": "pci_anr_model1"
509 "description": "type of solver (mzn, py, etc.)",
514 "description": "Description of the model",
515 "example": "mzn model to optimize pci/anr models"
519 "description": "a large blob string containing the model (which is not that problematic since models are fairly small).",
520 "example": "mzn content"
524 "ArrayOfOptimModelResponse": {
527 "$ref": "#/definitions/OptimModelResponse"
530 "OptimModelResponse": {
540 "description": "ModelId from the database",
541 "example": "pci_anr_model1"
545 "description": "type of solver (mzn, py, etc.)",
550 "description": "Description of the model",
551 "example": "mzn model to optimize pci/anr models"
555 "description": "a large blob string containing the model (which is not that problematic since models are fairly small).",
556 "example": "mzn content"
560 "description": "status message.",
561 "example": "mzn content"
565 "DeleteModelResponse": {
573 "description": "status message.",
574 "example": "model data for modelId pci_anr_model1 deleted"
582 "host": "virtserver.swaggerhub.com",
583 "basePath": "/api/oof/"