docs/swagger.json

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