fix osdf swagger doc issue 85/108085/1
authordhebeha <dhebeha.mj71@wipro.com>
Thu, 21 May 2020 15:45:39 +0000 (21:15 +0530)
committerdhebeha <dhebeha.mj71@wipro.com>
Thu, 21 May 2020 15:49:38 +0000 (21:19 +0530)
Issue-ID: OPTFRA-565
Signed-off-by: dhebeha <dhebeha.mj71@wipro.com>
Change-Id: I381d119371840fc1f5563a1a2c0cbda6d3b0960e

docs/sections/swaggerdoc/oof-osdf-has-api.json

index aa48e39..ec5d003 100644 (file)
       }
     },
     "/api/oof/placement/v1": {
-      "$ref": "#/paths/~1v2~1placement"
+      "post": {
+        "tags": [
+          "Placement Optimization"
+        ],
+        "summary": "create/update a placement",
+        "operationId": "createPlacementv1",
+        "description": "create/update a placement",
+        "consumes": [
+          "application/json"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "in": "body",
+            "name": "placementRequest",
+            "description": "placement request",
+            "schema": {
+              "$ref": "#/definitions/PlacementRequest"
+            }
+          }
+        ],
+        "responses": {
+          "201": {
+            "description": "An optimization solution is found."
+          },
+          "202": {
+            "description": "An optimization request is accepted"
+          },
+          "400": {
+            "description": "bad request"
+          },
+          "401": {
+            "description": "Request body is not compliant with the API definition"
+          },
+          "404": {
+            "description": "The server cannot find the requested URI"
+          },
+          "405": {
+            "description": "The requested method is not supported by a server."
+          },
+          "500": {
+            "description": "The server encountered an internal server error or timed out"
+          }
+        }
+      }
     },
     "/api/oof/v1/pci": {
       "post": {
       }
     },
     "/api/oof/pci/v1": {
-      "$ref": "#/paths/~1api~1oof~1v1~1pci"
+      "post": {
+        "tags": [
+          "PCI/ANR Optimization"
+        ],
+        "summary": "Initiate PCI/ANR Optimization",
+        "operationId": "initiatePCIOptRequestv1",
+        "description": "Initiate PCI/ANR Optimization",
+        "consumes": [
+          "application/json"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "in": "body",
+            "name": "PCIOptimizationRequest",
+            "description": "PCI request",
+            "schema": {
+              "$ref": "#/definitions/PCIOptRequest"
+            }
+          }
+        ],
+        "responses": {
+          "201": {
+            "description": "An optimization solution is found."
+          },
+          "202": {
+            "description": "An optimization request is accepted"
+          },
+          "400": {
+            "description": "bad request"
+          },
+          "401": {
+            "description": "Request body is not compliant with the API definition"
+          },
+          "404": {
+            "description": "The server cannot find the requested URI"
+          },
+          "405": {
+            "description": "The requested method is not supported by a server."
+          },
+          "500": {
+            "description": "The server encountered an internal server error or timed out"
+          }
+        }
+      }
     },
     "/api/oof/selection/nst/v1": {
       "post": {
     "ServiceProfileNst": {
       "type": "object",
       "required": [
-          "serviceProfileParameters"
+        "serviceProfileParameters"
       ],
       "properties": {
-        "serviceProfileParameters":{
+        "serviceProfileParameters": {
           "$ref": "#/definitions/ServiceProfile"
         }
       }
             "$ref": "#/definitions/NSSI"
           },
           "description": "A list of NSSIs"
-        },
+        }
       }
     },
-    "NSSI":{
+    "NSSI": {
       "type": "object",
       "required": [
         "NSSIName",
           "items": {
             "$ref": "#/definitions/SliceProfile"
           },
-          "description": "list of SliceProfiles",
+          "description": "list of SliceProfiles"
         }
       }
     },
   ],
   "host": "virtserver.swaggerhub.com",
   "basePath": "/oof-osdf/v1"
-}
+}
\ No newline at end of file