From 998f35e5100014b9d639e52020a70ff4db53ddd3 Mon Sep 17 00:00:00 2001
From: vrvarma <vv8305@att.com>
Date: Fri, 24 Jan 2020 10:22:07 -0500
Subject: [PATCH] OOF API changes to add fixed and special treatments

Adding fixed cell list to fix the pci assignments
priority cells, which will get special treatment for pci assignment

Change-Id: Ibeff853c3e4eb1f7ad34030c196795999b5079f9
Signed-off-by: vrvarma <vv8305@att.com>
Issue-ID: OPTFRA-685
---
 apps/pci/models/api/pciOptimizationRequest.py  |  2 ++
 docs/sections/swaggerdoc/oof-osdf-has-api.json | 37 ++++++++++++++++++++++++++
 2 files changed, 39 insertions(+)

diff --git a/apps/pci/models/api/pciOptimizationRequest.py b/apps/pci/models/api/pciOptimizationRequest.py
index 02b67a2..2aa22f1 100644
--- a/apps/pci/models/api/pciOptimizationRequest.py
+++ b/apps/pci/models/api/pciOptimizationRequest.py
@@ -45,6 +45,8 @@ class CellInfo(OSDFModel):
     networkId = StringType(required=True)
     cellIdList = ListType(StringType(required=True))
     anrInputList = ListType(ModelType(ANRInfo))
+    fixedPCICells = ListType(StringType())
+    priorityTreatmentCells = ListType(StringType())
     trigger = StringType()
 
 
diff --git a/docs/sections/swaggerdoc/oof-osdf-has-api.json b/docs/sections/swaggerdoc/oof-osdf-has-api.json
index e52c39b..b2b90a8 100644
--- a/docs/sections/swaggerdoc/oof-osdf-has-api.json
+++ b/docs/sections/swaggerdoc/oof-osdf-has-api.json
@@ -26,6 +26,9 @@
   "paths": {
     "/v2/placement": {
       "post": {
+        "tags": [
+          "Placement Optimization"
+        ],
         "summary": "create/update a placement",
         "operationId": "createPlacement",
         "description": "create/update a placement",
@@ -75,6 +78,9 @@
     },
     "/api/oof/v1/pci": {
       "post": {
+        "tags": [
+          "PCI/ANR Optimization"
+        ],
         "summary": "Initiate PCI/ANR Optimization",
         "operationId": "initiatePCIOptRequest",
         "description": "Initiate PCI/ANR Optimization",
@@ -124,6 +130,9 @@
     },
     "/api/oof/selection/nst/v1": {
       "post": {
+        "tags": [
+          "NST Selection"
+        ],
         "summary": "NST selection",
         "operationId": "selectNstRequest",
         "description": "Request for NST selection",
@@ -170,6 +179,9 @@
     },
     "/api/oof/selection/nsi/v1": {
       "post": {
+        "tags": [
+          "NSI Selection"
+        ],
         "summary": "NSI selection",
         "operationId": "selectNsiRequest",
         "description": "Request for NSI selection",
@@ -216,6 +228,9 @@
     },
     "/api/oof/selection/nssi/v1": {
       "post": {
+        "tags": [
+          "NSSI Selection"
+        ],
         "summary": "NSSI selection",
         "operationId": "selectNssiRequest",
         "description": "Request for NSSI selection",
@@ -1118,6 +1133,28 @@
           },
           "description": "A list of ANR Input."
         },
+        "fixedPCICells": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "List of blacklisted cells whose PCI values should not be changed",
+          "example": [
+            "cell0007",
+            "cell0009"
+          ]
+        },
+        "priorityTreatmentCells": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "List of cells which should be given special treatment during optimization",
+          "example": [
+            "cell0010",
+            "cell0003"
+          ]
+        },
         "trigger": {
           "type": "string",
           "description": "Type of trigger causing need for PCI optimization",
-- 
2.16.6