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"
29 "summary": "create/update a placement",
30 "operationId": "createPlacement",
31 "description": "create/update a placement",
41 "name": "placementRequest",
42 "description": "placement request",
44 "$ref": "#/definitions/PlacementRequest"
50 "description": "An optimization solution is found."
53 "description": "An optimization request is accepted"
56 "description": "bad request"
59 "description": "Request body is not compliant with the API definition"
62 "description": "The server cannot find the requested URI"
65 "description": "The requested method is not supported by a server."
68 "description": "The server encountered an internal server error or timed out"
73 "/api/oof/placement/v1": {
74 "$ref": "#/paths/~1v2~1placement"
78 "summary": "Initiate PCI/ANR Optimization",
79 "operationId": "initiatePCIOptRequest",
80 "description": "Initiate PCI/ANR Optimization",
90 "name": "PCIOptimizationRequest",
91 "description": "PCI request",
93 "$ref": "#/definitions/PCIOptRequest"
99 "description": "An optimization solution is found."
102 "description": "An optimization request is accepted"
105 "description": "bad request"
108 "description": "Request body is not compliant with the API definition"
111 "description": "The server cannot find the requested URI"
114 "description": "The requested method is not supported by a server."
117 "description": "The server encountered an internal server error or timed out"
123 "$ref": "#/paths/~1api~1oof~1v1~1pci"
127 "PlacementRequest": {
137 "$ref": "#/definitions/RequestInfo"
140 "$ref": "#/definitions/PlacementInfo"
143 "$ref": "#/definitions/LicenseInfo"
146 "$ref": "#/definitions/ServiceInfo"
165 "description": "unique ID to track an ONAP transaction",
166 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
171 "description": "A unique ID to track multiple requests associated with a transaction",
172 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
177 "description": "The end point of a callback service where recommendations are posted.",
178 "example": "myDomain.com/myCallback"
182 "description": "JSON blob. The header information a client expecting in a async callback.",
189 "description": "The unique ID of a client making an optimization call.",
190 "example": "d290f1ee-6c54-4b01-90e6-d701748f0851"
199 "description": "The type of a request",
204 "description": "Expected number of solutions.",
217 "description": "A list of optimization services.",
224 "description": "A tolerance window (in second) for expecting solutions.",
236 "requestParameters": {
238 "description": "JSON blob. A service ordering information",
243 "placementDemands": {
246 "$ref": "#/definitions/PlacementDemand"
248 "description": "The resource information for a placement service"
253 "$ref": "#/definitions/SubscriberInfo"
255 "description": "The information of a service subscriber."
262 "resourceModuleName",
267 "resourceModuleName": {
269 "description": "A resource name as defined in a service mode",
270 "example": "myResourceName"
272 "serviceResourceId": {
274 "description": "A unique resource Id with a local scope between client and OOF.",
275 "example": "myResourceId"
279 "additionalProperties": {
290 "description": "placement parameters defined in the ordering system, keyname include tenantId",
295 "resourceModelInfo": {
296 "$ref": "#/definitions/ModelMetaData"
298 "existingCandidates": {
299 "$ref": "#/definitions/Candidates"
301 "excludedCandidates": {
302 "$ref": "#/definitions/Candidates"
304 "requiredCandidates": {
305 "$ref": "#/definitions/Candidates"
316 "modelInvariantId": {
318 "description": "A model invariant Id as defined in a service model.",
319 "example": "my model invariant Id"
323 "description": "A unique model Id as defined in a service model.",
324 "example": "my unique model Id"
328 "description": "A model name as defined in a service model",
329 "example": "my model name"
333 "description": "A model type as defined in a service model.",
334 "example": "my model type"
338 "description": "A model version as defined in a service model.",
339 "example": "my model version"
341 "modelCustomizationName": {
343 "description": "A model customization name as defined in a service model.",
344 "example": "my model customization"
358 "service_instance_id",
362 "description": "The type of a candidate.",
363 "example": "service_instance_id"
370 "description": "A list of identifiers.",
371 "example": "candidateId"
375 "description": "The name of a cloud owner. Only required if identifierType is cloud_region_id",
376 "example": "cloud_owner"
383 "globalSubscriberId",
385 "subscriberCommonSiteId"
388 "globalSubscriberId": {
390 "description": "An ID of a subscriber.",
391 "example": "subscriber_id"
395 "description": "The name of a subscriber. If the name is not known, the value must be 'unknown'",
396 "example": "subscriber_name"
398 "subscriberCommonSiteId": {
400 "description": "Id representing a subscriber location",
401 "example": "subscriber_location_id"
414 "$ref": "#/definitions/LicenseDemands"
416 "description": "A list of resources for license selection"
423 "resourceModuleName",
428 "resourceModuleName": {
430 "description": "A resource name as defined in a service model.",
431 "example": "service_instance_id"
433 "serviceResourceId": {
435 "description": "A unique resource Id with a local scope between client and OOF.",
436 "example": "service_instance_id"
438 "resourceModelInfo": {
439 "$ref": "#/definitions/ModelMetaData"
441 "existingLicenses": {
442 "$ref": "#/definitions/LicenseModel"
449 "entitlementPoolUUID",
450 "licenseKeyGroupUUID"
453 "entitlementPoolUUID": {
459 "description": "Entitlement pool UUIDs associated with a resource.",
460 "example": "candidateId"
462 "licenseKeyGroupUUID": {
468 "description": "License key groups associated with a resource",
469 "example": "candidateId"
473 "SynchronousResponse": {
484 "description": "A unique Id for an ONAP transaction",
485 "example": "ONAP transaction id"
490 "description": "A unique ID to track multiple requests associated with a transaction.",
491 "example": "requests id"
495 "description": "Reasoning if a requestStatus is failure.",
496 "example": "requestStatus"
504 "description": "The status of a request.",
509 "PlacementAsynchronousResponse": {
521 "description": "A unique Id for an ONAP transaction",
522 "example": "ONAP transaction id"
527 "description": "A unique ID to track multiple requests associated with a transaction.",
528 "example": "requests id"
532 "description": "Reasoning if a requestStatus is failure.",
533 "example": "requestStatus"
541 "description": "The status of a request.",
545 "$ref": "#/definitions/Solutions"
552 "placementSolutions",
556 "placementSolutions": {
559 "$ref": "#/definitions/ComprehensiveSolution"
561 "description": "A list of placement solutions."
563 "licenseSolutions": {
566 "$ref": "#/definitions/LicenseSolution"
568 "description": "A list of license solutions."
572 "ComprehensiveSolution": {
578 "placementSolutions": {
581 "$ref": "#/definitions/PlacementSolution"
583 "description": "A list of placement solutions."
587 "PlacementSolution": {
590 "resourceModuleName",
596 "resourceModuleName": {
598 "description": "The name of a resource as defined in the service model",
599 "example": "resource name"
601 "serviceResourceId": {
603 "description": "A resource Id as defined in a service model.",
604 "example": "resource id"
609 "service_instance_id"
611 "description": "The type of a candidate.",
612 "example": "candidate type"
616 "description": "The id of a candidate.",
617 "example": "candidate id"
622 "$ref": "#/definitions/AssignmentInfo"
624 "description": "Additional information related to a candidate."
637 "description": "An attribute name",
638 "example": "attribute name"
642 "description": "An attribute value.",
643 "example": "attribute value"
650 "resourceModuleName",
652 "entitlementPoolUUID",
653 "licenseKeyGroupUUID",
654 "entitlementPoolInvariantUUID",
655 "licenseKeyGroupInvariantUUID"
658 "resourceModuleName": {
660 "description": "A resource name as defined in a service",
661 "example": "resource name"
663 "serviceResourceId": {
665 "description": "A resource Id as defined in a service.",
666 "example": "resource Id"
668 "entitlementPoolUUID": {
674 "description": "A list of entitlementPoolUUIDs",
675 "example": "entitlementPoolUUID"
677 "licenseKeyGroupUUID": {
683 "description": "A list of licenseKeyGroupUUID.",
684 "example": "licenseKeyGroupUUID"
686 "entitlementPoolInvariantUUID": {
692 "description": "A list of entitlementPoolInvariantUUID",
693 "example": "entitlementPoolInvariantUUID"
695 "licenseKeyGroupInvariantUUID": {
701 "description": "A list of licenseKeyGroupInvariantUUID",
702 "example": "licenseKeyGroupInvariantUUID"
714 "serviceInstanceId": {
716 "description": "A service instance id associated with a request.",
717 "example": "service_instance_id"
720 "$ref": "#/definitions/ModelMetaData"
724 "description": "The name of a service",
725 "example": "service_name"
737 "$ref": "#/definitions/RequestInfo"
740 "$ref": "#/definitions/CellInfo"
755 "description": "Id of network requiring PCI optimization",
763 "description": "List of cellIds triggering need for PCI optimization (eg.potential confusion)",
772 "$ref": "#/definitions/ANRInfo"
774 "description": "A list of ANR Input."
778 "description": "Type of trigger causing need for PCI optimization",
779 "example": "NbrListChange"
783 "PCIAsynchronousResponse": {
795 "description": "A unique Id for an ONAP transaction",
796 "example": "ONAP transaction id"
801 "description": "A unique ID to track multiple requests associated with a transaction.",
802 "example": "requests id"
806 "description": "Reasoning if a requestStatus is failure.",
807 "example": "requestStatus"
815 "description": "The status of a request.",
819 "$ref": "#/definitions/PCIANRSolutions"
833 "description": "Id of network requiring PCI optimization",
839 "$ref": "#/definitions/PCISolution"
841 "description": "A list of PCI solutions."
846 "$ref": "#/definitions/ANRInfo"
848 "description": "A list of ANR solutions."
861 "description": "cellId with modified PCI value",
862 "example": "cell0001"
866 "description": "New PCI value for cellId",
875 "removeableNeighbors"
880 "description": "cellId with modified PCI value",
881 "example": "cell0001"
883 "removeableNeighbors": {
888 "description": "List of neighbors to be removed",
900 "host": "virtserver.swaggerhub.com",
901 "basePath": "/oof-osdf/v1"