Add swagger.json to main/resources.

[aai/esr-server.git] / esr-mgr / src / main / resources / swagger.json

diff --git a/esr-mgr/src/main/resources/swagger.json b/esr-mgr/src/main/resources/swagger.json
new file mode 100644 (file)
index 0000000..155b4cb
--- /dev/null
+++ b/esr-mgr/src/main/resources/swagger.json
@@ -0,0 +1,723 @@
+{\r
+  "swagger" : "2.0",\r
+  "info" : {\r
+    "description" : "This page shows all the APIs available in the ESR server module.",\r
+    "version" : "v1",\r
+    "title" : "API Descriptions for External System Management",\r
+    "termsOfService" : "http://www.github.com/kongchen/swagger-maven-plugin",\r
+    "contact" : {\r
+      "name" : "Zi Li",\r
+      "email" : "li.zi30@zte.com.cn"\r
+    },\r
+    "license" : {\r
+      "name" : "Apache 2.0",\r
+      "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"\r
+    }\r
+  },\r
+  "basePath" : "/api/aai-esr-server/v1/",\r
+  "tags" : [ {\r
+    "name" : " ems Management "\r
+  }, {\r
+    "name" : " service test "\r
+  }, {\r
+    "name" : " vim Management "\r
+  }, {\r
+    "name" : " vnfm Management "\r
+  }, {\r
+    "name" : "ThirdParty sdnc Management     "\r
+  } ],\r
+  "paths" : {\r
+    "/emses" : {\r
+      "get" : {\r
+        "tags" : [ " ems Management " ],\r
+        "summary" : "get  all ems ",\r
+        "description" : "",\r
+        "operationId" : "queryEmsList",\r
+        "produces" : [ "application/json" ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      },\r
+      "post" : {\r
+        "tags" : [ " ems Management " ],\r
+        "summary" : "create a ems",\r
+        "description" : "",\r
+        "operationId" : "registerEms",\r
+        "consumes" : [ "application/json" ],\r
+        "produces" : [ "text/plain", "application/json" ],\r
+        "parameters" : [ {\r
+          "in" : "body",\r
+          "name" : "body",\r
+          "description" : "ems",\r
+          "required" : true,\r
+          "schema" : {\r
+            "$ref" : "#/definitions/EmsRegisterInfo"\r
+          }\r
+        } ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "/emses/{emsId}" : {\r
+      "get" : {\r
+        "tags" : [ " ems Management " ],\r
+        "summary" : "get ems by id",\r
+        "description" : "",\r
+        "operationId" : "queryemsById",\r
+        "produces" : [ "application/json" ],\r
+        "parameters" : [ {\r
+          "name" : "emsId",\r
+          "in" : "path",\r
+          "description" : "ems id",\r
+          "required" : true,\r
+          "type" : "string"\r
+        } ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      },\r
+      "put" : {\r
+        "tags" : [ " ems Management " ],\r
+        "summary" : "update a ems",\r
+        "description" : "",\r
+        "operationId" : "updateEms",\r
+        "consumes" : [ "application/json" ],\r
+        "produces" : [ "text/plain", "application/json" ],\r
+        "parameters" : [ {\r
+          "in" : "body",\r
+          "name" : "body",\r
+          "description" : "ems",\r
+          "required" : true,\r
+          "schema" : {\r
+            "$ref" : "#/definitions/EmsRegisterInfo"\r
+          }\r
+        }, {\r
+          "name" : "emsId",\r
+          "in" : "path",\r
+          "description" : "ems id",\r
+          "required" : true,\r
+          "type" : "string"\r
+        } ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      },\r
+      "delete" : {\r
+        "tags" : [ " ems Management " ],\r
+        "summary" : "delete a ems",\r
+        "description" : "",\r
+        "operationId" : "delems",\r
+        "parameters" : [ {\r
+          "name" : "emsId",\r
+          "in" : "path",\r
+          "description" : "ems id",\r
+          "required" : true,\r
+          "type" : "string"\r
+        } ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "/sdncontrollers" : {\r
+      "get" : {\r
+        "tags" : [ "ThirdParty sdnc Management     " ],\r
+        "summary" : "get all thirdParty sdnc ",\r
+        "description" : "",\r
+        "operationId" : "queryThirdpartySdncList",\r
+        "produces" : [ "application/json" ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      },\r
+      "post" : {\r
+        "tags" : [ "ThirdParty sdnc Management     " ],\r
+        "summary" : "register a thirdparty sdnc",\r
+        "description" : "",\r
+        "operationId" : "registerThirdpatySdnc",\r
+        "consumes" : [ "application/json" ],\r
+        "produces" : [ "text/plain", "application/json" ],\r
+        "parameters" : [ {\r
+          "in" : "body",\r
+          "name" : "body",\r
+          "description" : "thirdPartySdnc",\r
+          "required" : true,\r
+          "schema" : {\r
+            "$ref" : "#/definitions/ThirdpartySdncRegisterInfo"\r
+          }\r
+        } ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "/sdncontrollers/{thirdPartySdncId}" : {\r
+      "get" : {\r
+        "tags" : [ "ThirdParty sdnc Management     " ],\r
+        "summary" : "get thirdParty sdnc by id",\r
+        "description" : "",\r
+        "operationId" : "queryThirdpartySdncById",\r
+        "produces" : [ "application/json" ],\r
+        "parameters" : [ {\r
+          "name" : "thirdPartySdncId",\r
+          "in" : "path",\r
+          "description" : "thirdparty sdnc id",\r
+          "required" : true,\r
+          "type" : "string"\r
+        } ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      },\r
+      "put" : {\r
+        "tags" : [ "ThirdParty sdnc Management     " ],\r
+        "summary" : "update a thirdParty Sdnc",\r
+        "description" : "",\r
+        "operationId" : "updateThirdpartySdnc",\r
+        "consumes" : [ "application/json" ],\r
+        "produces" : [ "text/plain", "application/json" ],\r
+        "parameters" : [ {\r
+          "in" : "body",\r
+          "name" : "body",\r
+          "description" : "thirdpartySdnc",\r
+          "required" : true,\r
+          "schema" : {\r
+            "$ref" : "#/definitions/ThirdpartySdncRegisterInfo"\r
+          }\r
+        }, {\r
+          "name" : "thirdPartySdncId",\r
+          "in" : "path",\r
+          "description" : "sdnc id",\r
+          "required" : true,\r
+          "type" : "string"\r
+        } ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      },\r
+      "delete" : {\r
+        "tags" : [ "ThirdParty sdnc Management     " ],\r
+        "summary" : "delete a thirdparty sdnc",\r
+        "description" : "",\r
+        "operationId" : "delThirdpartySdnc",\r
+        "parameters" : [ {\r
+          "name" : "thirdPartySdncId",\r
+          "in" : "path",\r
+          "description" : "thirdparty sdnc id",\r
+          "required" : true,\r
+          "type" : "string"\r
+        } ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "/test" : {\r
+      "get" : {\r
+        "tags" : [ " service test " ],\r
+        "summary" : " service test ",\r
+        "description" : "",\r
+        "operationId" : "queryEmsList",\r
+        "produces" : [ "application/json" ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "/vims" : {\r
+      "get" : {\r
+        "tags" : [ " vim Management " ],\r
+        "summary" : "get  all vim ",\r
+        "description" : "",\r
+        "operationId" : "queryVimList",\r
+        "produces" : [ "application/json" ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      },\r
+      "post" : {\r
+        "tags" : [ " vim Management " ],\r
+        "summary" : "create a vim",\r
+        "description" : "",\r
+        "operationId" : "registerVims",\r
+        "consumes" : [ "application/json" ],\r
+        "produces" : [ "text/plain", "application/json" ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "/vims/{cloudOwner}/{cloudRegionId}" : {\r
+      "get" : {\r
+        "tags" : [ " vim Management " ],\r
+        "summary" : "get vim by id",\r
+        "description" : "",\r
+        "operationId" : "queryVimById",\r
+        "produces" : [ "application/json" ],\r
+        "parameters" : [ {\r
+          "name" : "cloudOwner",\r
+          "in" : "path",\r
+          "required" : true,\r
+          "type" : "string"\r
+        }, {\r
+          "name" : "cloudRegionId",\r
+          "in" : "path",\r
+          "required" : true,\r
+          "type" : "string"\r
+        } ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      },\r
+      "put" : {\r
+        "tags" : [ " vim Management " ],\r
+        "summary" : "update a vim",\r
+        "description" : "",\r
+        "operationId" : "updatevims",\r
+        "consumes" : [ "application/json" ],\r
+        "produces" : [ "application/json" ],\r
+        "parameters" : [ {\r
+          "name" : "cloudOwner",\r
+          "in" : "path",\r
+          "required" : true,\r
+          "type" : "string"\r
+        }, {\r
+          "name" : "cloudRegionId",\r
+          "in" : "path",\r
+          "required" : true,\r
+          "type" : "string"\r
+        } ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      },\r
+      "delete" : {\r
+        "tags" : [ " vim Management " ],\r
+        "summary" : "delete a vim",\r
+        "description" : "",\r
+        "operationId" : "delvim",\r
+        "parameters" : [ {\r
+          "name" : "cloudOwner",\r
+          "in" : "path",\r
+          "required" : true,\r
+          "type" : "string"\r
+        }, {\r
+          "name" : "cloudRegionId",\r
+          "in" : "path",\r
+          "required" : true,\r
+          "type" : "string"\r
+        } ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "/vnfms" : {\r
+      "get" : {\r
+        "tags" : [ " vnfm Management " ],\r
+        "summary" : "get  all vnfm ",\r
+        "description" : "",\r
+        "operationId" : "queryVnfmList",\r
+        "produces" : [ "application/json" ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      },\r
+      "post" : {\r
+        "tags" : [ " vnfm Management " ],\r
+        "summary" : "create a vnfm",\r
+        "description" : "",\r
+        "operationId" : "registerVnfm",\r
+        "consumes" : [ "application/json" ],\r
+        "produces" : [ "text/plain", "application/json" ],\r
+        "parameters" : [ {\r
+          "in" : "body",\r
+          "name" : "body",\r
+          "description" : "vnfm",\r
+          "required" : true,\r
+          "schema" : {\r
+            "$ref" : "#/definitions/VnfmRegisterInfo"\r
+          }\r
+        } ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "/vnfms/{vnfmId}" : {\r
+      "get" : {\r
+        "tags" : [ " vnfm Management " ],\r
+        "summary" : "get vnfm by id",\r
+        "description" : "",\r
+        "operationId" : "queryVnfmById",\r
+        "produces" : [ "application/json" ],\r
+        "parameters" : [ {\r
+          "name" : "vnfmId",\r
+          "in" : "path",\r
+          "description" : "vnfm id",\r
+          "required" : true,\r
+          "type" : "string"\r
+        } ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      },\r
+      "put" : {\r
+        "tags" : [ " vnfm Management " ],\r
+        "summary" : "update a vnfm",\r
+        "description" : "",\r
+        "operationId" : "updateVnfm",\r
+        "consumes" : [ "application/json" ],\r
+        "produces" : [ "text/plain", "application/json" ],\r
+        "parameters" : [ {\r
+          "in" : "body",\r
+          "name" : "body",\r
+          "description" : "vnfm",\r
+          "required" : true,\r
+          "schema" : {\r
+            "$ref" : "#/definitions/VnfmRegisterInfo"\r
+          }\r
+        }, {\r
+          "name" : "vnfmId",\r
+          "in" : "path",\r
+          "description" : "vnfm id",\r
+          "required" : true,\r
+          "type" : "string"\r
+        } ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      },\r
+      "delete" : {\r
+        "tags" : [ " vnfm Management " ],\r
+        "summary" : "delete a vnfm",\r
+        "description" : "",\r
+        "operationId" : "delVnfm",\r
+        "parameters" : [ {\r
+          "name" : "vnfmId",\r
+          "in" : "path",\r
+          "description" : "vnfm id",\r
+          "required" : true,\r
+          "type" : "string"\r
+        } ],\r
+        "responses" : {\r
+          "404" : {\r
+            "description" : "microservice not found"\r
+          },\r
+          "415" : {\r
+            "description" : "Unprocessable MicroServiceInfo Entity "\r
+          },\r
+          "500" : {\r
+            "description" : "internal server error"\r
+          }\r
+        }\r
+      }\r
+    }\r
+  },\r
+  "definitions" : {\r
+    "AlarmAddr" : {\r
+      "type" : "object",\r
+      "properties" : {\r
+        "ip" : {\r
+          "type" : "string"\r
+        },\r
+        "port" : {\r
+          "type" : "string"\r
+        },\r
+        "user" : {\r
+          "type" : "string"\r
+        },\r
+        "password" : {\r
+          "type" : "string"\r
+        }\r
+      }\r
+    },\r
+    "EmsRegisterInfo" : {\r
+      "type" : "object",\r
+      "properties" : {\r
+        "emsId" : {\r
+          "type" : "string"\r
+        },\r
+        "name" : {\r
+          "type" : "string"\r
+        },\r
+        "vendor" : {\r
+          "type" : "string"\r
+        },\r
+        "version" : {\r
+          "type" : "string"\r
+        },\r
+        "resourceAddr" : {\r
+          "$ref" : "#/definitions/FtpAddr"\r
+        },\r
+        "performanceAddr" : {\r
+          "$ref" : "#/definitions/FtpAddr"\r
+        },\r
+        "alarmAddr" : {\r
+          "$ref" : "#/definitions/AlarmAddr"\r
+        }\r
+      }\r
+    },\r
+    "FtpAddr" : {\r
+      "type" : "object",\r
+      "properties" : {\r
+        "ftptype" : {\r
+          "type" : "string"\r
+        },\r
+        "ip" : {\r
+          "type" : "string"\r
+        },\r
+        "port" : {\r
+          "type" : "string"\r
+        },\r
+        "user" : {\r
+          "type" : "string"\r
+        },\r
+        "password" : {\r
+          "type" : "string"\r
+        },\r
+        "remotepath" : {\r
+          "type" : "string"\r
+        },\r
+        "passive" : {\r
+          "type" : "boolean",\r
+          "default" : false\r
+        }\r
+      }\r
+    },\r
+    "ThirdpartySdncRegisterInfo" : {\r
+      "type" : "object",\r
+      "properties" : {\r
+        "thirdpartySdncId" : {\r
+          "type" : "string"\r
+        },\r
+        "name" : {\r
+          "type" : "string"\r
+        },\r
+        "vendor" : {\r
+          "type" : "string"\r
+        },\r
+        "version" : {\r
+          "type" : "string"\r
+        },\r
+        "type" : {\r
+          "type" : "string"\r
+        },\r
+        "location" : {\r
+          "type" : "string"\r
+        },\r
+        "url" : {\r
+          "type" : "string"\r
+        },\r
+        "userName" : {\r
+          "type" : "string"\r
+        },\r
+        "password" : {\r
+          "type" : "string"\r
+        },\r
+        "productName" : {\r
+          "type" : "string"\r
+        },\r
+        "protocol" : {\r
+          "type" : "string"\r
+        }\r
+      }\r
+    },\r
+    "VnfmRegisterInfo" : {\r
+      "type" : "object",\r
+      "properties" : {\r
+        "vnfmId" : {\r
+          "type" : "string"\r
+        },\r
+        "name" : {\r
+          "type" : "string"\r
+        },\r
+        "type" : {\r
+          "type" : "string"\r
+        },\r
+        "vimId" : {\r
+          "type" : "string"\r
+        },\r
+        "vendor" : {\r
+          "type" : "string"\r
+        },\r
+        "version" : {\r
+          "type" : "string"\r
+        },\r
+        "certificateUrl" : {\r
+          "type" : "string"\r
+        },\r
+        "url" : {\r
+          "type" : "string"\r
+        },\r
+        "userName" : {\r
+          "type" : "string"\r
+        },\r
+        "password" : {\r
+          "type" : "string"\r
+        }\r
+      }\r
+    }\r
+  }\r
+}
\ No newline at end of file