esr-mgr/src/main/resources/swagger.json

   1 {\r
   2   "swagger" : "2.0",\r
   3   "info" : {\r
   4     "description" : "This page shows all the APIs available in the ESR server module.",\r
   5     "version" : "v1",\r
   6     "title" : "API Descriptions for External System Management",\r
   7     "termsOfService" : "http://www.github.com/kongchen/swagger-maven-plugin",\r
   8     "contact" : {\r
   9       "name" : "Zi Li",\r
  10       "email" : "li.zi30@zte.com.cn"\r
  11     },\r
  12     "license" : {\r
  13       "name" : "Apache 2.0",\r
  14       "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"\r
  15     }\r
  16   },\r
  17   "basePath" : "/api/aai-esr-server/v1/",\r
  18   "tags" : [ {\r
  19     "name" : " ems Management "\r
  20   }, {\r
  21     "name" : " service test "\r
  22   }, {\r
  23     "name" : " vim Management "\r
  24   }, {\r
  25     "name" : " vnfm Management "\r
  26   }, {\r
  27     "name" : "ThirdParty sdnc Management     "\r
  28   } ],\r
  29   "paths" : {\r
  30     "/emses" : {\r
  31       "get" : {\r
  32         "tags" : [ " ems Management " ],\r
  33         "summary" : "get  all ems ",\r
  34         "description" : "",\r
  35         "operationId" : "queryEmsList",\r
  36         "produces" : [ "application/json" ],\r
  37         "responses" : {\r
  38           "404" : {\r
  39             "description" : "microservice not found"\r
  40           },\r
  41           "415" : {\r
  42             "description" : "Unprocessable MicroServiceInfo Entity "\r
  43           },\r
  44           "500" : {\r
  45             "description" : "internal server error"\r
  46           }\r
  47         }\r
  48       },\r
  49       "post" : {\r
  50         "tags" : [ " ems Management " ],\r
  51         "summary" : "create a ems",\r
  52         "description" : "",\r
  53         "operationId" : "registerEms",\r
  54         "consumes" : [ "application/json" ],\r
  55         "produces" : [ "text/plain", "application/json" ],\r
  56         "parameters" : [ {\r
  57           "in" : "body",\r
  58           "name" : "body",\r
  59           "description" : "ems",\r
  60           "required" : true,\r
  61           "schema" : {\r
  62             "$ref" : "#/definitions/EmsRegisterInfo"\r
  63           }\r
  64         } ],\r
  65         "responses" : {\r
  66           "404" : {\r
  67             "description" : "microservice not found"\r
  68           },\r
  69           "415" : {\r
  70             "description" : "Unprocessable MicroServiceInfo Entity "\r
  71           },\r
  72           "500" : {\r
  73             "description" : "internal server error"\r
  74           }\r
  75         }\r
  76       }\r
  77     },\r
  78     "/emses/{emsId}" : {\r
  79       "get" : {\r
  80         "tags" : [ " ems Management " ],\r
  81         "summary" : "get ems by id",\r
  82         "description" : "",\r
  83         "operationId" : "queryemsById",\r
  84         "produces" : [ "application/json" ],\r
  85         "parameters" : [ {\r
  86           "name" : "emsId",\r
  87           "in" : "path",\r
  88           "description" : "ems id",\r
  89           "required" : true,\r
  90           "type" : "string"\r
  91         } ],\r
  92         "responses" : {\r
  93           "404" : {\r
  94             "description" : "microservice not found"\r
  95           },\r
  96           "415" : {\r
  97             "description" : "Unprocessable MicroServiceInfo Entity "\r
  98           },\r
  99           "500" : {\r
 100             "description" : "internal server error"\r
 101           }\r
 102         }\r
 103       },\r
 104       "put" : {\r
 105         "tags" : [ " ems Management " ],\r
 106         "summary" : "update a ems",\r
 107         "description" : "",\r
 108         "operationId" : "updateEms",\r
 109         "consumes" : [ "application/json" ],\r
 110         "produces" : [ "text/plain", "application/json" ],\r
 111         "parameters" : [ {\r
 112           "in" : "body",\r
 113           "name" : "body",\r
 114           "description" : "ems",\r
 115           "required" : true,\r
 116           "schema" : {\r
 117             "$ref" : "#/definitions/EmsRegisterInfo"\r
 118           }\r
 119         }, {\r
 120           "name" : "emsId",\r
 121           "in" : "path",\r
 122           "description" : "ems id",\r
 123           "required" : true,\r
 124           "type" : "string"\r
 125         } ],\r
 126         "responses" : {\r
 127           "404" : {\r
 128             "description" : "microservice not found"\r
 129           },\r
 130           "415" : {\r
 131             "description" : "Unprocessable MicroServiceInfo Entity "\r
 132           },\r
 133           "500" : {\r
 134             "description" : "internal server error"\r
 135           }\r
 136         }\r
 137       },\r
 138       "delete" : {\r
 139         "tags" : [ " ems Management " ],\r
 140         "summary" : "delete a ems",\r
 141         "description" : "",\r
 142         "operationId" : "delems",\r
 143         "parameters" : [ {\r
 144           "name" : "emsId",\r
 145           "in" : "path",\r
 146           "description" : "ems id",\r
 147           "required" : true,\r
 148           "type" : "string"\r
 149         } ],\r
 150         "responses" : {\r
 151           "404" : {\r
 152             "description" : "microservice not found"\r
 153           },\r
 154           "415" : {\r
 155             "description" : "Unprocessable MicroServiceInfo Entity "\r
 156           },\r
 157           "500" : {\r
 158             "description" : "internal server error"\r
 159           }\r
 160         }\r
 161       }\r
 162     },\r
 163     "/sdncontrollers" : {\r
 164       "get" : {\r
 165         "tags" : [ "ThirdParty sdnc Management     " ],\r
 166         "summary" : "get all thirdParty sdnc ",\r
 167         "description" : "",\r
 168         "operationId" : "queryThirdpartySdncList",\r
 169         "produces" : [ "application/json" ],\r
 170         "responses" : {\r
 171           "404" : {\r
 172             "description" : "microservice not found"\r
 173           },\r
 174           "415" : {\r
 175             "description" : "Unprocessable MicroServiceInfo Entity "\r
 176           },\r
 177           "500" : {\r
 178             "description" : "internal server error"\r
 179           }\r
 180         }\r
 181       },\r
 182       "post" : {\r
 183         "tags" : [ "ThirdParty sdnc Management     " ],\r
 184         "summary" : "register a thirdparty sdnc",\r
 185         "description" : "",\r
 186         "operationId" : "registerThirdpatySdnc",\r
 187         "consumes" : [ "application/json" ],\r
 188         "produces" : [ "text/plain", "application/json" ],\r
 189         "parameters" : [ {\r
 190           "in" : "body",\r
 191           "name" : "body",\r
 192           "description" : "thirdPartySdnc",\r
 193           "required" : true,\r
 194           "schema" : {\r
 195             "$ref" : "#/definitions/ThirdpartySdncRegisterInfo"\r
 196           }\r
 197         } ],\r
 198         "responses" : {\r
 199           "404" : {\r
 200             "description" : "microservice not found"\r
 201           },\r
 202           "415" : {\r
 203             "description" : "Unprocessable MicroServiceInfo Entity "\r
 204           },\r
 205           "500" : {\r
 206             "description" : "internal server error"\r
 207           }\r
 208         }\r
 209       }\r
 210     },\r
 211     "/sdncontrollers/{thirdPartySdncId}" : {\r
 212       "get" : {\r
 213         "tags" : [ "ThirdParty sdnc Management     " ],\r
 214         "summary" : "get thirdParty sdnc by id",\r
 215         "description" : "",\r
 216         "operationId" : "queryThirdpartySdncById",\r
 217         "produces" : [ "application/json" ],\r
 218         "parameters" : [ {\r
 219           "name" : "thirdPartySdncId",\r
 220           "in" : "path",\r
 221           "description" : "thirdparty sdnc id",\r
 222           "required" : true,\r
 223           "type" : "string"\r
 224         } ],\r
 225         "responses" : {\r
 226           "404" : {\r
 227             "description" : "microservice not found"\r
 228           },\r
 229           "415" : {\r
 230             "description" : "Unprocessable MicroServiceInfo Entity "\r
 231           },\r
 232           "500" : {\r
 233             "description" : "internal server error"\r
 234           }\r
 235         }\r
 236       },\r
 237       "put" : {\r
 238         "tags" : [ "ThirdParty sdnc Management     " ],\r
 239         "summary" : "update a thirdParty Sdnc",\r
 240         "description" : "",\r
 241         "operationId" : "updateThirdpartySdnc",\r
 242         "consumes" : [ "application/json" ],\r
 243         "produces" : [ "text/plain", "application/json" ],\r
 244         "parameters" : [ {\r
 245           "in" : "body",\r
 246           "name" : "body",\r
 247           "description" : "thirdpartySdnc",\r
 248           "required" : true,\r
 249           "schema" : {\r
 250             "$ref" : "#/definitions/ThirdpartySdncRegisterInfo"\r
 251           }\r
 252         }, {\r
 253           "name" : "thirdPartySdncId",\r
 254           "in" : "path",\r
 255           "description" : "sdnc id",\r
 256           "required" : true,\r
 257           "type" : "string"\r
 258         } ],\r
 259         "responses" : {\r
 260           "404" : {\r
 261             "description" : "microservice not found"\r
 262           },\r
 263           "415" : {\r
 264             "description" : "Unprocessable MicroServiceInfo Entity "\r
 265           },\r
 266           "500" : {\r
 267             "description" : "internal server error"\r
 268           }\r
 269         }\r
 270       },\r
 271       "delete" : {\r
 272         "tags" : [ "ThirdParty sdnc Management     " ],\r
 273         "summary" : "delete a thirdparty sdnc",\r
 274         "description" : "",\r
 275         "operationId" : "delThirdpartySdnc",\r
 276         "parameters" : [ {\r
 277           "name" : "thirdPartySdncId",\r
 278           "in" : "path",\r
 279           "description" : "thirdparty sdnc id",\r
 280           "required" : true,\r
 281           "type" : "string"\r
 282         } ],\r
 283         "responses" : {\r
 284           "404" : {\r
 285             "description" : "microservice not found"\r
 286           },\r
 287           "415" : {\r
 288             "description" : "Unprocessable MicroServiceInfo Entity "\r
 289           },\r
 290           "500" : {\r
 291             "description" : "internal server error"\r
 292           }\r
 293         }\r
 294       }\r
 295     },\r
 296     "/test" : {\r
 297       "get" : {\r
 298         "tags" : [ " service test " ],\r
 299         "summary" : " service test ",\r
 300         "description" : "",\r
 301         "operationId" : "queryEmsList",\r
 302         "produces" : [ "application/json" ],\r
 303         "responses" : {\r
 304           "404" : {\r
 305             "description" : "microservice not found"\r
 306           },\r
 307           "415" : {\r
 308             "description" : "Unprocessable MicroServiceInfo Entity "\r
 309           },\r
 310           "500" : {\r
 311             "description" : "internal server error"\r
 312           }\r
 313         }\r
 314       }\r
 315     },\r
 316     "/vims" : {\r
 317       "get" : {\r
 318         "tags" : [ " vim Management " ],\r
 319         "summary" : "get  all vim ",\r
 320         "description" : "",\r
 321         "operationId" : "queryVimList",\r
 322         "produces" : [ "application/json" ],\r
 323         "responses" : {\r
 324           "404" : {\r
 325             "description" : "microservice not found"\r
 326           },\r
 327           "415" : {\r
 328             "description" : "Unprocessable MicroServiceInfo Entity "\r
 329           },\r
 330           "500" : {\r
 331             "description" : "internal server error"\r
 332           }\r
 333         }\r
 334       },\r
 335       "post" : {\r
 336         "tags" : [ " vim Management " ],\r
 337         "summary" : "create a vim",\r
 338         "description" : "",\r
 339         "operationId" : "registerVims",\r
 340         "consumes" : [ "application/json" ],\r
 341         "produces" : [ "text/plain", "application/json" ],\r
 342         "responses" : {\r
 343           "404" : {\r
 344             "description" : "microservice not found"\r
 345           },\r
 346           "415" : {\r
 347             "description" : "Unprocessable MicroServiceInfo Entity "\r
 348           },\r
 349           "500" : {\r
 350             "description" : "internal server error"\r
 351           }\r
 352         }\r
 353       }\r
 354     },\r
 355     "/vims/{cloudOwner}/{cloudRegionId}" : {\r
 356       "get" : {\r
 357         "tags" : [ " vim Management " ],\r
 358         "summary" : "get vim by id",\r
 359         "description" : "",\r
 360         "operationId" : "queryVimById",\r
 361         "produces" : [ "application/json" ],\r
 362         "parameters" : [ {\r
 363           "name" : "cloudOwner",\r
 364           "in" : "path",\r
 365           "required" : true,\r
 366           "type" : "string"\r
 367         }, {\r
 368           "name" : "cloudRegionId",\r
 369           "in" : "path",\r
 370           "required" : true,\r
 371           "type" : "string"\r
 372         } ],\r
 373         "responses" : {\r
 374           "404" : {\r
 375             "description" : "microservice not found"\r
 376           },\r
 377           "415" : {\r
 378             "description" : "Unprocessable MicroServiceInfo Entity "\r
 379           },\r
 380           "500" : {\r
 381             "description" : "internal server error"\r
 382           }\r
 383         }\r
 384       },\r
 385       "put" : {\r
 386         "tags" : [ " vim Management " ],\r
 387         "summary" : "update a vim",\r
 388         "description" : "",\r
 389         "operationId" : "updatevims",\r
 390         "consumes" : [ "application/json" ],\r
 391         "produces" : [ "application/json" ],\r
 392         "parameters" : [ {\r
 393           "name" : "cloudOwner",\r
 394           "in" : "path",\r
 395           "required" : true,\r
 396           "type" : "string"\r
 397         }, {\r
 398           "name" : "cloudRegionId",\r
 399           "in" : "path",\r
 400           "required" : true,\r
 401           "type" : "string"\r
 402         } ],\r
 403         "responses" : {\r
 404           "404" : {\r
 405             "description" : "microservice not found"\r
 406           },\r
 407           "415" : {\r
 408             "description" : "Unprocessable MicroServiceInfo Entity "\r
 409           },\r
 410           "500" : {\r
 411             "description" : "internal server error"\r
 412           }\r
 413         }\r
 414       },\r
 415       "delete" : {\r
 416         "tags" : [ " vim Management " ],\r
 417         "summary" : "delete a vim",\r
 418         "description" : "",\r
 419         "operationId" : "delvim",\r
 420         "parameters" : [ {\r
 421           "name" : "cloudOwner",\r
 422           "in" : "path",\r
 423           "required" : true,\r
 424           "type" : "string"\r
 425         }, {\r
 426           "name" : "cloudRegionId",\r
 427           "in" : "path",\r
 428           "required" : true,\r
 429           "type" : "string"\r
 430         } ],\r
 431         "responses" : {\r
 432           "404" : {\r
 433             "description" : "microservice not found"\r
 434           },\r
 435           "415" : {\r
 436             "description" : "Unprocessable MicroServiceInfo Entity "\r
 437           },\r
 438           "500" : {\r
 439             "description" : "internal server error"\r
 440           }\r
 441         }\r
 442       }\r
 443     },\r
 444     "/vnfms" : {\r
 445       "get" : {\r
 446         "tags" : [ " vnfm Management " ],\r
 447         "summary" : "get  all vnfm ",\r
 448         "description" : "",\r
 449         "operationId" : "queryVnfmList",\r
 450         "produces" : [ "application/json" ],\r
 451         "responses" : {\r
 452           "404" : {\r
 453             "description" : "microservice not found"\r
 454           },\r
 455           "415" : {\r
 456             "description" : "Unprocessable MicroServiceInfo Entity "\r
 457           },\r
 458           "500" : {\r
 459             "description" : "internal server error"\r
 460           }\r
 461         }\r
 462       },\r
 463       "post" : {\r
 464         "tags" : [ " vnfm Management " ],\r
 465         "summary" : "create a vnfm",\r
 466         "description" : "",\r
 467         "operationId" : "registerVnfm",\r
 468         "consumes" : [ "application/json" ],\r
 469         "produces" : [ "text/plain", "application/json" ],\r
 470         "parameters" : [ {\r
 471           "in" : "body",\r
 472           "name" : "body",\r
 473           "description" : "vnfm",\r
 474           "required" : true,\r
 475           "schema" : {\r
 476             "$ref" : "#/definitions/VnfmRegisterInfo"\r
 477           }\r
 478         } ],\r
 479         "responses" : {\r
 480           "404" : {\r
 481             "description" : "microservice not found"\r
 482           },\r
 483           "415" : {\r
 484             "description" : "Unprocessable MicroServiceInfo Entity "\r
 485           },\r
 486           "500" : {\r
 487             "description" : "internal server error"\r
 488           }\r
 489         }\r
 490       }\r
 491     },\r
 492     "/vnfms/{vnfmId}" : {\r
 493       "get" : {\r
 494         "tags" : [ " vnfm Management " ],\r
 495         "summary" : "get vnfm by id",\r
 496         "description" : "",\r
 497         "operationId" : "queryVnfmById",\r
 498         "produces" : [ "application/json" ],\r
 499         "parameters" : [ {\r
 500           "name" : "vnfmId",\r
 501           "in" : "path",\r
 502           "description" : "vnfm id",\r
 503           "required" : true,\r
 504           "type" : "string"\r
 505         } ],\r
 506         "responses" : {\r
 507           "404" : {\r
 508             "description" : "microservice not found"\r
 509           },\r
 510           "415" : {\r
 511             "description" : "Unprocessable MicroServiceInfo Entity "\r
 512           },\r
 513           "500" : {\r
 514             "description" : "internal server error"\r
 515           }\r
 516         }\r
 517       },\r
 518       "put" : {\r
 519         "tags" : [ " vnfm Management " ],\r
 520         "summary" : "update a vnfm",\r
 521         "description" : "",\r
 522         "operationId" : "updateVnfm",\r
 523         "consumes" : [ "application/json" ],\r
 524         "produces" : [ "text/plain", "application/json" ],\r
 525         "parameters" : [ {\r
 526           "in" : "body",\r
 527           "name" : "body",\r
 528           "description" : "vnfm",\r
 529           "required" : true,\r
 530           "schema" : {\r
 531             "$ref" : "#/definitions/VnfmRegisterInfo"\r
 532           }\r
 533         }, {\r
 534           "name" : "vnfmId",\r
 535           "in" : "path",\r
 536           "description" : "vnfm id",\r
 537           "required" : true,\r
 538           "type" : "string"\r
 539         } ],\r
 540         "responses" : {\r
 541           "404" : {\r
 542             "description" : "microservice not found"\r
 543           },\r
 544           "415" : {\r
 545             "description" : "Unprocessable MicroServiceInfo Entity "\r
 546           },\r
 547           "500" : {\r
 548             "description" : "internal server error"\r
 549           }\r
 550         }\r
 551       },\r
 552       "delete" : {\r
 553         "tags" : [ " vnfm Management " ],\r
 554         "summary" : "delete a vnfm",\r
 555         "description" : "",\r
 556         "operationId" : "delVnfm",\r
 557         "parameters" : [ {\r
 558           "name" : "vnfmId",\r
 559           "in" : "path",\r
 560           "description" : "vnfm id",\r
 561           "required" : true,\r
 562           "type" : "string"\r
 563         } ],\r
 564         "responses" : {\r
 565           "404" : {\r
 566             "description" : "microservice not found"\r
 567           },\r
 568           "415" : {\r
 569             "description" : "Unprocessable MicroServiceInfo Entity "\r
 570           },\r
 571           "500" : {\r
 572             "description" : "internal server error"\r
 573           }\r
 574         }\r
 575       }\r
 576     }\r
 577   },\r
 578   "definitions" : {\r
 579     "AlarmAddr" : {\r
 580       "type" : "object",\r
 581       "properties" : {\r
 582         "ip" : {\r
 583           "type" : "string"\r
 584         },\r
 585         "port" : {\r
 586           "type" : "string"\r
 587         },\r
 588         "user" : {\r
 589           "type" : "string"\r
 590         },\r
 591         "password" : {\r
 592           "type" : "string"\r
 593         }\r
 594       }\r
 595     },\r
 596     "EmsRegisterInfo" : {\r
 597       "type" : "object",\r
 598       "properties" : {\r
 599         "emsId" : {\r
 600           "type" : "string"\r
 601         },\r
 602         "name" : {\r
 603           "type" : "string"\r
 604         },\r
 605         "vendor" : {\r
 606           "type" : "string"\r
 607         },\r
 608         "version" : {\r
 609           "type" : "string"\r
 610         },\r
 611         "resourceAddr" : {\r
 612           "$ref" : "#/definitions/FtpAddr"\r
 613         },\r
 614         "performanceAddr" : {\r
 615           "$ref" : "#/definitions/FtpAddr"\r
 616         },\r
 617         "alarmAddr" : {\r
 618           "$ref" : "#/definitions/AlarmAddr"\r
 619         }\r
 620       }\r
 621     },\r
 622     "FtpAddr" : {\r
 623       "type" : "object",\r
 624       "properties" : {\r
 625         "ftptype" : {\r
 626           "type" : "string"\r
 627         },\r
 628         "ip" : {\r
 629           "type" : "string"\r
 630         },\r
 631         "port" : {\r
 632           "type" : "string"\r
 633         },\r
 634         "user" : {\r
 635           "type" : "string"\r
 636         },\r
 637         "password" : {\r
 638           "type" : "string"\r
 639         },\r
 640         "remotepath" : {\r
 641           "type" : "string"\r
 642         },\r
 643         "passive" : {\r
 644           "type" : "boolean",\r
 645           "default" : false\r
 646         }\r
 647       }\r
 648     },\r
 649     "ThirdpartySdncRegisterInfo" : {\r
 650       "type" : "object",\r
 651       "properties" : {\r
 652         "thirdpartySdncId" : {\r
 653           "type" : "string"\r
 654         },\r
 655         "name" : {\r
 656           "type" : "string"\r
 657         },\r
 658         "vendor" : {\r
 659           "type" : "string"\r
 660         },\r
 661         "version" : {\r
 662           "type" : "string"\r
 663         },\r
 664         "type" : {\r
 665           "type" : "string"\r
 666         },\r
 667         "location" : {\r
 668           "type" : "string"\r
 669         },\r
 670         "url" : {\r
 671           "type" : "string"\r
 672         },\r
 673         "userName" : {\r
 674           "type" : "string"\r
 675         },\r
 676         "password" : {\r
 677           "type" : "string"\r
 678         },\r
 679         "productName" : {\r
 680           "type" : "string"\r
 681         },\r
 682         "protocol" : {\r
 683           "type" : "string"\r
 684         }\r
 685       }\r
 686     },\r
 687     "VnfmRegisterInfo" : {\r
 688       "type" : "object",\r
 689       "properties" : {\r
 690         "vnfmId" : {\r
 691           "type" : "string"\r
 692         },\r
 693         "name" : {\r
 694           "type" : "string"\r
 695         },\r
 696         "type" : {\r
 697           "type" : "string"\r
 698         },\r
 699         "vimId" : {\r
 700           "type" : "string"\r
 701         },\r
 702         "vendor" : {\r
 703           "type" : "string"\r
 704         },\r
 705         "version" : {\r
 706           "type" : "string"\r
 707         },\r
 708         "certificateUrl" : {\r
 709           "type" : "string"\r
 710         },\r
 711         "url" : {\r
 712           "type" : "string"\r
 713         },\r
 714         "userName" : {\r
 715           "type" : "string"\r
 716         },\r
 717         "password" : {\r
 718           "type" : "string"\r
 719         }\r
 720       }\r
 721     }\r
 722   }\r
 723 }