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                         "schema": {
  11                             "$ref": "#/definitions/InventoryAPIVersion"
  12                         }
  13                     }
  14                 },
  15                 "operationId": "Get Inventory Version",
  16                 "tags": [
  17                     "O2IMS-InfrastructureInventory"
  18                 ]
  19             }
  20         },
  21         "/o2ims-infrastructureInventory/v1": {
  22             "parameters": [
  23                 {
  24                     "in": "query",
  25                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
  26                     "name": "exclude_default",
  27                     "type": "string"
  28                 },
  29                 {
  30                     "in": "query",
  31                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
  32                     "name": "exclude_fields",
  33                     "type": "string"
  34                 },
  35                 {
  36                     "in": "query",
  37                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
  38                     "name": "fields",
  39                     "type": "string"
  40                 },
  41                 {
  42                     "in": "query",
  43                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
  44                     "name": "all_fields",
  45                     "type": "string"
  46                 }
  47             ],
  48             "get": {
  49                 "responses": {
  50                     "200": {
  51                         "description": "Success",
  52                         "schema": {
  53                             "$ref": "#/definitions/OcloudDto"
  54                         }
  55                     },
  56                     "404": {
  57                         "description": "oCloud not found"
  58                     }
  59                 },
  60                 "operationId": "Get Ocloud Information",
  61                 "tags": [
  62                     "O2IMS-InfrastructureInventory"
  63                 ]
  64             }
  65         },
  66         "/o2ims-infrastructureInventory/v1/": {
  67             "parameters": [
  68                 {
  69                     "in": "query",
  70                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
  71                     "name": "exclude_default",
  72                     "type": "string"
  73                 },
  74                 {
  75                     "in": "query",
  76                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
  77                     "name": "exclude_fields",
  78                     "type": "string"
  79                 },
  80                 {
  81                     "in": "query",
  82                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
  83                     "name": "fields",
  84                     "type": "string"
  85                 },
  86                 {
  87                     "in": "query",
  88                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
  89                     "name": "all_fields",
  90                     "type": "string"
  91                 }
  92             ],
  93             "get": {
  94                 "responses": {
  95                     "200": {
  96                         "description": "Success",
  97                         "schema": {
  98                             "$ref": "#/definitions/OcloudDto"
  99                         }
 100                     },
 101                     "404": {
 102                         "description": "oCloud not found"
 103                     }
 104                 },
 105                 "operationId": "Get Ocloud Information",
 106                 "tags": [
 107                     "O2IMS-InfrastructureInventory"
 108                 ]
 109             }
 110         },
 111         "/o2ims-infrastructureInventory/v1/api_versions": {
 112             "get": {
 113                 "responses": {
 114                     "200": {
 115                         "description": "Success",
 116                         "schema": {
 117                             "$ref": "#/definitions/InventoryV1APIVersion"
 118                         }
 119                     }
 120                 },
 121                 "operationId": "Get Inventory API version",
 122                 "tags": [
 123                     "O2IMS-InfrastructureInventory"
 124                 ]
 125             }
 126         },
 127         "/o2ims-infrastructureInventory/v1/deploymentManagers": {
 128             "parameters": [
 129                 {
 130                     "in": "query",
 131                     "description": "Filter of the query.",
 132                     "name": "filter",
 133                     "type": "string"
 134                 },
 135                 {
 136                     "in": "query",
 137                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 138                     "name": "exclude_default",
 139                     "type": "string"
 140                 },
 141                 {
 142                     "in": "query",
 143                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 144                     "name": "exclude_fields",
 145                     "type": "string"
 146                 },
 147                 {
 148                     "in": "query",
 149                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 150                     "name": "fields",
 151                     "type": "string"
 152                 },
 153                 {
 154                     "in": "query",
 155                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 156                     "name": "all_fields",
 157                     "type": "string"
 158                 },
 159                 {
 160                     "default": 1,
 161                     "in": "query",
 162                     "description": "Page number of the results to fetch. Default: 1",
 163                     "name": "nextpage_opaque_marker",
 164                     "type": "string"
 165                 }
 166             ],
 167             "get": {
 168                 "responses": {
 169                     "200": {
 170                         "description": "Success",
 171                         "schema": {
 172                             "type": "array",
 173                             "items": {
 174                                 "$ref": "#/definitions/DeploymentManagerListDto"
 175                             }
 176                         }
 177                     }
 178                 },
 179                 "operationId": "Get Deployment Manager List",
 180                 "tags": [
 181                     "O2IMS-InfrastructureInventory"
 182                 ]
 183             }
 184         },
 185         "/o2ims-infrastructureInventory/v1/deploymentManagers/{deploymentManagerID}": {
 186             "parameters": [
 187                 {
 188                     "in": "query",
 189                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 190                     "name": "exclude_default",
 191                     "type": "string"
 192                 },
 193                 {
 194                     "in": "query",
 195                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 196                     "name": "exclude_fields",
 197                     "type": "string"
 198                 },
 199                 {
 200                     "in": "query",
 201                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 202                     "name": "fields",
 203                     "type": "string"
 204                 },
 205                 {
 206                     "in": "query",
 207                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 208                     "name": "all_fields",
 209                     "type": "string"
 210                 },
 211                 {
 212                     "in": "query",
 213                     "description": "DMS profile: value supports \"native_k8sapi\"",
 214                     "name": "profile",
 215                     "type": "string"
 216                 },
 217                 {
 218                     "in": "path",
 219                     "description": "ID of the deployment manager",
 220                     "name": "deploymentManagerID",
 221                     "required": true,
 222                     "type": "string"
 223                 }
 224             ],
 225             "get": {
 226                 "responses": {
 227                     "200": {
 228                         "description": "Success",
 229                         "schema": {
 230                             "$ref": "#/definitions/DeploymentManagerGetDto"
 231                         }
 232                     },
 233                     "404": {
 234                         "description": "Deployment manager not found"
 235                     }
 236                 },
 237                 "operationId": "Get Deployment Manager Information",
 238                 "tags": [
 239                     "O2IMS-InfrastructureInventory"
 240                 ]
 241             }
 242         },
 243         "/o2ims-infrastructureInventory/v1/resourcePools": {
 244             "parameters": [
 245                 {
 246                     "in": "query",
 247                     "description": "Filter of the query.",
 248                     "name": "filter",
 249                     "type": "string"
 250                 },
 251                 {
 252                     "in": "query",
 253                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 254                     "name": "exclude_default",
 255                     "type": "string"
 256                 },
 257                 {
 258                     "in": "query",
 259                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 260                     "name": "exclude_fields",
 261                     "type": "string"
 262                 },
 263                 {
 264                     "in": "query",
 265                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 266                     "name": "fields",
 267                     "type": "string"
 268                 },
 269                 {
 270                     "in": "query",
 271                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 272                     "name": "all_fields",
 273                     "type": "string"
 274                 },
 275                 {
 276                     "default": 1,
 277                     "in": "query",
 278                     "description": "Page number of the results to fetch. Default: 1",
 279                     "name": "nextpage_opaque_marker",
 280                     "type": "string"
 281                 }
 282             ],
 283             "get": {
 284                 "responses": {
 285                     "200": {
 286                         "description": "Success",
 287                         "schema": {
 288                             "type": "array",
 289                             "items": {
 290                                 "$ref": "#/definitions/ResourcePoolGetDto"
 291                             }
 292                         }
 293                     }
 294                 },
 295                 "operationId": "Get Resource Pool List",
 296                 "tags": [
 297                     "O2IMS-InfrastructureInventory"
 298                 ]
 299             }
 300         },
 301         "/o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}": {
 302             "parameters": [
 303                 {
 304                     "in": "query",
 305                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 306                     "name": "exclude_default",
 307                     "type": "string"
 308                 },
 309                 {
 310                     "in": "query",
 311                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 312                     "name": "exclude_fields",
 313                     "type": "string"
 314                 },
 315                 {
 316                     "in": "query",
 317                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 318                     "name": "fields",
 319                     "type": "string"
 320                 },
 321                 {
 322                     "in": "query",
 323                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 324                     "name": "all_fields",
 325                     "type": "string"
 326                 },
 327                 {
 328                     "in": "path",
 329                     "description": "ID of the resource pool",
 330                     "name": "resourcePoolID",
 331                     "required": true,
 332                     "type": "string"
 333                 }
 334             ],
 335             "get": {
 336                 "responses": {
 337                     "200": {
 338                         "description": "Success",
 339                         "schema": {
 340                             "$ref": "#/definitions/ResourcePoolGetDto"
 341                         }
 342                     },
 343                     "404": {
 344                         "description": "Resource pool not found"
 345                     }
 346                 },
 347                 "operationId": "Get Resource Pool Information",
 348                 "tags": [
 349                     "O2IMS-InfrastructureInventory"
 350                 ]
 351             }
 352         },
 353         "/o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources": {
 354             "parameters": [
 355                 {
 356                     "in": "query",
 357                     "description": "Filter of the query.",
 358                     "name": "filter",
 359                     "type": "string"
 360                 },
 361                 {
 362                     "in": "query",
 363                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 364                     "name": "exclude_default",
 365                     "type": "string"
 366                 },
 367                 {
 368                     "in": "query",
 369                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 370                     "name": "exclude_fields",
 371                     "type": "string"
 372                 },
 373                 {
 374                     "in": "query",
 375                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 376                     "name": "fields",
 377                     "type": "string"
 378                 },
 379                 {
 380                     "in": "query",
 381                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 382                     "name": "all_fields",
 383                     "type": "string"
 384                 },
 385                 {
 386                     "default": 1,
 387                     "in": "query",
 388                     "description": "Page number of the results to fetch. Default: 1",
 389                     "name": "nextpage_opaque_marker",
 390                     "type": "string"
 391                 },
 392                 {
 393                     "in": "path",
 394                     "description": "ID of the resource pool",
 395                     "name": "resourcePoolID",
 396                     "required": true,
 397                     "type": "string"
 398                 }
 399             ],
 400             "get": {
 401                 "responses": {
 402                     "200": {
 403                         "description": "Success",
 404                         "schema": {
 405                             "type": "array",
 406                             "items": {
 407                                 "$ref": "#/definitions/ResourceListDto"
 408                             }
 409                         }
 410                     },
 411                     "404": {
 412                         "description": "Resource pool not found"
 413                     }
 414                 },
 415                 "operationId": "Get Resource List",
 416                 "tags": [
 417                     "O2IMS-InfrastructureInventory"
 418                 ]
 419             }
 420         },
 421         "/o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}": {
 422             "parameters": [
 423                 {
 424                     "in": "query",
 425                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 426                     "name": "exclude_default",
 427                     "type": "string"
 428                 },
 429                 {
 430                     "in": "query",
 431                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 432                     "name": "exclude_fields",
 433                     "type": "string"
 434                 },
 435                 {
 436                     "in": "query",
 437                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 438                     "name": "fields",
 439                     "type": "string"
 440                 },
 441                 {
 442                     "in": "query",
 443                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 444                     "name": "all_fields",
 445                     "type": "string"
 446                 },
 447                 {
 448                     "in": "path",
 449                     "description": "ID of the resource",
 450                     "name": "resourceID",
 451                     "required": true,
 452                     "type": "string"
 453                 },
 454                 {
 455                     "in": "path",
 456                     "description": "ID of the resource pool",
 457                     "name": "resourcePoolID",
 458                     "required": true,
 459                     "type": "string"
 460                 }
 461             ],
 462             "get": {
 463                 "responses": {
 464                     "200": {
 465                         "description": "Success",
 466                         "schema": {
 467                             "$ref": "#/definitions/ResourceGetDto2"
 468                         }
 469                     },
 470                     "404": {
 471                         "description": "Resource not found"
 472                     }
 473                 },
 474                 "operationId": "Get Resource Information",
 475                 "tags": [
 476                     "O2IMS-InfrastructureInventory"
 477                 ]
 478             }
 479         },
 480         "/o2ims-infrastructureInventory/v1/resourceTypes": {
 481             "parameters": [
 482                 {
 483                     "in": "query",
 484                     "description": "Filter of the query.",
 485                     "name": "filter",
 486                     "type": "string"
 487                 },
 488                 {
 489                     "in": "query",
 490                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 491                     "name": "exclude_default",
 492                     "type": "string"
 493                 },
 494                 {
 495                     "in": "query",
 496                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 497                     "name": "exclude_fields",
 498                     "type": "string"
 499                 },
 500                 {
 501                     "in": "query",
 502                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 503                     "name": "fields",
 504                     "type": "string"
 505                 },
 506                 {
 507                     "in": "query",
 508                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 509                     "name": "all_fields",
 510                     "type": "string"
 511                 },
 512                 {
 513                     "default": 1,
 514                     "in": "query",
 515                     "description": "Page number of the results to fetch. Default: 1",
 516                     "name": "nextpage_opaque_marker",
 517                     "type": "string"
 518                 }
 519             ],
 520             "get": {
 521                 "responses": {
 522                     "200": {
 523                         "description": "Success",
 524                         "schema": {
 525                             "type": "array",
 526                             "items": {
 527                                 "$ref": "#/definitions/ResourceTypeGetDto"
 528                             }
 529                         }
 530                     }
 531                 },
 532                 "operationId": "Get Resource Type List",
 533                 "tags": [
 534                     "O2IMS-InfrastructureInventory"
 535                 ]
 536             }
 537         },
 538         "/o2ims-infrastructureInventory/v1/resourceTypes/{resourceTypeID}": {
 539             "parameters": [
 540                 {
 541                     "in": "query",
 542                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 543                     "name": "exclude_default",
 544                     "type": "string"
 545                 },
 546                 {
 547                     "in": "query",
 548                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 549                     "name": "exclude_fields",
 550                     "type": "string"
 551                 },
 552                 {
 553                     "in": "query",
 554                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 555                     "name": "fields",
 556                     "type": "string"
 557                 },
 558                 {
 559                     "in": "query",
 560                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 561                     "name": "all_fields",
 562                     "type": "string"
 563                 },
 564                 {
 565                     "in": "path",
 566                     "description": "ID of the resource type",
 567                     "name": "resourceTypeID",
 568                     "required": true,
 569                     "type": "string"
 570                 }
 571             ],
 572             "get": {
 573                 "responses": {
 574                     "200": {
 575                         "description": "Success",
 576                         "schema": {
 577                             "$ref": "#/definitions/ResourceTypeGetDto"
 578                         }
 579                     },
 580                     "404": {
 581                         "description": "Resource type not found"
 582                     }
 583                 },
 584                 "operationId": "Get Resource Type Information",
 585                 "tags": [
 586                     "O2IMS-InfrastructureInventory"
 587                 ]
 588             }
 589         },
 590         "/o2ims-infrastructureInventory/v1/subscriptions": {
 591             "get": {
 592                 "responses": {
 593                     "200": {
 594                         "description": "Success",
 595                         "schema": {
 596                             "type": "array",
 597                             "items": {
 598                                 "$ref": "#/definitions/SubscriptionGetDto"
 599                             }
 600                         }
 601                     }
 602                 },
 603                 "operationId": "Get Subscription List",
 604                 "parameters": [
 605                     {
 606                         "in": "query",
 607                         "description": "Filter of the query.",
 608                         "name": "filter",
 609                         "type": "string"
 610                     },
 611                     {
 612                         "in": "query",
 613                         "description": "Exclude showing all default fields, Set \"true\" to enable.",
 614                         "name": "exclude_default",
 615                         "type": "string"
 616                     },
 617                     {
 618                         "in": "query",
 619                         "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 620                         "name": "exclude_fields",
 621                         "type": "string"
 622                     },
 623                     {
 624                         "in": "query",
 625                         "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 626                         "name": "fields",
 627                         "type": "string"
 628                     },
 629                     {
 630                         "in": "query",
 631                         "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 632                         "name": "all_fields",
 633                         "type": "string"
 634                     },
 635                     {
 636                         "default": 1,
 637                         "in": "query",
 638                         "description": "Page number of the results to fetch. Default: 1",
 639                         "name": "nextpage_opaque_marker",
 640                         "type": "string"
 641                     }
 642                 ],
 643                 "tags": [
 644                     "O2IMS-InfrastructureInventory"
 645                 ]
 646             },
 647             "post": {
 648                 "responses": {
 649                     "201": {
 650                         "description": "Success",
 651                         "schema": {
 652                             "$ref": "#/definitions/SubscriptionGetDto"
 653                         }
 654                     }
 655                 },
 656                 "operationId": "Create a Subscription",
 657                 "parameters": [
 658                     {
 659                         "name": "payload",
 660                         "required": true,
 661                         "in": "body",
 662                         "schema": {
 663                             "$ref": "#/definitions/SubscriptionCreateDto"
 664                         }
 665                     }
 666                 ],
 667                 "tags": [
 668                     "O2IMS-InfrastructureInventory"
 669                 ]
 670             }
 671         },
 672         "/o2ims-infrastructureInventory/v1/subscriptions/{subscriptionID}": {
 673             "parameters": [
 674                 {
 675                     "in": "path",
 676                     "description": "ID of the subscription",
 677                     "name": "subscriptionID",
 678                     "required": true,
 679                     "type": "string"
 680                 }
 681             ],
 682             "get": {
 683                 "responses": {
 684                     "200": {
 685                         "description": "Success",
 686                         "schema": {
 687                             "$ref": "#/definitions/SubscriptionGetDto"
 688                         }
 689                     },
 690                     "404": {
 691                         "description": "Subscription not found"
 692                     }
 693                 },
 694                 "operationId": "Get Subscription Information",
 695                 "parameters": [
 696                     {
 697                         "in": "query",
 698                         "description": "Exclude showing all default fields, Set \"true\" to enable.",
 699                         "name": "exclude_default",
 700                         "type": "string"
 701                     },
 702                     {
 703                         "in": "query",
 704                         "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 705                         "name": "exclude_fields",
 706                         "type": "string"
 707                     },
 708                     {
 709                         "in": "query",
 710                         "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 711                         "name": "fields",
 712                         "type": "string"
 713                     },
 714                     {
 715                         "in": "query",
 716                         "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 717                         "name": "all_fields",
 718                         "type": "string"
 719                     }
 720                 ],
 721                 "tags": [
 722                     "O2IMS-InfrastructureInventory"
 723                 ]
 724             },
 725             "delete": {
 726                 "responses": {
 727                     "200": {
 728                         "description": "Subscription deleted"
 729                     },
 730                     "404": {
 731                         "description": "Subscription not found"
 732                     }
 733                 },
 734                 "operationId": "Delete a Subscription",
 735                 "tags": [
 736                     "O2IMS-InfrastructureInventory"
 737                 ]
 738             }
 739         },
 740         "/o2ims-infrastructureMonitoring/api_versions": {
 741             "get": {
 742                 "responses": {
 743                     "200": {
 744                         "description": "Success",
 745                         "schema": {
 746                             "$ref": "#/definitions/MonitoringAPIVersion"
 747                         }
 748                     }
 749                 },
 750                 "operationId": "Get Monitoring Version",
 751                 "tags": [
 752                     "O2IMS-InfrastructureMonitoring"
 753                 ]
 754             }
 755         },
 756         "/o2ims-infrastructureMonitoring/v1/alarmSubscriptions": {
 757             "get": {
 758                 "responses": {
 759                     "200": {
 760                         "description": "Success",
 761                         "schema": {
 762                             "type": "array",
 763                             "items": {
 764                                 "$ref": "#/definitions/AlarmSubscriptionGetDto"
 765                             }
 766                         }
 767                     }
 768                 },
 769                 "operationId": "Get Alarm Subscription List",
 770                 "parameters": [
 771                     {
 772                         "in": "query",
 773                         "description": "Filter of the query.",
 774                         "name": "filter",
 775                         "type": "string"
 776                     },
 777                     {
 778                         "in": "query",
 779                         "description": "Exclude showing all default fields, Set \"true\" to enable.",
 780                         "name": "exclude_default",
 781                         "type": "string"
 782                     },
 783                     {
 784                         "in": "query",
 785                         "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 786                         "name": "exclude_fields",
 787                         "type": "string"
 788                     },
 789                     {
 790                         "in": "query",
 791                         "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 792                         "name": "fields",
 793                         "type": "string"
 794                     },
 795                     {
 796                         "in": "query",
 797                         "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 798                         "name": "all_fields",
 799                         "type": "string"
 800                     },
 801                     {
 802                         "default": 1,
 803                         "in": "query",
 804                         "description": "Page number of the results to fetch. Default: 1",
 805                         "name": "nextpage_opaque_marker",
 806                         "type": "string"
 807                     }
 808                 ],
 809                 "tags": [
 810                     "O2IMS-InfrastructureMonitoring"
 811                 ]
 812             },
 813             "post": {
 814                 "responses": {
 815                     "201": {
 816                         "description": "Success",
 817                         "schema": {
 818                             "$ref": "#/definitions/AlarmSubscriptionGetDto"
 819                         }
 820                     }
 821                 },
 822                 "operationId": "Create a Alarm Subscription",
 823                 "parameters": [
 824                     {
 825                         "name": "payload",
 826                         "required": true,
 827                         "in": "body",
 828                         "schema": {
 829                             "$ref": "#/definitions/AlarmSubscriptionCreateDto"
 830                         }
 831                     }
 832                 ],
 833                 "tags": [
 834                     "O2IMS-InfrastructureMonitoring"
 835                 ]
 836             }
 837         },
 838         "/o2ims-infrastructureMonitoring/v1/alarmSubscriptions/{alarmSubscriptionID}": {
 839             "parameters": [
 840                 {
 841                     "in": "path",
 842                     "description": "ID of the Alarm Subscription",
 843                     "name": "alarmSubscriptionID",
 844                     "required": true,
 845                     "type": "string"
 846                 }
 847             ],
 848             "get": {
 849                 "responses": {
 850                     "200": {
 851                         "description": "Success",
 852                         "schema": {
 853                             "$ref": "#/definitions/AlarmSubscriptionGetDto"
 854                         }
 855                     },
 856                     "404": {
 857                         "description": "Alarm Subscription not found"
 858                     }
 859                 },
 860                 "operationId": "Get Alarm Subscription Information",
 861                 "parameters": [
 862                     {
 863                         "in": "query",
 864                         "description": "Exclude showing all default fields, Set \"true\" to enable.",
 865                         "name": "exclude_default",
 866                         "type": "string"
 867                     },
 868                     {
 869                         "in": "query",
 870                         "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 871                         "name": "exclude_fields",
 872                         "type": "string"
 873                     },
 874                     {
 875                         "in": "query",
 876                         "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 877                         "name": "fields",
 878                         "type": "string"
 879                     },
 880                     {
 881                         "in": "query",
 882                         "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 883                         "name": "all_fields",
 884                         "type": "string"
 885                     }
 886                 ],
 887                 "tags": [
 888                     "O2IMS-InfrastructureMonitoring"
 889                 ]
 890             },
 891             "delete": {
 892                 "responses": {
 893                     "200": {
 894                         "description": "Subscription deleted"
 895                     },
 896                     "404": {
 897                         "description": "Alarm Subscription not found"
 898                     }
 899                 },
 900                 "operationId": "Delete an Alarm Subscription",
 901                 "tags": [
 902                     "O2IMS-InfrastructureMonitoring"
 903                 ]
 904             }
 905         },
 906         "/o2ims-infrastructureMonitoring/v1/alarms": {
 907             "parameters": [
 908                 {
 909                     "in": "query",
 910                     "description": "Filter of the query.",
 911                     "name": "filter",
 912                     "type": "string"
 913                 },
 914                 {
 915                     "in": "query",
 916                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 917                     "name": "exclude_default",
 918                     "type": "string"
 919                 },
 920                 {
 921                     "in": "query",
 922                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 923                     "name": "exclude_fields",
 924                     "type": "string"
 925                 },
 926                 {
 927                     "in": "query",
 928                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 929                     "name": "fields",
 930                     "type": "string"
 931                 },
 932                 {
 933                     "in": "query",
 934                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 935                     "name": "all_fields",
 936                     "type": "string"
 937                 },
 938                 {
 939                     "default": 1,
 940                     "in": "query",
 941                     "description": "Page number of the results to fetch. Default: 1",
 942                     "name": "nextpage_opaque_marker",
 943                     "type": "string"
 944                 }
 945             ],
 946             "get": {
 947                 "responses": {
 948                     "200": {
 949                         "description": "Success",
 950                         "schema": {
 951                             "type": "array",
 952                             "items": {
 953                                 "$ref": "#/definitions/AlarmGetDto"
 954                             }
 955                         }
 956                     }
 957                 },
 958                 "operationId": "Get Alarm Event Record List",
 959                 "tags": [
 960                     "O2IMS-InfrastructureMonitoring"
 961                 ]
 962             }
 963         },
 964         "/o2ims-infrastructureMonitoring/v1/alarms/{alarmEventRecordId}": {
 965             "parameters": [
 966                 {
 967                     "in": "query",
 968                     "description": "Exclude showing all default fields, Set \"true\" to enable.",
 969                     "name": "exclude_default",
 970                     "type": "string"
 971                 },
 972                 {
 973                     "in": "query",
 974                     "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
 975                     "name": "exclude_fields",
 976                     "type": "string"
 977                 },
 978                 {
 979                     "in": "query",
 980                     "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
 981                     "name": "fields",
 982                     "type": "string"
 983                 },
 984                 {
 985                     "in": "query",
 986                     "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
 987                     "name": "all_fields",
 988                     "type": "string"
 989                 },
 990                 {
 991                     "in": "path",
 992                     "description": "ID of the alarm event record",
 993                     "name": "alarmEventRecordId",
 994                     "required": true,
 995                     "type": "string"
 996                 }
 997             ],
 998             "get": {
 999                 "responses": {
1000                     "200": {
1001                         "description": "Success",
1002                         "schema": {
1003                             "$ref": "#/definitions/AlarmGetDto"
1004                         }
1005                     },
1006                     "404": {
1007                         "description": "Alarm Event Record not found"
1008                     }
1009                 },
1010                 "operationId": "Get Alarm Event Record Information",
1011                 "tags": [
1012                     "O2IMS-InfrastructureMonitoring"
1013                 ]
1014             }
1015         },
1016         "/o2ims-infrastructureMonitoring/v1/api_versions": {
1017             "get": {
1018                 "responses": {
1019                     "200": {
1020                         "description": "Success",
1021                         "schema": {
1022                             "type": "array",
1023                             "items": {
1024                                 "$ref": "#/definitions/MonitoringV1APIVersion"
1025                             }
1026                         }
1027                     }
1028                 },
1029                 "operationId": "Get Monitoring API version",
1030                 "tags": [
1031                     "O2IMS-InfrastructureMonitoring"
1032                 ]
1033             }
1034         }
1035     },
1036     "info": {
1037         "title": "INF O2 Services API",
1038         "version": "1.0.0",
1039         "description": "Swagger OpenAPI document for the INF O2 Services"
1040     },
1041     "produces": [
1042         "application/json"
1043     ],
1044     "consumes": [
1045         "application/json"
1046     ],
1047     "tags": [
1048         {
1049             "name": "O2IMS-InfrastructureInventory",
1050             "description": "O2 IMS Inventory related operations."
1051         },
1052         {
1053             "name": "O2IMS-InfrastructureMonitoring",
1054             "description": "O2 IMS Monitoring related operations."
1055         }
1056     ],
1057     "definitions": {
1058         "InventoryAPIVersion": {
1059             "required": [
1060                 "uriPrefix"
1061             ],
1062             "properties": {
1063                 "uriPrefix": {
1064                     "type": "string",
1065                     "description": "Specifies the URI prefix for the API",
1066                     "example": "https://128.224.115.36:30205/o2ims-infrastructureInventory"
1067                 },
1068                 "apiVersions": {
1069                     "type": "array",
1070                     "description": "Version(s) supported for the API signaled by the uriPrefix attribute.",
1071                     "example": [
1072                         {
1073                             "version": "1.0.0"
1074                         }
1075                     ],
1076                     "items": {
1077                         "$ref": "#/definitions/InventoryApiVersionStructure"
1078                     }
1079                 }
1080             },
1081             "x-mask": "{uriPrefix,apiVersions}",
1082             "type": "object"
1083         },
1084         "InventoryApiVersionStructure": {
1085             "required": [
1086                 "version"
1087             ],
1088             "properties": {
1089                 "version": {
1090                     "type": "string",
1091                     "description": "Identifies a supported version.",
1092                     "example": "1.0.0"
1093                 }
1094             },
1095             "x-mask": "{version}",
1096             "type": "object"
1097         },
1098         "InventoryV1APIVersion": {
1099             "required": [
1100                 "uriPrefix"
1101             ],
1102             "properties": {
1103                 "uriPrefix": {
1104                     "type": "string",
1105                     "description": "Specifies the URI prefix for the API",
1106                     "example": "https://128.224.115.36:30205/o2ims-infrastructureInventory/v1"
1107                 },
1108                 "apiVersions": {
1109                     "type": "array",
1110                     "description": "Version(s) supported for the API signaled by the uriPrefix attribute.",
1111                     "example": [
1112                         {
1113                             "version": "1.0.0"
1114                         }
1115                     ],
1116                     "items": {
1117                         "$ref": "#/definitions/InventoryV1ApiVersionStructure"
1118                     }
1119                 }
1120             },
1121             "x-mask": "{uriPrefix,apiVersions}",
1122             "type": "object"
1123         },
1124         "InventoryV1ApiVersionStructure": {
1125             "required": [
1126                 "version"
1127             ],
1128             "properties": {
1129                 "version": {
1130                     "type": "string",
1131                     "description": "Identifies a supported version.",
1132                     "example": "1.0.0"
1133                 }
1134             },
1135             "x-mask": "{version}",
1136             "type": "object"
1137         },
1138         "OcloudDto": {
1139             "required": [
1140                 "oCloudId"
1141             ],
1142             "properties": {
1143                 "oCloudId": {
1144                     "type": "string",
1145                     "description": "Identifier for the containing O-Cloud.",
1146                     "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd"
1147                 },
1148                 "globalCloudId": {
1149                     "type": "string",
1150                     "description": "Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.",
1151                     "example": "10a07219-4201-4b3e-a52d-81ab6a755d8a"
1152                 },
1153                 "globalcloudId": {
1154                     "type": "string",
1155                     "description": "Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.(Specification)",
1156                     "example": "10a07219-4201-4b3e-a52d-81ab6a755d8a"
1157                 },
1158                 "name": {
1159                     "type": "string",
1160                     "description": "Human readable name of the O-Cloud.",
1161                     "example": "95b818b8-b315-4d9f-af37-b82c492101f1"
1162                 },
1163                 "description": {
1164                     "type": "string",
1165                     "description": "Human readable description of the O-Cloud.",
1166                     "example": "An ocloud"
1167                 },
1168                 "serviceUri": {
1169                     "type": "string",
1170                     "description": "The fully qualified URI root to all services provided by the O2ims interface",
1171                     "example": "https://128.224.115.51:30205"
1172                 },
1173                 "extensions": {
1174                     "type": "string",
1175                     "description": "These are unspecified (not standardized) properties (keys) which are tailored by the vendor to extend the information provided about the O-Cloud.",
1176                     "example": ""
1177                 }
1178             },
1179             "x-mask": "{oCloudId,globalCloudId,globalcloudId,name,description,serviceUri}",
1180             "type": "object"
1181         },
1182         "ResourceTypeGetDto": {
1183             "required": [
1184                 "resourceTypeId"
1185             ],
1186             "properties": {
1187                 "resourceTypeId": {
1188                     "type": "string",
1189                     "description": "Identifier for the Resource Type.",
1190                     "example": "60cba7be-e2cd-3b8c-a7ff-16e0f10573f9"
1191                 },
1192                 "name": {
1193                     "type": "string",
1194                     "description": "Human readable name of the resource type.",
1195                     "example": "pserver"
1196                 },
1197                 "description": {
1198                     "type": "string",
1199                     "description": "Human readable description of the resource type.",
1200                     "example": "The Physical Server resource type"
1201                 },
1202                 "vendor": {
1203                     "type": "string",
1204                     "description": "Provider of the Resource.",
1205                     "example": ""
1206                 },
1207                 "model": {
1208                     "type": "string",
1209                     "description": "Information about the model of the resource as defined by its provider.",
1210                     "example": ""
1211                 },
1212                 "version": {
1213                     "type": "string",
1214                     "description": "Version or generation of the resource as defined by its provider.",
1215                     "example": ""
1216                 },
1217                 "alarmDictionary": {
1218                     "$ref": "#/definitions/AlarmDictionaryDto"
1219                 },
1220                 "extensions": {
1221                     "type": "string",
1222                     "description": "List of metadata key-value pairs used to associate meaningful metadata to the related resource type.",
1223                     "example": ""
1224                 }
1225             },
1226             "x-mask": "{resourceTypeId,name,description,model,vendor,version}",
1227             "type": "object"
1228         },
1229         "AlarmDictionaryDto": {
1230             "properties": {
1231                 "id": {
1232                     "type": "string",
1233                     "description": "Identifier for the Alarm Dictionary.",
1234                     "example": "7e1e59c3-c99e-3d1c-9934-21548a3a699a"
1235                 },
1236                 "alarmDictionaryVersion": {
1237                     "type": "string",
1238                     "description": "Version of the Alarm Dictionary.",
1239                     "example": "0.1"
1240                 },
1241                 "alarmDictionarySchemaVersion": {
1242                     "type": "string",
1243                     "description": "Version of the Alarm Dictionary Schema to which this alarm dictionary conforms.",
1244                     "example": "0.1"
1245                 },
1246                 "entityType": {
1247                     "type": "string",
1248                     "description": "O-RAN entity type emitting the alarm: This shall be unique per vendor ResourceType.model and ResourceType.version",
1249                     "example": "pserver"
1250                 },
1251                 "vendor": {
1252                     "type": "string",
1253                     "description": "Vendor of the Entity Type to whom this Alarm Dictionary applies. This should be the same value as in the ResourceType.vendor attribute.",
1254                     "example": ""
1255                 },
1256                 "managementInterfaceId": {
1257                     "type": "string",
1258                     "description": "List of management interface over which alarms are transmitted for this Entity Type.",
1259                     "example": "O2IMS"
1260                 },
1261                 "pkNotificationField": {
1262                     "type": "string",
1263                     "description": "Identifies which field or list of fields in the alarm notification contains the primary key (PK) into the Alarm Dictionary for this interface; i.e. which field contains the Alarm Definition ID.",
1264                     "example": ""
1265                 },
1266                 "alarmDefinition": {
1267                     "type": "array",
1268                     "description": "Contains the list of alarms that can be detected against this ResourceType.",
1269                     "example": "",
1270                     "items": {
1271                         "$ref": "#/definitions/AlarmDefinitionDto"
1272                     }
1273                 }
1274             },
1275             "type": "object"
1276         },
1277         "AlarmDefinitionDto": {
1278             "properties": {
1279                 "alarmDefinitionId": {
1280                     "type": "string",
1281                     "description": "Provides a unique identifier of the alarm being raised.",
1282                     "example": "eaefa070-7cb6-3403-be46-177bd9ccc2d3"
1283                 },
1284                 "alarmName": {
1285                     "type": "string",
1286                     "description": "Provides short name for the alarm.",
1287                     "example": "100.104"
1288                 },
1289                 "alarmLastChange": {
1290                     "type": "string",
1291                     "description": "Indicates the Alarm Dictionary Version in which this alarm last changed.",
1292                     "example": "0.1"
1293                 },
1294                 "alarmChangeType": {
1295                     "type": "string",
1296                     "description": "Indicates the type of change that occurred during the alarm last change; added, deleted, modified.",
1297                     "example": "ADDED"
1298                 },
1299                 "alarmDescription": {
1300                     "type": "string",
1301                     "description": "Provides a longer descriptive meaning of the alarm condition and a description of the consequences of the alarm condition.",
1302                     "example": "host=<hostname>.filesystem=<mount-dir>\n    File System threshold exceeded; threshold x%, actual y% .\n        CRITICAL @ 90%\n        MAJOR    @ 80%\nOR\nhost=<hostname>.volumegroup=<volumegroup-name>\n    Monitor and if condition persists, consider addin ..."
1303                 },
1304                 "proposedRepairActions": {
1305                     "type": "string",
1306                     "description": "Provides guidance for proposed repair actions.",
1307                     "example": "Reduce usage or resize filesystem."
1308                 },
1309                 "clearingType": {
1310                     "type": "string",
1311                     "description": "Identifies whether alarm is cleared automatically or manually.",
1312                     "example": "MANUAL"
1313                 },
1314                 "managementInterfaceId": {
1315                     "type": "string",
1316                     "description": "List of management interface over which alarms are transmitted for this Entity Type.",
1317                     "example": "O2IMS"
1318                 },
1319                 "pkNotificationField": {
1320                     "type": "string",
1321                     "description": "Identifies which field or list of fields in the alarm notification contains the primary key (PK) into the Alarm Dictionary for this interface; i.e. which field contains the Alarm Definition ID.",
1322                     "example": ""
1323                 },
1324                 "alarmAdditionalFields": {
1325                     "type": "string",
1326                     "description": "List of metadata key-value pairs used to associate meaningful metadata to the related resource type.",
1327                     "example": ""
1328                 }
1329             },
1330             "type": "object"
1331         },
1332         "ResourcePoolGetDto": {
1333             "required": [
1334                 "resourcePoolId"
1335             ],
1336             "properties": {
1337                 "resourcePoolId": {
1338                     "type": "string",
1339                     "description": "Identifier for the Resource Pool in the O-Cloud instance.",
1340                     "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd"
1341                 },
1342                 "globalLocationId": {
1343                     "type": "string",
1344                     "description": "This identifier is copied from the O-Cloud Id assigned by the SMO during the O-Cloud deployment.",
1345                     "example": ""
1346                 },
1347                 "name": {
1348                     "type": "string",
1349                     "description": "Human readable name of the resource pool.",
1350                     "example": "RegionOne"
1351                 },
1352                 "description": {
1353                     "type": "string",
1354                     "description": "Human readable description of the resource pool.",
1355                     "example": "A Resource Pool"
1356                 },
1357                 "oCloudId": {
1358                     "type": "string",
1359                     "description": "Identifier for the containing O-Cloud.",
1360                     "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd"
1361                 },
1362                 "location": {
1363                     "type": "string",
1364                     "description": "Information about the geographical location of the resource pool as detected by the O-Cloud.",
1365                     "example": ""
1366                 },
1367                 "extensions": {
1368                     "type": "string",
1369                     "description": "List of metadata key-value pairs used to associate meaningful metadata to the related resource pool.",
1370                     "example": ""
1371                 }
1372             },
1373             "x-mask": "{resourcePoolId,oCloudId,globalLocationId,name,description}",
1374             "type": "object"
1375         },
1376         "ResourceListDto": {
1377             "required": [
1378                 "resourceId"
1379             ],
1380             "properties": {
1381                 "resourceId": {
1382                     "type": "string",
1383                     "description": "Identifier for the Resource.",
1384                     "example": "5b3a2da8-17da-466c-b5f7-972590c7baf2"
1385                 },
1386                 "resourceTypeId": {
1387                     "type": "string",
1388                     "description": "Identifier for the Resource Type of this resource.",
1389                     "example": "60cba7be-e2cd-3b8c-a7ff-16e0f10573f9"
1390                 },
1391                 "resourcePoolId": {
1392                     "type": "string",
1393                     "description": "Identifier of the Resource Pool containing this resource.",
1394                     "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd"
1395                 },
1396                 "globalAssetId": {
1397                     "type": "string",
1398                     "description": "Identifier or serial number of the resource.",
1399                     "example": ""
1400                 },
1401                 "parentId": {
1402                     "type": "string",
1403                     "description": "Identifier for the parent resource.",
1404                     "example": "None"
1405                 },
1406                 "description": {
1407                     "type": "string",
1408                     "description": "Human readable description of the resource.",
1409                     "example": "id:1;hostname:controller-0;mgmt_mac:00:00:00:00:00:00;mgmt_ip:192.168.204.2;personality:controller;subfunctions:controller,worker;administrative:unlocked;operational:enabled;availability:available;clock_synchronization:ntp;capabilities:{'is_max_cpu_configurable': 'configurable', 'stor_function': 'monitor', 'Personality': 'Controller-Active'};boot_device:/dev/disk/by-path/pci-0000:02:00.0-scsi-0:1:0:0;rootfs_device:/dev/disk/by-path/pci-0000:02:00.0-scsi-0:1:0:0;software_load:22.12;install_state:None;max_cpu_mhz_allowed:None"
1410                 },
1411                 "extensions": {
1412                     "type": "object"
1413                 }
1414             },
1415             "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1416             "type": "object"
1417         },
1418         "ResourceGetDto2": {
1419             "required": [
1420                 "resourceId"
1421             ],
1422             "properties": {
1423                 "resourceId": {
1424                     "type": "string",
1425                     "description": "Identifier for the Resource.",
1426                     "example": "eee8b101-6b7f-4f0a-b54b-89adc0f3f906"
1427                 },
1428                 "resourceTypeId": {
1429                     "type": "string",
1430                     "description": "Identifier for the Resource Type of this resource.",
1431                     "example": "a45983bb-199a-30ec-b7a1-eab2455f333c"
1432                 },
1433                 "resourcePoolId": {
1434                     "type": "string",
1435                     "description": "Identifier of the Resource Pool containing this resource.",
1436                     "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd"
1437                 },
1438                 "globalAssetId": {
1439                     "type": "string",
1440                     "description": "Identifier or serial number of the resource.",
1441                     "example": ""
1442                 },
1443                 "parentId": {
1444                     "type": "string",
1445                     "description": "Identifier for the parent resource.",
1446                     "example": "5b3a2da8-17da-466c-b5f7-972590c7baf2"
1447                 },
1448                 "description": {
1449                     "type": "string",
1450                     "description": "Human readable description of the resource.",
1451                     "example": "cpu:0;core:0;thread:0;cpu_family:6;cpu_model:Intel(R) Xeon(R) CPU E5-2670 v2 @ 2.50GHz;allocated_function:Platform;numa_node:0"
1452                 },
1453                 "extensions": {
1454                     "type": "object"
1455                 },
1456                 "elements": {
1457                     "type": "array",
1458                     "items": {
1459                         "$ref": "#/definitions/ResourceGetDto1"
1460                     }
1461                 }
1462             },
1463             "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1464             "type": "object"
1465         },
1466         "ResourceGetDto1": {
1467             "required": [
1468                 "resourceId"
1469             ],
1470             "properties": {
1471                 "resourceId": {
1472                     "type": "string",
1473                     "description": "Identifier for the Resource.",
1474                     "example": "eee8b101-6b7f-4f0a-b54b-89adc0f3f906"
1475                 },
1476                 "resourceTypeId": {
1477                     "type": "string",
1478                     "description": "Identifier for the Resource Type of this resource.",
1479                     "example": "a45983bb-199a-30ec-b7a1-eab2455f333c"
1480                 },
1481                 "resourcePoolId": {
1482                     "type": "string",
1483                     "description": "Identifier of the Resource Pool containing this resource.",
1484                     "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd"
1485                 },
1486                 "globalAssetId": {
1487                     "type": "string",
1488                     "description": "Identifier or serial number of the resource.",
1489                     "example": ""
1490                 },
1491                 "parentId": {
1492                     "type": "string",
1493                     "description": "Identifier for the parent resource.",
1494                     "example": "5b3a2da8-17da-466c-b5f7-972590c7baf2"
1495                 },
1496                 "description": {
1497                     "type": "string",
1498                     "description": "Human readable description of the resource.",
1499                     "example": "cpu:0;core:0;thread:0;cpu_family:6;cpu_model:Intel(R) Xeon(R) CPU E5-2670 v2 @ 2.50GHz;allocated_function:Platform;numa_node:0"
1500                 },
1501                 "extensions": {
1502                     "type": "object"
1503                 },
1504                 "elements": {
1505                     "type": "array",
1506                     "items": {
1507                         "$ref": "#/definitions/ResourceGetDto0"
1508                     }
1509                 }
1510             },
1511             "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1512             "type": "object"
1513         },
1514         "ResourceGetDto0": {
1515             "required": [
1516                 "resourceId"
1517             ],
1518             "properties": {
1519                 "resourceId": {
1520                     "type": "string",
1521                     "description": "Identifier for the Resource.",
1522                     "example": "eee8b101-6b7f-4f0a-b54b-89adc0f3f906"
1523                 },
1524                 "resourceTypeId": {
1525                     "type": "string",
1526                     "description": "Identifier for the Resource Type of this resource.",
1527                     "example": "a45983bb-199a-30ec-b7a1-eab2455f333c"
1528                 },
1529                 "resourcePoolId": {
1530                     "type": "string",
1531                     "description": "Identifier of the Resource Pool containing this resource.",
1532                     "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd"
1533                 },
1534                 "globalAssetId": {
1535                     "type": "string",
1536                     "description": "Identifier or serial number of the resource.",
1537                     "example": ""
1538                 },
1539                 "parentId": {
1540                     "type": "string",
1541                     "description": "Identifier for the parent resource.",
1542                     "example": "5b3a2da8-17da-466c-b5f7-972590c7baf2"
1543                 },
1544                 "description": {
1545                     "type": "string",
1546                     "description": "Human readable description of the resource.",
1547                     "example": "cpu:0;core:0;thread:0;cpu_family:6;cpu_model:Intel(R) Xeon(R) CPU E5-2670 v2 @ 2.50GHz;allocated_function:Platform;numa_node:0"
1548                 },
1549                 "extensions": {
1550                     "type": "object"
1551                 }
1552             },
1553             "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1554             "type": "object"
1555         },
1556         "DeploymentManagerListDto": {
1557             "required": [
1558                 "deploymentManagerId"
1559             ],
1560             "properties": {
1561                 "deploymentManagerId": {
1562                     "type": "string",
1563                     "description": "Identifier for the Deployment Manager.",
1564                     "example": "c765516a-a84e-30c9-b954-9c3031bf71c8"
1565                 },
1566                 "name": {
1567                     "type": "string",
1568                     "description": "Human readable name of the deployment manager.",
1569                     "example": "95b818b8-b315-4d9f-af37-b82c492101f1.kubernetes"
1570                 },
1571                 "description": {
1572                     "type": "string",
1573                     "description": "Human readable description of the deployment manager.",
1574                     "example": "A DMS"
1575                 },
1576                 "oCloudId": {
1577                     "type": "string",
1578                     "description": "Identifier for the containing O-Cloud.",
1579                     "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd"
1580                 },
1581                 "serviceUri": {
1582                     "type": "string",
1583                     "description": "The fully qualified URI to a Deployment Management server for O2dms.",
1584                     "example": "https://128.224.115.51:6443"
1585                 },
1586                 "capabilities": {
1587                     "$ref": "#/definitions/DeploymentManagerCapabilities"
1588                 },
1589                 "profileSupportList": {
1590                     "type": "array",
1591                     "description": "Profile support list, use default for the return endpoint",
1592                     "example": [
1593                         "native_k8sapi"
1594                     ],
1595                     "items": {
1596                         "type": "string"
1597                     }
1598                 },
1599                 "extensions": {
1600                     "type": "string",
1601                     "description": "List of metadata key-value pairs used to associate meaningful metadata to the related Deployment Manager",
1602                     "example": ""
1603                 }
1604             },
1605             "x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,profileSupportList}",
1606             "type": "object"
1607         },
1608         "DeploymentManagerCapabilities": {
1609             "properties": {
1610                 "OS": {
1611                     "type": "string",
1612                     "description": "Show the OS capablities of the Deployment Manager",
1613                     "example": "low_latency"
1614                 }
1615             },
1616             "type": "object"
1617         },
1618         "DeploymentManagerGetDto": {
1619             "required": [
1620                 "deploymentManagerId"
1621             ],
1622             "properties": {
1623                 "deploymentManagerId": {
1624                     "type": "string",
1625                     "description": "Identifier for the Deployment Manager.",
1626                     "example": "c765516a-a84e-30c9-b954-9c3031bf71c8"
1627                 },
1628                 "name": {
1629                     "type": "string",
1630                     "description": "Human readable name of the deployment manager.",
1631                     "example": "95b818b8-b315-4d9f-af37-b82c492101f1.kubernetes"
1632                 },
1633                 "description": {
1634                     "type": "string",
1635                     "description": "Human readable description of the deployment manager.",
1636                     "example": "A DMS"
1637                 },
1638                 "oCloudId": {
1639                     "type": "string",
1640                     "description": "Identifier for the containing O-Cloud.",
1641                     "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd"
1642                 },
1643                 "serviceUri": {
1644                     "type": "string",
1645                     "description": "The fully qualified URI to a Deployment Management server for O2dms.",
1646                     "example": "https://128.224.115.51:6443"
1647                 },
1648                 "capabilities": {
1649                     "$ref": "#/definitions/DeploymentManagerCapabilities"
1650                 },
1651                 "extensions": {
1652                     "$ref": "#/definitions/DeploymentManagerExtensions"
1653                 }
1654             },
1655             "x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,extensions{profileName,profileData}}",
1656             "type": "object"
1657         },
1658         "DeploymentManagerExtensions": {
1659             "properties": {
1660                 "profileName": {
1661                     "type": "string",
1662                     "description": "",
1663                     "example": ""
1664                 },
1665                 "profileData": {
1666                     "$ref": "#/definitions/DeploymentManagerGetDtoProfile"
1667                 }
1668             },
1669             "type": "object"
1670         },
1671         "DeploymentManagerGetDtoProfile": {
1672             "properties": {
1673                 "cluster_api_endpoint": {
1674                     "type": "string",
1675                     "description": "Kubernetes Cluster API Endpoint",
1676                     "example": "https://128.224.115.51:6443"
1677                 },
1678                 "cluster_ca_cert": {
1679                     "type": "string",
1680                     "description": "Kubernetes Cluster CA cert",
1681                     "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUZEakNDQX....."
1682                 },
1683                 "admin_user": {
1684                     "type": "string",
1685                     "description": "Kubernetes Admin username",
1686                     "example": "kubernetes-admin"
1687                 },
1688                 "admin_client_cert": {
1689                     "type": "string",
1690                     "description": "Kubernetes Admin client cert",
1691                     "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVJRENDQW....."
1692                 },
1693                 "admin_client_key": {
1694                     "type": "string",
1695                     "description": "Kubernetes Admin client key",
1696                     "example": "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcE....."
1697                 },
1698                 "helmcli_host_with_port": {
1699                     "type": "string",
1700                     "description": "Helm CLI Host address with SSH port",
1701                     "example": "128.224.115.34:30022"
1702                 },
1703                 "helmcli_username": {
1704                     "type": "string",
1705                     "description": "Helm CLI SSH login username",
1706                     "example": "helm"
1707                 },
1708                 "helmcli_password": {
1709                     "type": "string",
1710                     "description": "Helm CLI SSH login password",
1711                     "example": "password"
1712                 },
1713                 "helmcli_kubeconfig": {
1714                     "type": "string",
1715                     "description": "Helm CLI KUBECONFIG path",
1716                     "example": "/share/kubeconfig_c765516a.config"
1717                 }
1718             },
1719             "type": "object"
1720         },
1721         "SubscriptionCreateDto": {
1722             "required": [
1723                 "callback"
1724             ],
1725             "properties": {
1726                 "callback": {
1727                     "type": "string",
1728                     "description": "Identifier for the Subscription.",
1729                     "example": "https://128.224.115.15:1081/smo/v1/o2ims_inventory_observer"
1730                 },
1731                 "consumerSubscriptionId": {
1732                     "type": "string",
1733                     "description": "Identifier for the consumer of events sent due to the Subscription.",
1734                     "example": "3F20D850-AF4F-A84F-FB5A-0AD585410361"
1735                 },
1736                 "filter": {
1737                     "type": "string",
1738                     "description": "Criteria for events which do not need to be reported or will be filtered by the subscription notification service. Therefore, if a filter is not provided then all events are reported.",
1739                     "example": ""
1740                 }
1741             },
1742             "type": "object"
1743         },
1744         "SubscriptionGetDto": {
1745             "required": [
1746                 "subscriptionId"
1747             ],
1748             "properties": {
1749                 "subscriptionId": {
1750                     "type": "string",
1751                     "description": "Identifier for the Subscription.",
1752                     "example": "0bea3e71-d2f7-4bf3-9c06-41d8d35806f9"
1753                 },
1754                 "callback": {
1755                     "type": "string",
1756                     "description": "The fully qualified URI to a consumer procedure which can process a Post of the InventoryEventNotification.",
1757                     "example": "https://128.224.115.15:1081/smo/v1/o2ims_inventory_observer"
1758                 },
1759                 "consumerSubscriptionId": {
1760                     "type": "string",
1761                     "description": "Identifier for the consumer of events sent due to the Subscription.",
1762                     "example": "3F20D850-AF4F-A84F-FB5A-0AD585410361"
1763                 },
1764                 "filter": {
1765                     "type": "string",
1766                     "description": "Criteria for events which do not need to be reported or will be filtered by the subscription notification service. Therefore, if a filter is not provided then all events are reported.",
1767                     "example": ""
1768                 }
1769             },
1770             "x-mask": "{subscriptionId,callback}",
1771             "type": "object"
1772         },
1773         "MonitoringAPIVersion": {
1774             "required": [
1775                 "uriPrefix"
1776             ],
1777             "properties": {
1778                 "uriPrefix": {
1779                     "type": "string",
1780                     "description": "Specifies the URI prefix for the API",
1781                     "example": "https://128.224.115.36:30205/o2ims-infrastructureMonitoring"
1782                 },
1783                 "apiVersions": {
1784                     "type": "array",
1785                     "description": "Version(s) supported for the API signaled by the uriPrefix attribute.",
1786                     "example": [
1787                         {
1788                             "version": "1.0.0"
1789                         }
1790                     ],
1791                     "items": {
1792                         "$ref": "#/definitions/MonitoringApiVersionStructure"
1793                     }
1794                 }
1795             },
1796             "x-mask": "{uriPrefix,apiVersions}",
1797             "type": "object"
1798         },
1799         "MonitoringApiVersionStructure": {
1800             "required": [
1801                 "version"
1802             ],
1803             "properties": {
1804                 "version": {
1805                     "type": "string",
1806                     "description": "Identifies a supported version.",
1807                     "example": "1.0.0"
1808                 }
1809             },
1810             "x-mask": "{version}",
1811             "type": "object"
1812         },
1813         "MonitoringV1APIVersion": {
1814             "required": [
1815                 "uriPrefix"
1816             ],
1817             "properties": {
1818                 "uriPrefix": {
1819                     "type": "string",
1820                     "description": "Specifies the URI prefix for the API",
1821                     "example": "https://128.224.115.36:30205/o2ims-infrastructureMonitoring/v1"
1822                 },
1823                 "apiVersions": {
1824                     "type": "array",
1825                     "description": "Version(s) supported for the API signaled by the uriPrefix attribute.",
1826                     "example": [
1827                         {
1828                             "version": "1.0.0"
1829                         }
1830                     ],
1831                     "items": {
1832                         "$ref": "#/definitions/MonitoringV1ApiVersionStructure"
1833                     }
1834                 }
1835             },
1836             "x-mask": "{uriPrefix,apiVersions}",
1837             "type": "object"
1838         },
1839         "MonitoringV1ApiVersionStructure": {
1840             "required": [
1841                 "version"
1842             ],
1843             "properties": {
1844                 "version": {
1845                     "type": "string",
1846                     "description": "Identifies a supported version.",
1847                     "example": "1.0.0"
1848                 }
1849             },
1850             "x-mask": "{version}",
1851             "type": "object"
1852         },
1853         "AlarmGetDto": {
1854             "required": [
1855                 "alarmEventRecordId"
1856             ],
1857             "properties": {
1858                 "alarmEventRecordId": {
1859                     "type": "string",
1860                     "description": "The identifier for the AlarmEventRecord Object.",
1861                     "example": "97cc2b01-0e71-4a93-a911-2e87f04d996f"
1862                 },
1863                 "resourceTypeId": {
1864                     "type": "string",
1865                     "description": "A reference to the type of resource which caused the alarm.",
1866                     "example": "60cba7be-e2cd-3b8c-a7ff-16e0f10573f9"
1867                 },
1868                 "resourceTypeID": {
1869                     "type": "string",
1870                     "description": "A reference to the type of resource which caused the alarm.(Specification)",
1871                     "example": "60cba7be-e2cd-3b8c-a7ff-16e0f10573f9"
1872                 },
1873                 "resourceId": {
1874                     "type": "string",
1875                     "description": "A reference to the resource instance which caused the alarm.",
1876                     "example": "5b3a2da8-17da-466c-b5f7-972590c7baf2"
1877                 },
1878                 "resourceID": {
1879                     "type": "string",
1880                     "description": "A reference to the resource instance which caused the alarm.(Specification)",
1881                     "example": "5b3a2da8-17da-466c-b5f7-972590c7baf2"
1882                 },
1883                 "alarmDefinitionId": {
1884                     "type": "string",
1885                     "description": "A reference to the Alarm Definition record in the Alarm Dictionary associated with the referenced Resource Type.",
1886                     "example": "1197f463-b3d4-3aa3-9c14-faa493baa069"
1887                 },
1888                 "alarmDefinitionID": {
1889                     "type": "string",
1890                     "description": "A reference to the Alarm Definition record in the Alarm Dictionary associated with the referenced Resource Type.(Specification)",
1891                     "example": "1197f463-b3d4-3aa3-9c14-faa493baa069"
1892                 },
1893                 "probableCauseId": {
1894                     "type": "string",
1895                     "description": "A reference to the ProbableCause of the Alarm.",
1896                     "example": "f52054c9-6f3c-39a0-aab8-e00e01d8c4d3"
1897                 },
1898                 "probableCauseID": {
1899                     "type": "string",
1900                     "description": "A reference to the ProbableCause of the Alarm.(Specification)",
1901                     "example": "f52054c9-6f3c-39a0-aab8-e00e01d8c4d3"
1902                 },
1903                 "alarmRaisedTime": {
1904                     "type": "string",
1905                     "description": "Date/Time stamp value when the AlarmEventRecord has been created.",
1906                     "example": "2022-12-22 09:42:53"
1907                 },
1908                 "alarmChangedTime": {
1909                     "type": "string",
1910                     "description": "Date/Time stamp value when any value of the AlarmEventRecord has been modified.",
1911                     "example": ""
1912                 },
1913                 "alarmAcknowledgeTime": {
1914                     "type": "string",
1915                     "description": "Date/Time stamp value when the alarm condition is acknowledged.",
1916                     "example": ""
1917                 },
1918                 "alarmAcknowledged": {
1919                     "type": "boolean",
1920                     "description": "Boolean value indicating of a management system has acknowledged the alarm.",
1921                     "example": false
1922                 },
1923                 "perceivedSeverity": {
1924                     "type": "string",
1925                     "description": "One of the following values: \n 0 for \"CRITICAL\" \n1 for \"MAJOR\" \n2 for \"MINOR\" \n3 for \"WARNING\" \n4 for \"INDETERMINATE\" \n5 for \"CLEARED\"",
1926                     "example": "1"
1927                 },
1928                 "extensions": {
1929                     "type": "object"
1930                 }
1931             },
1932             "type": "object"
1933         },
1934         "AlarmSubscriptionCreateDto": {
1935             "required": [
1936                 "callback"
1937             ],
1938             "properties": {
1939                 "callback": {
1940                     "type": "string",
1941                     "description": "The fully qualified URI to a consumer procedure which can process a Post of the InventoryEventNotification.",
1942                     "example": "https://128.224.115.15:1081/smo/v1/o2ims_alarm_observer"
1943                 },
1944                 "consumerSubscriptionId": {
1945                     "type": "string",
1946                     "description": "Identifier for the consumer of events sent due to the Subscription.",
1947                     "example": "3F20D850-AF4F-A84F-FB5A-0AD585410361"
1948                 },
1949                 "filter": {
1950                     "type": "string",
1951                     "description": "Criteria for events which do not need to be reported or will be filtered by the subscription notification service. Therefore, if a filter is not provided then all events are reported.",
1952                     "example": ""
1953                 }
1954             },
1955             "type": "object"
1956         },
1957         "AlarmSubscriptionGetDto": {
1958             "required": [
1959                 "alarmSubscriptionId"
1960             ],
1961             "properties": {
1962                 "alarmSubscriptionId": {
1963                     "type": "string",
1964                     "description": "Identifier for the Alarm Subscription.",
1965                     "example": "e320da6d-27a8-4948-8b52-3bf3355b45f3"
1966                 },
1967                 "callback": {
1968                     "type": "string",
1969                     "description": "The fully qualified URI to a consumer procedure which can process a Post of the InventoryEventNotification.",
1970                     "example": "https://128.224.115.15:1081/smo/v1/o2ims_alarm_observer"
1971                 },
1972                 "consumerSubscriptionId": {
1973                     "type": "string",
1974                     "description": "Identifier for the consumer of events sent due to the Subscription.",
1975                     "example": "3F20D850-AF4F-A84F-FB5A-0AD585410361"
1976                 },
1977                 "filter": {
1978                     "type": "string",
1979                     "description": "Criteria for events which do not need to be reported or will be filtered by the subscription notification service. Therefore, if a filter is not provided then all events are reported.",
1980                     "example": ""
1981                 }
1982             },
1983             "x-mask": "{alarmSubscriptionId,callback}",
1984             "type": "object"
1985         }
1986     },
1987     "responses": {
1988         "ParseError": {
1989             "description": "When a mask can't be parsed"
1990         },
1991         "MaskError": {
1992             "description": "When any error occurs on mask"
1993         },
1994         "HTTPException": {
1995             "description": "Default error handler"
1996         },
1997         "NotFound": {
1998             "description": "notfound handler"
1999         },
2000         "BadRequestException": {
2001             "description": "Return a custom message and 400 status code"
2002         },
2003         "NotFoundException": {
2004             "description": "Return a custom message and 404 status code"
2005         },
2006         "MethodNotAllowed": {
2007             "description": "Return a custom message and 405 status code"
2008         },
2009         "InternalServerError": {
2010             "description": "Return a custom message and 500 status code"
2011         },
2012         "Exception": {
2013             "description": "Return a custom message and 500 status code"
2014         }
2015     }
2016 }