@itentialopensource/adapter-nokia_altiplano 0.1.3 → 0.4.0

package/pronghorn.json

@@ -386,6 +386,198 @@
       },
       "task": true
     },
+    {
+      "name": "moveEntitiesToDB",
+      "summary": "Moves entities from an adapter into the IAP database",
+      "description": "Moves entities from an adapter into the IAP database",
+      "input": [],
+      "output": {
+        "name": "res",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the response from the mongo transaction",
+        "schema": {
+          "title": "res",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/moveEntitiesToDB"
+      },
+      "task": true
+    },
+    {
+      "name": "getDevice",
+      "summary": "Get the Appliance",
+      "description": "Get the Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getDevice"
+      },
+      "task": false
+    },
+    {
+      "name": "getDevicesFiltered",
+      "summary": "Get Appliances that match the filter",
+      "description": "Get Appliances that match the filter",
+      "input": [
+        {
+          "name": "options",
+          "type": "object",
+          "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
+          "required": true,
+          "schema": {
+            "title": "options",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "array",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "array"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getDevicesFiltered"
+      },
+      "task": false
+    },
+    {
+      "name": "isAlive",
+      "summary": "Checks the status for the provided Appliance",
+      "description": "Checks the status for the provided Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "boolean",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "boolean"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/isAlive"
+      },
+      "task": false
+    },
+    {
+      "name": "getConfig",
+      "summary": "Gets a config for the provided Appliance",
+      "description": "Gets a config for the provided Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        },
+        {
+          "name": "format",
+          "type": "string",
+          "info": "The format to be returned - this is ignored as we always return json",
+          "required": false,
+          "schema": {
+            "title": "format",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getConfig"
+      },
+      "task": false
+    },
+    {
+      "name": "getCount",
+      "summary": "Gets a device count from the system",
+      "description": "Gets a device count from the system",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getCount"
+      },
+      "task": false
+    },
     {
       "name": "getAccessToken",
       "summary": "GetAccessToken",
@@ -795,6 +987,194 @@
       },
       "task": true
     },
