4 "description": "This is the ONAP OOF OSDF (Optimization Service Design Framework) API",
8 "email": "frank.sandoval@oamtechnologies.com"
12 "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
15 "securityDefinitions": {
18 "description": "HTTP Basic Auth"
30 "Placement Optimization"
32 "summary": "create/update a placement",
33 "operationId": "createPlacement",
34 "description": "create/update a placement",
44 "name": "placementRequest",
45 "description": "placement request",
47 "$ref": "#/definitions/PlacementRequest"
53 "description": "An optimization solution is found."
56 "description": "An optimization request is accepted"
59 "description": "bad request"
62 "description": "Request body is not compliant with the API definition"
65 "description": "The server cannot find the requested URI"
68 "description": "The requested method is not supported by a server."
71 "description": "The server encountered an internal server error or timed out"
76 "/api/oof/placement/v1": {
77 "$ref": "#/paths/~1v2~1placement"
82 "PCI/ANR Optimization"
84 "summary": "Initiate PCI/ANR Optimization",
85 "operationId": "initiatePCIOptRequest",
86 "description": "Initiate PCI/ANR Optimization",
96 "name": "PCIOptimizationRequest",
97 "description": "PCI request",
99 "$ref": "#/definitions/PCIOptRequest"
105 "description": "An optimization solution is found."
108 "description": "An optimization request is accepted"
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 "$ref": "#/paths/~1api~1oof~1v1~1pci"
131 "/api/oof/selection/nst/v1": {
136 "summary": "NST selection",
137 "operationId": "selectNstRequest",
138 "description": "Request for NST selection",
148 "name": "NSTSelectionRequest",
149 "description": "nst selection request",
151 "$ref": "#/definitions/NSTSelectionRequest"
157 "description": "An optimization request is accepted",
159 "$ref": "#/definitions/SynchronousResponse"
163 "description": "bad request"
166 "description": "Request body is not compliant with the API definition"
169 "description": "The server cannot find the requested URI"
172 "description": "The requested method is not supported by a server."
175 "description": "The server encountered an internal server error or timed out"
180 "/api/oof/selection/nsi/v1": {
185 "summary": "NSI selection",
186 "operationId": "selectNsiRequest",
187 "description": "Request for NSI selection",
197 "name": "NSISelectionRequest",
198 "description": "NSI selection request",
200 "$ref": "#/definitions/NSISelectionRequest"
206 "description": "An optimization request is accepted",
208 "$ref": "#/definitions/SynchronousResponse"
212 "description": "bad request"
215 "description": "Request body is not compliant with the API definition"
218 "description": "The server cannot find the requested URI"
221 "description": "The requested method is not supported by a server."
224 "description": "The server encountered an internal server error or timed out"
229 "/api/oof/selection/nssi/v1": {
234 "summary": "NSSI selection",
235 "operationId": "selectNssiRequest",
236 "description": "Request for NSSI selection",
246 "name": "NSSISelectionRequest",
247 "description": "NSSI selection request",
249 "$ref": "#/definitions/NSSISelectionRequest"
255 "description": "An optimization request is accepted",
257 "$ref": "#/definitions/SynchronousResponse"
261 "description": "bad request"
264 "description": "Request body is not compliant with the API definition"
267 "description": "The server cannot find the requested URI"
270 "description": "The requested method is not supported by a server."
273 "description": "The server encountered an internal server error or timed out"
278 "/api/oof/route/v1": {
283 "summary": "Find the optimistic route between OTN domains",
285 "operationId": "getRoute",
296 "description": "Source and Destination nodes across which optmistic route have to be obtained.",
299 "$ref": "#/definitions/RouteRequest"
305 "description": "successful operation",
309 "$ref": "#/definitions/routeResponseBody"
314 "description": "Invalid input"
325 "$ref": "#/definitions/requestInfo"
328 "$ref": "#/definitions/routeInfo"
337 "description": "A unique ID to track an ONAP transaction."
341 "description": "A unique ID to track multiple requests associated with a transaction."
345 "description": "The end point of a callback service where recommendations are posted."
349 "description": "The header information a client expecting in a async callback."
353 "description": "The unique ID of a client making an optimization call."
358 "description": "The type of request being placed.",
368 "description": "Expected number of solutions. numSolution can also be specified using an optimization query policies, where the default configured value is 1. The value from a request gets higher precedence over the value defined in a policy."
371 "description": "A list of optimization services that can be used to resolve the route",
380 "description": "A tolerance window (in secs) for expecting solutions. Default is 600 secs."
388 "$ref": "#/definitions/routeRequest"
396 "$ref": "#/definitions/routePortInfo"
399 "$ref": "#/definitions/routePortInfo"
406 "accessTopologyId": {
408 "description": "A unique ID of the Access Topology."
413 "description": "A unique ID of the client which provides the access."
415 "accessProviderId": {
418 "description": "A unique ID of the access provider"
423 "description": "A unique ID of the node to/from which the route has to be established."
428 "description": "A unique ID of the Termination Point to/from which the route has to be established."
432 "routeResponseBody": {
437 "description": "A unique Id for an ONAP transaction."
441 "description": "A unique ID to track multiple requests associated with a transaction."
445 "description": "Reasoning if a requestStatus is failure."
449 "description": "The status of a request."
452 "$ref": "#/definitions/RouteSolutionInfo"
456 "RouteSolutionInfo": {
461 "format": "date-time",
462 "description": "start time of the operation in RFC 3339 notation for example, 2017-07-21T17:32:28Z."
466 "format": "date-time",
467 "description": "end time of the operation in RFC 3339 notation for example, 2017-07-21T17:32:28Z."
470 "description": "A list of vpn info that can be used to establish the route between source and destination port/node.",
473 "$ref": "#/definitions/link"
483 "description": "Id or name identifies a link uniquely."
487 "PlacementRequest": {
497 "$ref": "#/definitions/RequestInfo"
500 "$ref": "#/definitions/PlacementInfo"
503 "$ref": "#/definitions/LicenseInfo"
506 "$ref": "#/definitions/ServiceInfo"
525 "description": "unique ID to track an ONAP transaction",
526 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
531 "description": "A unique ID to track multiple requests associated with a transaction",
532 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
537 "description": "The end point of a callback service where recommendations are posted.",
538 "example": "myDomain.com/myCallback"
542 "description": "JSON blob. The header information a client expecting in a async callback.",
549 "description": "The unique ID of a client making an optimization call.",
550 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
559 "description": "The type of a request",
564 "description": "Expected number of solutions.",
577 "description": "A list of optimization services.",
584 "description": "A tolerance window (in second) for expecting solutions.",
596 "requestParameters": {
598 "description": "JSON blob. A service ordering information",
603 "placementDemands": {
606 "$ref": "#/definitions/PlacementDemand"
608 "description": "The resource information for a placement service"
613 "$ref": "#/definitions/SubscriberInfo"
615 "description": "The information of a service subscriber."
622 "resourceModuleName",
627 "resourceModuleName": {
629 "description": "A resource name as defined in a service mode",
630 "example": "myResourceName"
632 "serviceResourceId": {
634 "description": "A unique resource Id with a local scope between client and OOF.",
635 "example": "myResourceId"
639 "additionalProperties": {
650 "description": "placement parameters defined in the ordering system, keyname include tenantId",
655 "resourceModelInfo": {
656 "$ref": "#/definitions/ModelMetaData"
658 "existingCandidates": {
659 "$ref": "#/definitions/Candidates"
661 "excludedCandidates": {
662 "$ref": "#/definitions/Candidates"
664 "requiredCandidates": {
665 "$ref": "#/definitions/Candidates"
676 "modelInvariantId": {
678 "description": "A model invariant Id as defined in a service model.",
679 "example": "my model invariant Id"
683 "description": "A unique model Id as defined in a service model.",
684 "example": "my unique model Id"
688 "description": "A model name as defined in a service model",
689 "example": "my model name"
693 "description": "A model type as defined in a service model.",
694 "example": "my model type"
698 "description": "A model version as defined in a service model.",
699 "example": "my model version"
701 "modelCustomizationName": {
703 "description": "A model customization name as defined in a service model.",
704 "example": "my model customization"
718 "service_instance_id",
722 "description": "The type of a candidate.",
723 "example": "service_instance_id"
730 "description": "A list of identifiers.",
731 "example": "candidateId"
735 "description": "The name of a cloud owner. Only required if identifierType is cloud_region_id",
736 "example": "cloud_owner"
743 "globalSubscriberId",
745 "subscriberCommonSiteId"
748 "globalSubscriberId": {
750 "description": "An ID of a subscriber.",
751 "example": "subscriber_id"
755 "description": "The name of a subscriber. If the name is not known, the value must be 'unknown'",
756 "example": "subscriber_name"
758 "subscriberCommonSiteId": {
760 "description": "Id representing a subscriber location",
761 "example": "subscriber_location_id"
774 "$ref": "#/definitions/LicenseDemands"
776 "description": "A list of resources for license selection"
783 "resourceModuleName",
788 "resourceModuleName": {
790 "description": "A resource name as defined in a service model.",
791 "example": "service_instance_id"
793 "serviceResourceId": {
795 "description": "A unique resource Id with a local scope between client and OOF.",
796 "example": "service_instance_id"
798 "resourceModelInfo": {
799 "$ref": "#/definitions/ModelMetaData"
801 "existingLicenses": {
802 "$ref": "#/definitions/LicenseModel"
809 "entitlementPoolUUID",
810 "licenseKeyGroupUUID"
813 "entitlementPoolUUID": {
819 "description": "Entitlement pool UUIDs associated with a resource.",
820 "example": "candidateId"
822 "licenseKeyGroupUUID": {
828 "description": "License key groups associated with a resource",
829 "example": "candidateId"
833 "SynchronousResponse": {
844 "description": "A unique Id for an ONAP transaction",
845 "example": "ONAP transaction id"
850 "description": "A unique ID to track multiple requests associated with a transaction.",
851 "example": "requests id"
855 "description": "Reasoning if a requestStatus is failure.",
856 "example": "requestStatus"
864 "description": "The status of a request.",
869 "PlacementAsynchronousResponse": {
881 "description": "A unique Id for an ONAP transaction",
882 "example": "ONAP transaction id"
887 "description": "A unique ID to track multiple requests associated with a transaction.",
888 "example": "requests id"
892 "description": "Reasoning if a requestStatus is failure.",
893 "example": "requestStatus"
901 "description": "The status of a request.",
905 "$ref": "#/definitions/Solutions"
912 "placementSolutions",
916 "placementSolutions": {
919 "$ref": "#/definitions/ComprehensiveSolution"
921 "description": "A list of placement solutions."
923 "licenseSolutions": {
926 "$ref": "#/definitions/LicenseSolution"
928 "description": "A list of license solutions."
932 "ComprehensiveSolution": {
938 "placementSolutions": {
941 "$ref": "#/definitions/PlacementSolution"
943 "description": "A list of placement solutions."
947 "PlacementSolution": {
950 "resourceModuleName",
956 "resourceModuleName": {
958 "description": "The name of a resource as defined in the service model",
959 "example": "resource name"
961 "serviceResourceId": {
963 "description": "A resource Id as defined in a service model.",
964 "example": "resource id"
969 "service_instance_id"
971 "description": "The type of a candidate.",
972 "example": "candidate type"
976 "description": "The id of a candidate.",
977 "example": "candidate id"
982 "$ref": "#/definitions/AssignmentInfo"
984 "description": "Additional information related to a candidate."
997 "description": "An attribute name",
998 "example": "attribute name"
1002 "description": "An attribute value.",
1003 "example": "attribute value"
1007 "LicenseSolution": {
1010 "resourceModuleName",
1011 "serviceResourceId",
1012 "entitlementPoolUUID",
1013 "licenseKeyGroupUUID",
1014 "entitlementPoolInvariantUUID",
1015 "licenseKeyGroupInvariantUUID"
1018 "resourceModuleName": {
1020 "description": "A resource name as defined in a service",
1021 "example": "resource name"
1023 "serviceResourceId": {
1025 "description": "A resource Id as defined in a service.",
1026 "example": "resource Id"
1028 "entitlementPoolUUID": {
1034 "description": "A list of entitlementPoolUUIDs",
1035 "example": "entitlementPoolUUID"
1037 "licenseKeyGroupUUID": {
1043 "description": "A list of licenseKeyGroupUUID.",
1044 "example": "licenseKeyGroupUUID"
1046 "entitlementPoolInvariantUUID": {
1052 "description": "A list of entitlementPoolInvariantUUID",
1053 "example": "entitlementPoolInvariantUUID"
1055 "licenseKeyGroupInvariantUUID": {
1061 "description": "A list of licenseKeyGroupInvariantUUID",
1062 "example": "licenseKeyGroupInvariantUUID"
1069 "serviceInstanceId",
1074 "serviceInstanceId": {
1076 "description": "A service instance id associated with a request.",
1077 "example": "service_instance_id"
1080 "$ref": "#/definitions/ModelMetaData"
1084 "description": "The name of a service",
1085 "example": "service_name"
1097 "$ref": "#/definitions/RequestInfo"
1100 "$ref": "#/definitions/CellInfo"
1115 "description": "Id of network requiring PCI optimization",
1123 "description": "List of cellIds triggering need for PCI optimization (eg.potential confusion)",
1132 "$ref": "#/definitions/ANRInfo"
1134 "description": "A list of ANR Input."
1141 "description": "List of blacklisted cells whose PCI values should not be changed",
1147 "priorityTreatmentCells": {
1152 "description": "List of cells which should be given special treatment during optimization",
1160 "description": "Type of trigger causing need for PCI optimization",
1161 "example": "NbrListChange"
1165 "PCIAsynchronousResponse": {
1177 "description": "A unique Id for an ONAP transaction",
1178 "example": "ONAP transaction id"
1183 "description": "A unique ID to track multiple requests associated with a transaction.",
1184 "example": "requests id"
1188 "description": "Reasoning if a requestStatus is failure.",
1189 "example": "requestStatus"
1197 "description": "The status of a request.",
1198 "example": "success"
1201 "$ref": "#/definitions/PCIANRSolutions"
1205 "PCIANRSolutions": {
1215 "description": "Id of network requiring PCI optimization",
1221 "$ref": "#/definitions/PCISolution"
1223 "description": "A list of PCI solutions."
1228 "$ref": "#/definitions/ANRInfo"
1230 "description": "A list of ANR solutions."
1243 "description": "cellId with modified PCI value",
1244 "example": "cell0001"
1248 "description": "New PCI value for cellId",
1257 "removeableNeighbors"
1262 "description": "cellId with modified PCI value",
1263 "example": "cell0001"
1265 "removeableNeighbors": {
1270 "description": "List of neighbors to be removed",
1278 "NSTSelectionRequest": {
1286 "$ref": "#/definitions/RequestInfo2"
1289 "$ref": "#/definitions/ServiceProfile"
1293 "NSISelectionRequest": {
1302 "$ref": "#/definitions/ServiceProfile"
1305 "$ref": "#/definitions/RequestInfo2"
1309 "description": "List of NST(s)",
1311 "$ref": "#/definitions/NSTInfo"
1316 "NSSISelectionRequest": {
1325 "$ref": "#/definitions/SliceProfile"
1328 "$ref": "#/definitions/RequestInfo2"
1331 "$ref": "#/definitions/NSSTInfo"
1345 "description": "UUID of NST"
1350 "description": "Invariant UUID"
1364 "description": "UUID of NSST"
1369 "description": "Invariant UUID"
1375 "description": "JSON blob. Containing service profile parameters. The contents are based on 3GPP TS 23.541 Release 16 contents, and will be in the form of attribute value pairs.",
1382 "description": "JSON blob. Containing slice profile parameters. The contents are based on 3GPP TS 23.541 Release 16 contents, and will be in the form of attribute value pairs.",
1399 "description": "unique ID to track an ONAP transaction",
1400 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
1405 "description": "A unique ID to track multiple requests associated with a transaction",
1406 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
1411 "description": "The end point of a callback service where recommendations are posted.",
1412 "example": "myDomain.com/myCallback"
1416 "description": "JSON blob. The header information a client expecting in a async callback.",
1423 "description": "The unique ID of a client making an optimization call.",
1424 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
1428 "description": "A tolerance window (in second) for expecting solutions.",
1433 "NSTAsynchronousResponse": {
1445 "description": "unique ID to track an ONAP transaction",
1446 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
1451 "description": "A unique ID to track multiple requests associated with a transaction",
1452 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
1456 "description": "Reasoning if a requestStatus is failed."
1465 "description": "The status of a request."
1470 "$ref": "#/definitions/NSTSolution"
1472 "description": "A list of NST solutions"
1488 "description": "Invariant UUID of NST"
1492 "format": "UUID of NST"
1496 "description": "NST name"
1500 "description": "JSON blob. Containing details of match of requirements in slice profile and percentage of fit"
1504 "NSIAsynchronousResponse": {
1516 "description": "unique ID to track an ONAP transaction",
1517 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
1522 "description": "A unique ID to track multiple requests associated with a transaction",
1523 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
1527 "description": "Reasoning if a requestStatus is failed."
1536 "description": "The status of a request."
1539 "$ref": "#/definitions/NSISolution"
1546 "sharedNSIsolutions": {
1549 "$ref": "#/definitions/SharedNSISolution"
1551 "description": "A list of shared NSI solutions"
1553 "newNSISolutions": {
1556 "$ref": "#/definitions/NewNSISolution"
1558 "description": "A list of new NSI solutions"
1562 "SharedNSISolution": {
1575 "description": "Invariant UUID of NST"
1580 "description": "UUID of NST"
1584 "description": "Name of NSI"
1589 "description": "Id of NSI"
1601 "$ref": "#/definitions/NSTResponseInfo"
1605 "description": "List of NSSIs which when concatenated shall form the NSI, in case NSSI is not present, only the sliceProfile will be included",
1607 "$ref": "#/definitions/NSSIInfo"
1612 "description": "JSON blob. Containing details of match of requirements in service profile, and recommendation rank"
1616 "NSTResponseInfo": {
1626 "description": "NST name"
1631 "description": "UUID of NST"
1636 "description": "Invariant UUID"
1648 "description": "JSON blob. Containing details of match of requirements in slice profile and percentage of fit"
1651 "$ref": "#/definitions/NSSTResponseInfo"
1654 "$ref": "#/definitions/NSSIObject"
1658 "NSSTResponseInfo": {
1668 "description": "Name of the NSST"
1673 "description": "UUID of NSST"
1678 "description": "Invariant UUID"
1692 "description": "Name of NSSI"
1696 "description": "Id of NSSI"
1700 "description": "JSON blob. Containing details of match of requirements in slice profile and percentage of fit"
1704 "NSSIAsynchronousResponse": {
1716 "description": "unique ID to track an ONAP transaction",
1717 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
1722 "description": "A unique ID to track multiple requests associated with a transaction",
1723 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
1727 "description": "Reasoning if a requestStatus is failed."
1736 "description": "The status of a request."
1741 "$ref": "#/definitions/NSSISolution"
1743 "description": "A list of NSSI solutions"
1760 "description": "Invariant UUID of NSST"
1765 "description": "UUID of NSST"
1769 "description": "Name of NSSI"
1773 "description": "Id of NSSI"
1777 "description": "JSON blob. Containing details of match of requirements in slice profile and percentage of fit"
1785 "host": "virtserver.swaggerhub.com",
1786 "basePath": "/oof-osdf/v1"