docs/swagger.json

   1 {
   2     "swagger": "2.0",
   3     "basePath": "/",
   4     "paths": {
   5         "/o2ims-infrastructureInventory/api_versions": {
   6             "get": {
   7                 "responses": {
   8                     "200": {
   9                         "description": "Success"
  10                     }
  11                 },
  12                 "operationId": "get_inventory_version",
  13                 "tags": [
  14                     "O2IMS_Inventory"
  15                 ]
  16             }
  17         },
  18         "/o2ims-infrastructureInventory/v1": {
  19             "parameters": [
  20                 {
  21                     "in": "query",
  22                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
  23                     "name": "exclude_default",
  24                     "type": "string"
  25                 },
  26                 {
  27                     "in": "query",
  28                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
  29                     "name": "exclude_fields",
  30                     "type": "string"
  31                 },
  32                 {
  33                     "in": "query",
  34                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
  35                     "name": "fields",
  36                     "type": "string"
  37                 },
  38                 {
  39                     "in": "query",
  40                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
  41                     "name": "all_fields",
  42                     "type": "string"
  43                 }
  44             ],
  45             "get": {
  46                 "responses": {
  47                     "404": {
  48                         "description": "oCloud not found"
  49                     },
  50                     "200": {
  51                         "description": "Success",
  52                         "schema": {
  53                             "$ref": "#/definitions/OcloudDto"
  54                         }
  55                     }
  56                 },
  57                 "operationId": "get_oclouds_list_router",
  58                 "tags": [
  59                     "O2IMS_Inventory"
  60                 ]
  61             }
  62         },
  63         "/o2ims-infrastructureInventory/v1/": {
  64             "parameters": [
  65                 {
  66                     "in": "query",
  67                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
  68                     "name": "exclude_default",
  69                     "type": "string"
  70                 },
  71                 {
  72                     "in": "query",
  73                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
  74                     "name": "exclude_fields",
  75                     "type": "string"
  76                 },
  77                 {
  78                     "in": "query",
  79                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
  80                     "name": "fields",
  81                     "type": "string"
  82                 },
  83                 {
  84                     "in": "query",
  85                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
  86                     "name": "all_fields",
  87                     "type": "string"
  88                 }
  89             ],
  90             "get": {
  91                 "responses": {
  92                     "404": {
  93                         "description": "oCloud not found"
  94                     },
  95                     "200": {
  96                         "description": "Success",
  97                         "schema": {
  98                             "$ref": "#/definitions/OcloudDto"
  99                         }
 100                     }
 101                 },
 102                 "operationId": "get_oclouds_list_router",
 103                 "tags": [
 104                     "O2IMS_Inventory"
 105                 ]
 106             }
 107         },
 108         "/o2ims-infrastructureInventory/v1/api_versions": {
 109             "get": {
 110                 "responses": {
 111                     "200": {
 112                         "description": "Success"
 113                     }
 114                 },
 115                 "operationId": "get_version_router",
 116                 "tags": [
 117                     "O2IMS_Inventory"
 118                 ]
 119             }
 120         },
 121         "/o2ims-infrastructureInventory/v1/deploymentManagers": {
 122             "parameters": [
 123                 {
 124                     "in": "query",
 125                     "description": "Filter of the query.",
 126                     "name": "filter",
 127                     "type": "string"
 128                 },
 129                 {
 130                     "in": "query",
 131                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 132                     "name": "exclude_default",
 133                     "type": "string"
 134                 },
 135                 {
 136                     "in": "query",
 137                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 138                     "name": "exclude_fields",
 139                     "type": "string"
 140                 },
 141                 {
 142                     "in": "query",
 143                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 144                     "name": "fields",
 145                     "type": "string"
 146                 },
 147                 {
 148                     "in": "query",
 149                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 150                     "name": "all_fields",
 151                     "type": "string"
 152                 },
 153                 {
 154                     "default": 1,
 155                     "in": "query",
 156                     "description": "Page number of the results to fetch. Default: 1",
 157                     "name": "nextpage_opaque_marker",
 158                     "type": "string"
 159                 }
 160             ],
 161             "get": {
 162                 "responses": {
 163                     "200": {
 164                         "description": "Success",
 165                         "schema": {
 166                             "type": "array",
 167                             "items": {
 168                                 "$ref": "#/definitions/DeploymentManagerListDto"
 169                             }
 170                         }
 171                     }
 172                 },
 173                 "operationId": "get_deployment_managers_list_router",
 174                 "tags": [
 175                     "O2IMS_Inventory"
 176                 ]
 177             }
 178         },
 179         "/o2ims-infrastructureInventory/v1/deploymentManagers/{deploymentManagerID}": {
 180             "parameters": [
 181                 {
 182                     "in": "query",
 183                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 184                     "name": "exclude_default",
 185                     "type": "string"
 186                 },
 187                 {
 188                     "in": "query",
 189                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 190                     "name": "exclude_fields",
 191                     "type": "string"
 192                 },
 193                 {
 194                     "in": "query",
 195                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 196                     "name": "fields",
 197                     "type": "string"
 198                 },
 199                 {
 200                     "in": "query",
 201                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 202                     "name": "all_fields",
 203                     "type": "string"
 204                 },
 205                 {
 206                     "in": "query",
 207                     "description": "DMS profile: value supports \"native_k8sapi\"",
 208                     "name": "profile",
 209                     "type": "string"
 210                 },
 211                 {
 212                     "in": "path",
 213                     "description": "ID of the deployment manager",
 214                     "name": "deploymentManagerID",
 215                     "required": true,
 216                     "type": "string"
 217                 }
 218             ],
 219             "get": {
 220                 "responses": {
 221                     "404": {
 222                         "description": "Deployment manager not found"
 223                     },
 224                     "200": {
 225                         "description": "Success",
 226                         "schema": {
 227                             "$ref": "#/definitions/DeploymentManagerGetDto"
 228                         }
 229                     }
 230                 },
 231                 "operationId": "Get deployment manager",
 232                 "tags": [
 233                     "O2IMS_Inventory"
 234                 ]
 235             }
 236         },
 237         "/o2ims-infrastructureInventory/v1/resourcePools": {
 238             "parameters": [
 239                 {
 240                     "in": "query",
 241                     "description": "Filter of the query.",
 242                     "name": "filter",
 243                     "type": "string"
 244                 },
 245                 {
 246                     "in": "query",
 247                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 248                     "name": "exclude_default",
 249                     "type": "string"
 250                 },
 251                 {
 252                     "in": "query",
 253                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 254                     "name": "exclude_fields",
 255                     "type": "string"
 256                 },
 257                 {
 258                     "in": "query",
 259                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 260                     "name": "fields",
 261                     "type": "string"
 262                 },
 263                 {
 264                     "in": "query",
 265                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 266                     "name": "all_fields",
 267                     "type": "string"
 268                 },
 269                 {
 270                     "default": 1,
 271                     "in": "query",
 272                     "description": "Page number of the results to fetch. Default: 1",
 273                     "name": "nextpage_opaque_marker",
 274                     "type": "string"
 275                 }
 276             ],
 277             "get": {
 278                 "responses": {
 279                     "200": {
 280                         "description": "Success",
 281                         "schema": {
 282                             "type": "array",
 283                             "items": {
 284                                 "$ref": "#/definitions/ResourcePoolGetDto"
 285                             }
 286                         }
 287                     }
 288                 },
 289                 "operationId": "get_resource_pools_list_router",
 290                 "tags": [
 291                     "O2IMS_Inventory"
 292                 ]
 293             }
 294         },
 295         "/o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}": {
 296             "parameters": [
 297                 {
 298                     "in": "query",
 299                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 300                     "name": "exclude_default",
 301                     "type": "string"
 302                 },
 303                 {
 304                     "in": "query",
 305                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 306                     "name": "exclude_fields",
 307                     "type": "string"
 308                 },
 309                 {
 310                     "in": "query",
 311                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 312                     "name": "fields",
 313                     "type": "string"
 314                 },
 315                 {
 316                     "in": "query",
 317                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 318                     "name": "all_fields",
 319                     "type": "string"
 320                 },
 321                 {
 322                     "in": "path",
 323                     "description": "ID of the resource pool",
 324                     "name": "resourcePoolID",
 325                     "required": true,
 326                     "type": "string"
 327                 }
 328             ],
 329             "get": {
 330                 "responses": {
 331                     "404": {
 332                         "description": "Resource pool not found"
 333                     },
 334                     "200": {
 335                         "description": "Success",
 336                         "schema": {
 337                             "$ref": "#/definitions/ResourcePoolGetDto"
 338                         }
 339                     }
 340                 },
 341                 "operationId": "Get resource pool",
 342                 "tags": [
 343                     "O2IMS_Inventory"
 344                 ]
 345             }
 346         },
 347         "/o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources": {
 348             "parameters": [
 349                 {
 350                     "in": "query",
 351                     "description": "Filter of the query.",
 352                     "name": "filter",
 353                     "type": "string"
 354                 },
 355                 {
 356                     "in": "query",
 357                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 358                     "name": "exclude_default",
 359                     "type": "string"
 360                 },
 361                 {
 362                     "in": "query",
 363                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 364                     "name": "exclude_fields",
 365                     "type": "string"
 366                 },
 367                 {
 368                     "in": "query",
 369                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 370                     "name": "fields",
 371                     "type": "string"
 372                 },
 373                 {
 374                     "in": "query",
 375                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 376                     "name": "all_fields",
 377                     "type": "string"
 378                 },
 379                 {
 380                     "default": 1,
 381                     "in": "query",
 382                     "description": "Page number of the results to fetch. Default: 1",
 383                     "name": "nextpage_opaque_marker",
 384                     "type": "string"
 385                 },
 386                 {
 387                     "in": "path",
 388                     "description": "ID of the resource pool",
 389                     "name": "resourcePoolID",
 390                     "required": true,
 391                     "type": "string"
 392                 }
 393             ],
 394             "get": {
 395                 "responses": {
 396                     "404": {
 397                         "description": "Resource pool not found"
 398                     },
 399                     "200": {
 400                         "description": "Success",
 401                         "schema": {
 402                             "type": "array",
 403                             "items": {
 404                                 "$ref": "#/definitions/ResourceListDto"
 405                             }
 406                         }
 407                     }
 408                 },
 409                 "operationId": "get_resources_list_router",
 410                 "tags": [
 411                     "O2IMS_Inventory"
 412                 ]
 413             }
 414         },
 415         "/o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}": {
 416             "parameters": [
 417                 {
 418                     "in": "query",
 419                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 420                     "name": "exclude_default",
 421                     "type": "string"
 422                 },
 423                 {
 424                     "in": "query",
 425                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 426                     "name": "exclude_fields",
 427                     "type": "string"
 428                 },
 429                 {
 430                     "in": "query",
 431                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 432                     "name": "fields",
 433                     "type": "string"
 434                 },
 435                 {
 436                     "in": "query",
 437                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 438                     "name": "all_fields",
 439                     "type": "string"
 440                 },
 441                 {
 442                     "in": "path",
 443                     "description": "ID of the resource",
 444                     "name": "resourceID",
 445                     "required": true,
 446                     "type": "string"
 447                 },
 448                 {
 449                     "in": "path",
 450                     "description": "ID of the resource pool",
 451                     "name": "resourcePoolID",
 452                     "required": true,
 453                     "type": "string"
 454                 }
 455             ],
 456             "get": {
 457                 "responses": {
 458                     "404": {
 459                         "description": "Resource not found"
 460                     },
 461                     "200": {
 462                         "description": "Success",
 463                         "schema": {
 464                             "$ref": "#/definitions/ResourceGetDto2"
 465                         }
 466                     }
 467                 },
 468                 "operationId": "Get resource",
 469                 "tags": [
 470                     "O2IMS_Inventory"
 471                 ]
 472             }
 473         },
 474         "/o2ims-infrastructureInventory/v1/resourceTypes": {
 475             "parameters": [
 476                 {
 477                     "in": "query",
 478                     "description": "Filter of the query.",
 479                     "name": "filter",
 480                     "type": "string"
 481                 },
 482                 {
 483                     "in": "query",
 484                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 485                     "name": "exclude_default",
 486                     "type": "string"
 487                 },
 488                 {
 489                     "in": "query",
 490                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 491                     "name": "exclude_fields",
 492                     "type": "string"
 493                 },
 494                 {
 495                     "in": "query",
 496                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 497                     "name": "fields",
 498                     "type": "string"
 499                 },
 500                 {
 501                     "in": "query",
 502                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 503                     "name": "all_fields",
 504                     "type": "string"
 505                 },
 506                 {
 507                     "default": 1,
 508                     "in": "query",
 509                     "description": "Page number of the results to fetch. Default: 1",
 510                     "name": "nextpage_opaque_marker",
 511                     "type": "string"
 512                 }
 513             ],
 514             "get": {
 515                 "responses": {
 516                     "200": {
 517                         "description": "Success",
 518                         "schema": {
 519                             "type": "array",
 520                             "items": {
 521                                 "$ref": "#/definitions/ResourceTypeGetDto"
 522                             }
 523                         }
 524                     }
 525                 },
 526                 "operationId": "get_resource_types_list_router",
 527                 "tags": [
 528                     "O2IMS_Inventory"
 529                 ]
 530             }
 531         },
 532         "/o2ims-infrastructureInventory/v1/resourceTypes/{resourceTypeID}": {
 533             "parameters": [
 534                 {
 535                     "in": "query",
 536                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 537                     "name": "exclude_default",
 538                     "type": "string"
 539                 },
 540                 {
 541                     "in": "query",
 542                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 543                     "name": "exclude_fields",
 544                     "type": "string"
 545                 },
 546                 {
 547                     "in": "query",
 548                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 549                     "name": "fields",
 550                     "type": "string"
 551                 },
 552                 {
 553                     "in": "query",
 554                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 555                     "name": "all_fields",
 556                     "type": "string"
 557                 },
 558                 {
 559                     "in": "path",
 560                     "description": "ID of the resource type",
 561                     "name": "resourceTypeID",
 562                     "required": true,
 563                     "type": "string"
 564                 }
 565             ],
 566             "get": {
 567                 "responses": {
 568                     "404": {
 569                         "description": "Resource type not found"
 570                     },
 571                     "200": {
 572                         "description": "Success",
 573                         "schema": {
 574                             "$ref": "#/definitions/ResourceTypeGetDto"
 575                         }
 576                     }
 577                 },
 578                 "operationId": "Get resource type",
 579                 "tags": [
 580                     "O2IMS_Inventory"
 581                 ]
 582             }
 583         },
 584         "/o2ims-infrastructureInventory/v1/subscriptions": {
 585             "get": {
 586                 "responses": {
 587                     "200": {
 588                         "description": "Success",
 589                         "schema": {
 590                             "type": "array",
 591                             "items": {
 592                                 "$ref": "#/definitions/SubscriptionGetDto"
 593                             }
 594                         }
 595                     }
 596                 },
 597                 "operationId": "List subscriptions",
 598                 "parameters": [
 599                     {
 600                         "in": "query",
 601                         "description": "Filter of the query.",
 602                         "name": "filter",
 603                         "type": "string"
 604                     },
 605                     {
 606                         "in": "query",
 607                         "description": "Exclude showing all default fields, Set \"true\" to enable.",
 608                         "name": "exclude_default",
 609                         "type": "string"
 610                     },
 611                     {
 612                         "in": "query",
 613                         "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 614                         "name": "exclude_fields",
 615                         "type": "string"
 616                     },
 617                     {
 618                         "in": "query",
 619                         "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 620                         "name": "fields",
 621                         "type": "string"
 622                     },
 623                     {
 624                         "in": "query",
 625                         "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 626                         "name": "all_fields",
 627                         "type": "string"
 628                     },
 629                     {
 630                         "default": 1,
 631                         "in": "query",
 632                         "description": "Page number of the results to fetch. Default: 1",
 633                         "name": "nextpage_opaque_marker",
 634                         "type": "string"
 635                     }
 636                 ],
 637                 "tags": [
 638                     "O2IMS_Inventory"
 639                 ]
 640             },
 641             "post": {
 642                 "responses": {
 643                     "201": {
 644                         "description": "Success",
 645                         "schema": {
 646                             "$ref": "#/definitions/SubscriptionGetDto"
 647                         }
 648                     }
 649                 },
 650                 "operationId": "Create a subscription",
 651                 "parameters": [
 652                     {
 653                         "name": "payload",
 654                         "required": true,
 655                         "in": "body",
 656                         "schema": {
 657                             "$ref": "#/definitions/SubscriptionCreateDto"
 658                         }
 659                     }
 660                 ],
 661                 "tags": [
 662                     "O2IMS_Inventory"
 663                 ]
 664             }
 665         },
 666         "/o2ims-infrastructureInventory/v1/subscriptions/{subscriptionID}": {
 667             "parameters": [
 668                 {
 669                     "in": "path",
 670                     "description": "ID of the subscription",
 671                     "name": "subscriptionID",
 672                     "required": true,
 673                     "type": "string"
 674                 }
 675             ],
 676             "get": {
 677                 "responses": {
 678                     "404": {
 679                         "description": "Subscription not found"
 680                     },
 681                     "200": {
 682                         "description": "Success",
 683                         "schema": {
 684                             "$ref": "#/definitions/SubscriptionGetDto"
 685                         }
 686                     }
 687                 },
 688                 "operationId": "Get subscription by ID",
 689                 "parameters": [
 690                     {
 691                         "in": "query",
 692                         "description": "Exclude showing all default fields, Set \"true\" to enable.",
 693                         "name": "exclude_default",
 694                         "type": "string"
 695                     },
 696                     {
 697                         "in": "query",
 698                         "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 699                         "name": "exclude_fields",
 700                         "type": "string"
 701                     },
 702                     {
 703                         "in": "query",
 704                         "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 705                         "name": "fields",
 706                         "type": "string"
 707                     },
 708                     {
 709                         "in": "query",
 710                         "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 711                         "name": "all_fields",
 712                         "type": "string"
 713                     }
 714                 ],
 715                 "tags": [
 716                     "O2IMS_Inventory"
 717                 ]
 718             },
 719             "delete": {
 720                 "responses": {
 721                     "404": {
 722                         "description": "Subscription not found"
 723                     },
 724                     "200": {
 725                         "description": "Subscription deleted"
 726                     }
 727                 },
 728                 "operationId": "Delete subscription by ID",
 729                 "tags": [
 730                     "O2IMS_Inventory"
 731                 ]
 732             }
 733         },
 734         "/o2ims-infrastructureMonitoring/api_versions": {
 735             "get": {
 736                 "responses": {
 737                     "200": {
 738                         "description": "Success"
 739                     }
 740                 },
 741                 "operationId": "get_monitoring_version",
 742                 "tags": [
 743                     "O2IMS_InfrastructureMonitoring"
 744                 ]
 745             }
 746         },
 747         "/o2ims-infrastructureMonitoring/v1/alarmSubscriptions": {
 748             "get": {
 749                 "responses": {
 750                     "200": {
 751                         "description": "Success",
 752                         "schema": {
 753                             "type": "array",
 754                             "items": {
 755                                 "$ref": "#/definitions/AlarmSubscriptionGetDto"
 756                             }
 757                         }
 758                     }
 759                 },
 760                 "operationId": "List alarm subscriptions",
 761                 "parameters": [
 762                     {
 763                         "in": "query",
 764                         "description": "Filter of the query.",
 765                         "name": "filter",
 766                         "type": "string"
 767                     },
 768                     {
 769                         "in": "query",
 770                         "description": "Exclude showing all default fields, Set \"true\" to enable.",
 771                         "name": "exclude_default",
 772                         "type": "string"
 773                     },
 774                     {
 775                         "in": "query",
 776                         "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 777                         "name": "exclude_fields",
 778                         "type": "string"
 779                     },
 780                     {
 781                         "in": "query",
 782                         "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 783                         "name": "fields",
 784                         "type": "string"
 785                     },
 786                     {
 787                         "in": "query",
 788                         "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 789                         "name": "all_fields",
 790                         "type": "string"
 791                     },
 792                     {
 793                         "default": 1,
 794                         "in": "query",
 795                         "description": "Page number of the results to fetch. Default: 1",
 796                         "name": "nextpage_opaque_marker",
 797                         "type": "string"
 798                     }
 799                 ],
 800                 "tags": [
 801                     "O2IMS_InfrastructureMonitoring"
 802                 ]
 803             },
 804             "post": {
 805                 "responses": {
 806                     "201": {
 807                         "description": "Success",
 808                         "schema": {
 809                             "$ref": "#/definitions/AlarmSubscriptionGetDto"
 810                         }
 811                     }
 812                 },
 813                 "operationId": "Create a alarm subscription",
 814                 "parameters": [
 815                     {
 816                         "name": "payload",
 817                         "required": true,
 818                         "in": "body",
 819                         "schema": {
 820                             "$ref": "#/definitions/AlarmSubscriptionCreateDto"
 821                         }
 822                     }
 823                 ],
 824                 "tags": [
 825                     "O2IMS_InfrastructureMonitoring"
 826                 ]
 827             }
 828         },
 829         "/o2ims-infrastructureMonitoring/v1/alarmSubscriptions/{alarmSubscriptionID}": {
 830             "parameters": [
 831                 {
 832                     "in": "path",
 833                     "description": "ID of the Alarm Subscription",
 834                     "name": "alarmSubscriptionID",
 835                     "required": true,
 836                     "type": "string"
 837                 }
 838             ],
 839             "get": {
 840                 "responses": {
 841                     "404": {
 842                         "description": "Alarm Subscription not found"
 843                     },
 844                     "200": {
 845                         "description": "Success",
 846                         "schema": {
 847                             "$ref": "#/definitions/AlarmSubscriptionGetDto"
 848                         }
 849                     }
 850                 },
 851                 "operationId": "Get Alarm Subscription by ID",
 852                 "parameters": [
 853                     {
 854                         "in": "query",
 855                         "description": "Exclude showing all default fields, Set \"true\" to enable.",
 856                         "name": "exclude_default",
 857                         "type": "string"
 858                     },
 859                     {
 860                         "in": "query",
 861                         "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 862                         "name": "exclude_fields",
 863                         "type": "string"
 864                     },
 865                     {
 866                         "in": "query",
 867                         "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 868                         "name": "fields",
 869                         "type": "string"
 870                     },
 871                     {
 872                         "in": "query",
 873                         "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 874                         "name": "all_fields",
 875                         "type": "string"
 876                     }
 877                 ],
 878                 "tags": [
 879                     "O2IMS_InfrastructureMonitoring"
 880                 ]
 881             },
 882             "delete": {
 883                 "responses": {
 884                     "404": {
 885                         "description": "Alarm Subscription not found"
 886                     },
 887                     "200": {
 888                         "description": "Subscription deleted"
 889                     }
 890                 },
 891                 "operationId": "Delete subscription by ID",
 892                 "tags": [
 893                     "O2IMS_InfrastructureMonitoring"
 894                 ]
 895             }
 896         },
 897         "/o2ims-infrastructureMonitoring/v1/alarms": {
 898             "parameters": [
 899                 {
 900                     "in": "query",
 901                     "description": "Filter of the query.",
 902                     "name": "filter",
 903                     "type": "string"
 904                 },
 905                 {
 906                     "in": "query",
 907                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 908                     "name": "exclude_default",
 909                     "type": "string"
 910                 },
 911                 {
 912                     "in": "query",
 913                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 914                     "name": "exclude_fields",
 915                     "type": "string"
 916                 },
 917                 {
 918                     "in": "query",
 919                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 920                     "name": "fields",
 921                     "type": "string"
 922                 },
 923                 {
 924                     "in": "query",
 925                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 926                     "name": "all_fields",
 927                     "type": "string"
 928                 },
 929                 {
 930                     "default": 1,
 931                     "in": "query",
 932                     "description": "Page number of the results to fetch. Default: 1",
 933                     "name": "nextpage_opaque_marker",
 934                     "type": "string"
 935                 }
 936             ],
 937             "get": {
 938                 "responses": {
 939                     "200": {
 940                         "description": "Success",
 941                         "schema": {
 942                             "type": "array",
 943                             "items": {
 944                                 "$ref": "#/definitions/AlarmGetDto"
 945                             }
 946                         }
 947                     }
 948                 },
 949                 "operationId": "get_alarm_list_router",
 950                 "tags": [
 951                     "O2IMS_InfrastructureMonitoring"
 952                 ]
 953             }
 954         },
 955         "/o2ims-infrastructureMonitoring/v1/alarms/{alarmEventRecordId}": {
 956             "parameters": [
 957                 {
 958                     "in": "query",
 959                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 960                     "name": "exclude_default",
 961                     "type": "string"
 962                 },
 963                 {
 964                     "in": "query",
 965                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 966                     "name": "exclude_fields",
 967                     "type": "string"
 968                 },
 969                 {
 970                     "in": "query",
 971                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 972                     "name": "fields",
 973                     "type": "string"
 974                 },
 975                 {
 976                     "in": "query",
 977                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 978                     "name": "all_fields",
 979                     "type": "string"
 980                 },
 981                 {
 982                     "in": "path",
 983                     "description": "ID of the alarm event record",
 984                     "name": "alarmEventRecordId",
 985                     "required": true,
 986                     "type": "string"
 987                 }
 988             ],
 989             "get": {
 990                 "responses": {
 991                     "404": {
 992                         "description": "Alarm Event Record not found"
 993                     },
 994                     "200": {
 995                         "description": "Success",
 996                         "schema": {
 997                             "$ref": "#/definitions/AlarmGetDto"
 998                         }
 999                     }
1000                 },
1001                 "operationId": "Get AlarmEventRecord",
1002                 "tags": [
1003                     "O2IMS_InfrastructureMonitoring"
1004                 ]
1005             }
1006         },
1007         "/o2ims-infrastructureMonitoring/v1/api_versions": {
1008             "get": {
1009                 "responses": {
1010                     "200": {
1011                         "description": "Success"
1012                     }
1013                 },
1014                 "operationId": "get_version_router",
1015                 "tags": [
1016                     "O2IMS_InfrastructureMonitoring"
1017                 ]
1018             }
1019         }
1020     },
1021     "info": {
1022         "title": "INF O2 Services API",
1023         "version": "1.0.0",
1024         "description": "Swagger OpenAPI document for the INF O2 Services"
1025     },
1026     "produces": [
1027         "application/json"
1028     ],
1029     "consumes": [
1030         "application/json"
1031     ],
1032     "tags": [
1033         {
1034             "name": "O2IMS_Inventory",
1035             "description": "IMS Inventory related operations."
1036         },
1037         {
1038             "name": "O2IMS_InfrastructureMonitoring",
1039             "description": "O2 IMS Monitoring related operations."
1040         }
1041     ],
1042     "definitions": {
1043         "OcloudDto": {
1044             "required": [
1045                 "oCloudId"
1046             ],
1047             "properties": {
1048                 "oCloudId": {
1049                     "type": "string"
1050                 },
1051                 "globalCloudId": {
1052                     "type": "string"
1053                 },
1054                 "globalcloudId": {
1055                     "type": "string"
1056                 },
1057                 "name": {
1058                     "type": "string"
1059                 },
1060                 "description": {
1061                     "type": "string"
1062                 },
1063                 "serviceUri": {
1064                     "type": "string"
1065                 },
1066                 "extensions": {
1067                     "type": "string"
1068                 }
1069             },
1070             "x-mask": "{oCloudId,globalCloudId,globalcloudId,name,description,serviceUri}",
1071             "type": "object"
1072         },
1073         "ResourceTypeGetDto": {
1074             "required": [
1075                 "resourceTypeId"
1076             ],
1077             "properties": {
1078                 "resourceTypeId": {
1079                     "type": "string",
1080                     "description": "Resource type ID"
1081                 },
1082                 "name": {
1083                     "type": "string"
1084                 },
1085                 "description": {
1086                     "type": "string"
1087                 },
1088                 "vendor": {
1089                     "type": "string"
1090                 },
1091                 "model": {
1092                     "type": "string"
1093                 },
1094                 "version": {
1095                     "type": "string"
1096                 },
1097                 "alarmDictionary": {
1098                     "$ref": "#/definitions/AlarmDictionaryDto"
1099                 },
1100                 "extensions": {
1101                     "type": "string"
1102                 }
1103             },
1104             "x-mask": "{resourceTypeId,name,description,model,vendor,version}",
1105             "type": "object"
1106         },
1107         "AlarmDictionaryDto": {
1108             "properties": {
1109                 "id": {
1110                     "type": "string"
1111                 },
1112                 "alarmDictionaryVersion": {
1113                     "type": "string"
1114                 },
1115                 "alarmDictionarySchemaVersion": {
1116                     "type": "string"
1117                 },
1118                 "entityType": {
1119                     "type": "string"
1120                 },
1121                 "vendor": {
1122                     "type": "string"
1123                 },
1124                 "managementInterfaceId": {
1125                     "type": "string"
1126                 },
1127                 "pkNotificationField": {
1128                     "type": "string"
1129                 },
1130                 "alarmDefinition": {
1131                     "type": "array",
1132                     "items": {
1133                         "$ref": "#/definitions/AlarmDefinitionDto"
1134                     }
1135                 }
1136             },
1137             "type": "object"
1138         },
1139         "AlarmDefinitionDto": {
1140             "properties": {
1141                 "alarmDefinitionId": {
1142                     "type": "string"
1143                 },
1144                 "alarmName": {
1145                     "type": "string"
1146                 },
1147                 "alarmLastChange": {
1148                     "type": "string"
1149                 },
1150                 "alarmChangeType": {
1151                     "type": "string"
1152                 },
1153                 "alarmDescription": {
1154                     "type": "string"
1155                 },
1156                 "proposedRepairActions": {
1157                     "type": "string"
1158                 },
1159                 "clearingType": {
1160                     "type": "string"
1161                 },
1162                 "managementInterfaceId": {
1163                     "type": "string"
1164                 },
1165                 "pkNotificationField": {
1166                     "type": "string"
1167                 },
1168                 "alarmAdditionalFields": {
1169                     "type": "string"
1170                 }
1171             },
1172             "type": "object"
1173         },
1174         "ResourcePoolGetDto": {
1175             "required": [
1176                 "resourcePoolId"
1177             ],
1178             "properties": {
1179                 "resourcePoolId": {
1180                     "type": "string",
1181                     "description": "Resource pool ID"
1182                 },
1183                 "globalLocationId": {
1184                     "type": "string"
1185                 },
1186                 "name": {
1187                     "type": "string"
1188                 },
1189                 "description": {
1190                     "type": "string"
1191                 },
1192                 "oCloudId": {
1193                     "type": "string"
1194                 },
1195                 "location": {
1196                     "type": "string"
1197                 },
1198                 "extensions": {
1199                     "type": "string"
1200                 }
1201             },
1202             "x-mask": "{resourcePoolId,oCloudId,globalLocationId,name,description}",
1203             "type": "object"
1204         },
1205         "ResourceListDto": {
1206             "required": [
1207                 "resourceId"
1208             ],
1209             "properties": {
1210                 "resourceId": {
1211                     "type": "string",
1212                     "description": "Resource ID"
1213                 },
1214                 "resourceTypeId": {
1215                     "type": "string"
1216                 },
1217                 "resourcePoolId": {
1218                     "type": "string"
1219                 },
1220                 "globalAssetId": {
1221                     "type": "string"
1222                 },
1223                 "parentId": {
1224                     "type": "string"
1225                 },
1226                 "description": {
1227                     "type": "string"
1228                 },
1229                 "extensions": {
1230                     "type": "object"
1231                 }
1232             },
1233             "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1234             "type": "object"
1235         },
1236         "ResourceGetDto2": {
1237             "required": [
1238                 "resourceId"
1239             ],
1240             "properties": {
1241                 "resourceId": {
1242                     "type": "string",
1243                     "description": "Resource ID"
1244                 },
1245                 "resourceTypeId": {
1246                     "type": "string"
1247                 },
1248                 "resourcePoolId": {
1249                     "type": "string"
1250                 },
1251                 "globalAssetId": {
1252                     "type": "string"
1253                 },
1254                 "parentId": {
1255                     "type": "string"
1256                 },
1257                 "description": {
1258                     "type": "string"
1259                 },
1260                 "extensions": {
1261                     "type": "object"
1262                 },
1263                 "elements": {
1264                     "type": "array",
1265                     "items": {
1266                         "$ref": "#/definitions/ResourceGetDto1"
1267                     }
1268                 }
1269             },
1270             "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1271             "type": "object"
1272         },
1273         "ResourceGetDto1": {
1274             "required": [
1275                 "resourceId"
1276             ],
1277             "properties": {
1278                 "resourceId": {
1279                     "type": "string",
1280                     "description": "Resource ID"
1281                 },
1282                 "resourceTypeId": {
1283                     "type": "string"
1284                 },
1285                 "resourcePoolId": {
1286                     "type": "string"
1287                 },
1288                 "globalAssetId": {
1289                     "type": "string"
1290                 },
1291                 "parentId": {
1292                     "type": "string"
1293                 },
1294                 "description": {
1295                     "type": "string"
1296                 },
1297                 "extensions": {
1298                     "type": "object"
1299                 },
1300                 "elements": {
1301                     "type": "array",
1302                     "items": {
1303                         "$ref": "#/definitions/ResourceGetDto0"
1304                     }
1305                 }
1306             },
1307             "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1308             "type": "object"
1309         },
1310         "ResourceGetDto0": {
1311             "required": [
1312                 "resourceId"
1313             ],
1314             "properties": {
1315                 "resourceId": {
1316                     "type": "string",
1317                     "description": "Resource ID"
1318                 },
1319                 "resourceTypeId": {
1320                     "type": "string"
1321                 },
1322                 "resourcePoolId": {
1323                     "type": "string"
1324                 },
1325                 "globalAssetId": {
1326                     "type": "string"
1327                 },
1328                 "parentId": {
1329                     "type": "string"
1330                 },
1331                 "description": {
1332                     "type": "string"
1333                 },
1334                 "extensions": {
1335                     "type": "object"
1336                 }
1337             },
1338             "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1339             "type": "object"
1340         },
1341         "DeploymentManagerListDto": {
1342             "required": [
1343                 "deploymentManagerId"
1344             ],
1345             "properties": {
1346                 "deploymentManagerId": {
1347                     "type": "string",
1348                     "description": "Deployment manager ID"
1349                 },
1350                 "name": {
1351                     "type": "string"
1352                 },
1353                 "description": {
1354                     "type": "string"
1355                 },
1356                 "oCloudId": {
1357                     "type": "string"
1358                 },
1359                 "serviceUri": {
1360                     "type": "string"
1361                 },
1362                 "profileSupportList": {
1363                     "type": "array",
1364                     "description": "Profile support list, use default for the return                      endpoint",
1365                     "items": {
1366                         "type": "string"
1367                     }
1368                 },
1369                 "extensions": {
1370                     "type": "string"
1371                 }
1372             },
1373             "x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,profileSupportList}",
1374             "type": "object"
1375         },
1376         "DeploymentManagerGetDto": {
1377             "required": [
1378                 "deploymentManagerId"
1379             ],
1380             "properties": {
1381                 "deploymentManagerId": {
1382                     "type": "string",
1383                     "description": "Deployment manager ID"
1384                 },
1385                 "name": {
1386                     "type": "string"
1387                 },
1388                 "description": {
1389                     "type": "string"
1390                 },
1391                 "oCloudId": {
1392                     "type": "string"
1393                 },
1394                 "serviceUri": {
1395                     "type": "string"
1396                 },
1397                 "extensions": {
1398                     "$ref": "#/definitions/DeploymentManagerExtensions"
1399                 }
1400             },
1401             "x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,extensions,profileName,profileData}",
1402             "type": "object"
1403         },
1404         "DeploymentManagerExtensions": {
1405             "properties": {
1406                 "profileName": {
1407                     "type": "string"
1408                 },
1409                 "profileData": {
1410                     "$ref": "#/definitions/DeploymentManagerGetDtoProfile"
1411                 }
1412             },
1413             "type": "object"
1414         },
1415         "DeploymentManagerGetDtoProfile": {
1416             "properties": {
1417                 "cluster_api_endpoint": {
1418                     "type": "string"
1419                 },
1420                 "cluster_ca_cert": {
1421                     "type": "string"
1422                 },
1423                 "admin_user": {
1424                     "type": "string"
1425                 },
1426                 "admin_client_cert": {
1427                     "type": "string"
1428                 },
1429                 "admin_client_key": {
1430                     "type": "string"
1431                 },
1432                 "helmcli_host_with_port": {
1433                     "type": "string"
1434                 },
1435                 "helmcli_username": {
1436                     "type": "string"
1437                 },
1438                 "helmcli_password": {
1439                     "type": "string"
1440                 },
1441                 "helmcli_kubeconfig": {
1442                     "type": "string"
1443                 }
1444             },
1445             "type": "object"
1446         },
1447         "SubscriptionCreateDto": {
1448             "required": [
1449                 "callback"
1450             ],
1451             "properties": {
1452                 "callback": {
1453                     "type": "string",
1454                     "description": "Subscription callback address"
1455                 },
1456                 "consumerSubscriptionId": {
1457                     "type": "string"
1458                 },
1459                 "filter": {
1460                     "type": "string"
1461                 }
1462             },
1463             "type": "object"
1464         },
1465         "SubscriptionGetDto": {
1466             "required": [
1467                 "subscriptionId"
1468             ],
1469             "properties": {
1470                 "subscriptionId": {
1471                     "type": "string",
1472                     "description": "Subscription ID"
1473                 },
1474                 "callback": {
1475                     "type": "string"
1476                 },
1477                 "consumerSubscriptionId": {
1478                     "type": "string"
1479                 },
1480                 "filter": {
1481                     "type": "string"
1482                 }
1483             },
1484             "x-mask": "{subscriptionId,callback}",
1485             "type": "object"
1486         },
1487         "AlarmGetDto": {
1488             "required": [
1489                 "alarmEventRecordId"
1490             ],
1491             "properties": {
1492                 "alarmEventRecordId": {
1493                     "type": "string",
1494                     "description": "Alarm Event Record ID"
1495                 },
1496                 "resourceTypeId": {
1497                     "type": "string"
1498                 },
1499                 "resourceTypeID": {
1500                     "type": "string"
1501                 },
1502                 "resourceId": {
1503                     "type": "string"
1504                 },
1505                 "resourceID": {
1506                     "type": "string"
1507                 },
1508                 "alarmDefinitionId": {
1509                     "type": "string"
1510                 },
1511                 "alarmDefinitionID": {
1512                     "type": "string"
1513                 },
1514                 "probableCauseId": {
1515                     "type": "string"
1516                 },
1517                 "probableCauseID": {
1518                     "type": "string"
1519                 },
1520                 "alarmRaisedTime": {
1521                     "type": "string"
1522                 },
1523                 "alarmChangedTime": {
1524                     "type": "string"
1525                 },
1526                 "alarmAcknowledgeTime": {
1527                     "type": "string"
1528                 },
1529                 "alarmAcknowledged": {
1530                     "type": "boolean"
1531                 },
1532                 "perceivedSeverity": {
1533                     "type": "string"
1534                 },
1535                 "extensions": {
1536                     "type": "object"
1537                 }
1538             },
1539             "type": "object"
1540         },
1541         "AlarmSubscriptionCreateDto": {
1542             "required": [
1543                 "callback"
1544             ],
1545             "properties": {
1546                 "callback": {
1547                     "type": "string",
1548                     "description": "Alarm Subscription callback address"
1549                 },
1550                 "consumerSubscriptionId": {
1551                     "type": "string"
1552                 },
1553                 "filter": {
1554                     "type": "string"
1555                 }
1556             },
1557             "type": "object"
1558         },
1559         "AlarmSubscriptionGetDto": {
1560             "required": [
1561                 "alarmSubscriptionId"
1562             ],
1563             "properties": {
1564                 "alarmSubscriptionId": {
1565                     "type": "string",
1566                     "description": "Alarm Subscription ID"
1567                 },
1568                 "callback": {
1569                     "type": "string"
1570                 },
1571                 "consumerSubscriptionId": {
1572                     "type": "string"
1573                 },
1574                 "filter": {
1575                     "type": "string"
1576                 }
1577             },
1578             "x-mask": "{alarmSubscriptionId,callback}",
1579             "type": "object"
1580         }
1581     },
1582     "responses": {
1583         "ParseError": {
1584             "description": "When a mask can't be parsed"
1585         },
1586         "MaskError": {
1587             "description": "When any error occurs on mask"
1588         },
1589         "HTTPException": {
1590             "description": "Default error handler"
1591         },
1592         "NotFound": {
1593             "description": "notfound handler"
1594         },
1595         "BadRequestException": {
1596             "description": "Return a custom message and 400 status code"
1597         },
1598         "NotFoundException": {
1599             "description": "Return a custom message and 404 status code"
1600         },
1601         "MethodNotAllowed": {
1602             "description": "Return a custom message and 405 status code"
1603         },
1604         "InternalServerError": {
1605             "description": "Return a custom message and 500 status code"
1606         },
1607         "Exception": {
1608             "description": "Return a custom message and 500 status code"
1609         }
1610     }
1611 }