+    {
+      "name": "createOntWithQuery",
+      "summary": "Create ont with query",
+      "description": "Create ont with query",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": ": {\"ibn:intent\": {\"target\": \"string\", \"intent-type\": \"string\", \"intent-type-version\": \"string\", \"required-network-state\": \"string\", \"intent-specific-data\": {\"ont:ont\": {\"ont-type\": \"string\", \"fiber-name\": \"string\", \"expected-serial-number\": \"string\", \"onu-service-profile\": \"string\", \"uni-service-configuration\": {\"uni-id\": \"string\", \"service-profile\": \"string\"}}}}}",
+          "required": true,
+          "schema": {
+            "title": "CreateontRequest",
+            "required": [
+              "ibn:intent"
+            ],
+            "type": "object",
+            "properties": {
+              "ibn:intent": {
+                "title": "IbnIntent",
+                "required": [
+                  "target",
+                  "intent-type",
+                  "intent-type-version",
+                  "required-network-state",
+                  "intent-specific-data"
+                ],
+                "type": "object",
+                "properties": {
+                  "target": {
+                    "type": "string"
+                  },
+                  "intent-type": {
+                    "type": "string"
+                  },
+                  "intent-type-version": {
+                    "type": "string"
+                  },
+                  "required-network-state": {
+                    "type": "string"
+                  },
+                  "intent-specific-data": {
+                    "title": "IntentSpecificData",
+                    "required": [
+                      "ont:ont"
+                    ],
+                    "type": "object",
+                    "properties": {
+                      "ont:ont": {
+                        "title": "OntOnt",
+                        "required": [
+                          "ont-type",
+                          "fiber-name",
+                          "expected-serial-number",
+                          "onu-service-profile",
+                          "uni-service-configuration"
+                        ],
+                        "type": "object",
+                        "properties": {
+                          "ont-type": {
+                            "type": "string"
+                          },
+                          "fiber-name": {
+                            "type": "string"
+                          },
+                          "expected-serial-number": {
+                            "type": "string"
+                          },
+                          "onu-service-profile": {
+                            "type": "string"
+                          },
+                          "uni-service-configuration": {
+                            "title": "UniServiceConfiguration",
+                            "required": [
+                              "uni-id",
+                              "service-profile"
+                            ],
+                            "type": "object",
+                            "properties": {
+                              "uni-id": {
+                                "type": "string"
+                              },
+                              "service-profile": {
+                                "type": "string"
+                              }
+                            },
+                            "example": {
+                              "uni-id": "LAN1",
+                              "service-profile": "default"
+                            }
+                          }
+                        },
+                        "example": {
+                          "ont-type": "G-010G-Q",
+                          "fiber-name": "INES-1-1-4-3",
+                          "expected-serial-number": "ALCLF846403A",
+                          "onu-service-profile": "default",
+                          "uni-service-configuration": {
+                            "uni-id": "LAN1",
+                            "service-profile": "default"
+                          }
+                        }
+                      }
+                    },
+                    "example": {
+                      "ont:ont": {
+                        "ont-type": "G-010G-Q",
+                        "fiber-name": "INES-1-1-4-3",
+                        "expected-serial-number": "ALCLF846403A",
+                        "onu-service-profile": "default",
+                        "uni-service-configuration": {
+                          "uni-id": "LAN1",
+                          "service-profile": "default"
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "target": "INES-1-1-4-3-a",
+                  "intent-type": "ont",
+                  "intent-type-version": "4",
+                  "required-network-state": "active",
+                  "intent-specific-data": {
+                    "ont:ont": {
+                      "ont-type": "G-010G-Q",
+                      "fiber-name": "INES-1-1-4-3",
+                      "expected-serial-number": "ALCLF846403A",
+                      "onu-service-profile": "default",
+                      "uni-service-configuration": {
+                        "uni-id": "LAN1",
+                        "service-profile": "default"
+                      }
+                    }
+                  }
+                }
+              }
+            },
+            "example": {
+              "ibn:intent": {
+                "target": "INES-1-1-4-3-a",
+                "intent-type": "ont",
+                "intent-type-version": "4",
+                "required-network-state": "active",
+                "intent-specific-data": {
+                  "ont:ont": {
+                    "ont-type": "G-010G-Q",
+                    "fiber-name": "INES-1-1-4-3",
+                    "expected-serial-number": "ALCLF846403A",
+                    "onu-service-profile": "default",
+                    "uni-service-configuration": {
+                      "uni-id": "LAN1",
+                      "service-profile": "default"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        {
+          "name": "query",
+          "type": "object",
+          "info": "{\"altiplano-triggerSyncUponSuccess\": \"true\"}",
+          "required": true,
+          "schema": {
+            "title": "query",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/createOntWithQuery"
+      },
+      "task": true
+    },
     {
       "name": "getOnt",
       "summary": "GET ont",
@@ -1256,6 +1636,217 @@
         "path": "/auditl2User"
       },
       "task": true
+    },
+    {
+      "name": "getIbnIntent",
+      "summary": "GET ibn intent",
+      "description": "GET ibn intent",
+      "input": [
+        {
+          "name": "intent",
+          "type": "string",
+          "info": "the intent value, type (MYINTONT1,ont)",
+          "required": true,
+          "schema": {
+            "title": "intent",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getIbnIntent"
+      },
+      "task": true
+    },
+    {
+      "name": "modifyIbnIntent",
+      "summary": "Modify ibn intent",
+      "description": "This request sample is used to modify intent state.\r\nThe value of required-network-state can be active or suspend or delete",
+      "input": [
+        {
+          "name": "intent",
+          "type": "string",
+          "info": "the intent value, type (MYINTONT1,ont)",
+          "required": true,
+          "schema": {
+            "title": "intent",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": ": {\"ibn:intent\": {\"intent-type-version\": 123, \"required-network-state\": \"string\"}}",
+          "required": true,
+          "schema": {
+            "title": "LockontRequest",
+            "required": [
+              "ibn:intent"
+            ],
+            "type": "object",
+            "properties": {
+              "ibn:intent": {
+                "title": "IbnIntent3",
+                "required": [
+                  "intent-type-version",
+                  "required-network-state"
+                ],
+                "type": "object",
+                "properties": {
+                  "intent-type-version": {
+                    "type": "integer"
+                  },
+                  "required-network-state": {
+                    "type": "string"
+                  }
+                },
+                "example": {
+                  "intent-type-version": 4,
+                  "required-network-state": "suspend"
+                }
+              }
+            },
+            "example": {
+              "ibn:intent": {
+                "intent-type-version": 4,
+                "required-network-state": "suspend"
+              }
+            }
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/modifyIbnIntent"
+      },
+      "task": true
+    },
+    {
+      "name": "deleteIbnIntent",
+      "summary": "Delete ibn intent",
+      "description": "This request sample is used to delete an intent.",
+      "input": [
+        {
+          "name": "intent",
+          "type": "string",
+          "info": "the intent value, type (MYINTONT1,ont)",
+          "required": true,
+          "schema": {
+            "title": "intent",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/deleteIbnIntent"
+      },
+      "task": true
+    },
+    {
+      "name": "synchronizeIbnIntent",
+      "summary": "Synchronize ibn intent",
+      "description": "Synchronize ibn intent",
+      "input": [
+        {
+          "name": "intent",
+          "type": "string",
+          "info": "the intent value, type (MYINTONT1,ont)",
+          "required": true,
+          "schema": {
+            "title": "intent",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/synchronizeIbnIntent"
+      },
+      "task": true
+    },
+    {
+      "name": "auditIbnIntent",
+      "summary": "Audit ibn intent",
+      "description": "Audit ibn intent",
+      "input": [
+        {
+          "name": "intent",
+          "type": "string",
+          "info": "the intent value, type (MYINTONT1,ont)",
+          "required": true,
+          "schema": {
+            "title": "intent",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/auditIbnIntent"
+      },
+      "task": true
     }
   ],
   "views": []