docs/swagger.yaml

   1 ---
   2 swagger: "2.0"
   3 info:
   4   description: Swagger OpenAPI document for the INF O2 Services
   5   version: 1.0.0
   6   title: INF O2 Services API
   7 basePath: /
   8 tags:
   9 - name: O2IMS_Inventory
  10   description: IMS Inventory related operations.
  11 - name: O2IMS_InfrastructureMonitoring
  12   description: O2 IMS Monitoring related operations.
  13 consumes:
  14 - application/json
  15 produces:
  16 - application/json
  17 paths:
  18   /o2ims-infrastructureInventory/api_versions:
  19     get:
  20       tags:
  21       - O2IMS_Inventory
  22       operationId: get_inventory_version
  23       parameters: []
  24       responses:
  25         "200":
  26           description: Success
  27   /o2ims-infrastructureInventory/v1:
  28     get:
  29       tags:
  30       - O2IMS_Inventory
  31       operationId: get_oclouds_list_router
  32       parameters:
  33       - name: exclude_default
  34         in: query
  35         description: "Exclude showing all default fields, Set \"true\" to enable."
  36         required: false
  37         type: string
  38       - name: exclude_fields
  39         in: query
  40         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
  41         required: false
  42         type: string
  43       - name: fields
  44         in: query
  45         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
  46         required: false
  47         type: string
  48       - name: all_fields
  49         in: query
  50         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
  51         required: false
  52         type: string
  53       responses:
  54         "200":
  55           description: Success
  56           schema:
  57             $ref: '#/definitions/OcloudDto'
  58         "404":
  59           description: oCloud not found
  60   /o2ims-infrastructureInventory/v1/:
  61     get:
  62       tags:
  63       - O2IMS_Inventory
  64       operationId: get_oclouds_list_router
  65       parameters:
  66       - name: exclude_default
  67         in: query
  68         description: "Exclude showing all default fields, Set \"true\" to enable."
  69         required: false
  70         type: string
  71       - name: exclude_fields
  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         required: false
  75         type: string
  76       - name: fields
  77         in: query
  78         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
  79         required: false
  80         type: string
  81       - name: all_fields
  82         in: query
  83         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
  84         required: false
  85         type: string
  86       responses:
  87         "200":
  88           description: Success
  89           schema:
  90             $ref: '#/definitions/OcloudDto'
  91         "404":
  92           description: oCloud not found
  93   /o2ims-infrastructureInventory/v1/api_versions:
  94     get:
  95       tags:
  96       - O2IMS_Inventory
  97       operationId: get_version_router
  98       parameters: []
  99       responses:
 100         "200":
 101           description: Success
 102   /o2ims-infrastructureInventory/v1/deploymentManagers:
 103     get:
 104       tags:
 105       - O2IMS_Inventory
 106       operationId: get_deployment_managers_list_router
 107       parameters:
 108       - name: filter
 109         in: query
 110         description: Filter of the query.
 111         required: false
 112         type: string
 113       - name: exclude_default
 114         in: query
 115         description: "Exclude showing all default fields, Set \"true\" to enable."
 116         required: false
 117         type: string
 118       - name: exclude_fields
 119         in: query
 120         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
 121         required: false
 122         type: string
 123       - name: fields
 124         in: query
 125         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
 126         required: false
 127         type: string
 128       - name: all_fields
 129         in: query
 130         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
 131         required: false
 132         type: string
 133       - name: nextpage_opaque_marker
 134         in: query
 135         description: "Page number of the results to fetch. Default: 1"
 136         required: false
 137         type: string
 138         default: "1"
 139       responses:
 140         "200":
 141           description: Success
 142           schema:
 143             type: array
 144             items:
 145               $ref: '#/definitions/DeploymentManagerListDto'
 146   /o2ims-infrastructureInventory/v1/deploymentManagers/{deploymentManagerID}:
 147     get:
 148       tags:
 149       - O2IMS_Inventory
 150       operationId: Get deployment manager
 151       parameters:
 152       - name: exclude_default
 153         in: query
 154         description: "Exclude showing all default fields, Set \"true\" to enable."
 155         required: false
 156         type: string
 157       - name: exclude_fields
 158         in: query
 159         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
 160         required: false
 161         type: string
 162       - name: fields
 163         in: query
 164         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
 165         required: false
 166         type: string
 167       - name: all_fields
 168         in: query
 169         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
 170         required: false
 171         type: string
 172       - name: profile
 173         in: query
 174         description: "DMS profile: value supports \"native_k8sapi\""
 175         required: false
 176         type: string
 177       - name: deploymentManagerID
 178         in: path
 179         description: ID of the deployment manager
 180         required: true
 181         type: string
 182       responses:
 183         "200":
 184           description: Success
 185           schema:
 186             $ref: '#/definitions/DeploymentManagerGetDto'
 187         "404":
 188           description: Deployment manager not found
 189   /o2ims-infrastructureInventory/v1/resourcePools:
 190     get:
 191       tags:
 192       - O2IMS_Inventory
 193       operationId: get_resource_pools_list_router
 194       parameters:
 195       - name: filter
 196         in: query
 197         description: Filter of the query.
 198         required: false
 199         type: string
 200       - name: exclude_default
 201         in: query
 202         description: "Exclude showing all default fields, Set \"true\" to enable."
 203         required: false
 204         type: string
 205       - name: exclude_fields
 206         in: query
 207         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
 208         required: false
 209         type: string
 210       - name: fields
 211         in: query
 212         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
 213         required: false
 214         type: string
 215       - name: all_fields
 216         in: query
 217         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
 218         required: false
 219         type: string
 220       - name: nextpage_opaque_marker
 221         in: query
 222         description: "Page number of the results to fetch. Default: 1"
 223         required: false
 224         type: string
 225         default: "1"
 226       responses:
 227         "200":
 228           description: Success
 229           schema:
 230             type: array
 231             items:
 232               $ref: '#/definitions/ResourcePoolGetDto'
 233   /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}:
 234     get:
 235       tags:
 236       - O2IMS_Inventory
 237       operationId: Get resource pool
 238       parameters:
 239       - name: exclude_default
 240         in: query
 241         description: "Exclude showing all default fields, Set \"true\" to enable."
 242         required: false
 243         type: string
 244       - name: exclude_fields
 245         in: query
 246         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
 247         required: false
 248         type: string
 249       - name: fields
 250         in: query
 251         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
 252         required: false
 253         type: string
 254       - name: all_fields
 255         in: query
 256         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
 257         required: false
 258         type: string
 259       - name: resourcePoolID
 260         in: path
 261         description: ID of the resource pool
 262         required: true
 263         type: string
 264       responses:
 265         "200":
 266           description: Success
 267           schema:
 268             $ref: '#/definitions/ResourcePoolGetDto'
 269         "404":
 270           description: Resource pool not found
 271   /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources:
 272     get:
 273       tags:
 274       - O2IMS_Inventory
 275       operationId: get_resources_list_router
 276       parameters:
 277       - name: filter
 278         in: query
 279         description: Filter of the query.
 280         required: false
 281         type: string
 282       - name: exclude_default
 283         in: query
 284         description: "Exclude showing all default fields, Set \"true\" to enable."
 285         required: false
 286         type: string
 287       - name: exclude_fields
 288         in: query
 289         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
 290         required: false
 291         type: string
 292       - name: fields
 293         in: query
 294         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
 295         required: false
 296         type: string
 297       - name: all_fields
 298         in: query
 299         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
 300         required: false
 301         type: string
 302       - name: nextpage_opaque_marker
 303         in: query
 304         description: "Page number of the results to fetch. Default: 1"
 305         required: false
 306         type: string
 307         default: "1"
 308       - name: resourcePoolID
 309         in: path
 310         description: ID of the resource pool
 311         required: true
 312         type: string
 313       responses:
 314         "200":
 315           description: Success
 316           schema:
 317             type: array
 318             items:
 319               $ref: '#/definitions/ResourceListDto'
 320         "404":
 321           description: Resource pool not found
 322   /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}:
 323     get:
 324       tags:
 325       - O2IMS_Inventory
 326       operationId: Get resource
 327       parameters:
 328       - name: exclude_default
 329         in: query
 330         description: "Exclude showing all default fields, Set \"true\" to enable."
 331         required: false
 332         type: string
 333       - name: exclude_fields
 334         in: query
 335         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
 336         required: false
 337         type: string
 338       - name: fields
 339         in: query
 340         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
 341         required: false
 342         type: string
 343       - name: all_fields
 344         in: query
 345         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
 346         required: false
 347         type: string
 348       - name: resourceID
 349         in: path
 350         description: ID of the resource
 351         required: true
 352         type: string
 353       - name: resourcePoolID
 354         in: path
 355         description: ID of the resource pool
 356         required: true
 357         type: string
 358       responses:
 359         "200":
 360           description: Success
 361           schema:
 362             $ref: '#/definitions/ResourceGetDto2'
 363         "404":
 364           description: Resource not found
 365   /o2ims-infrastructureInventory/v1/resourceTypes:
 366     get:
 367       tags:
 368       - O2IMS_Inventory
 369       operationId: get_resource_types_list_router
 370       parameters:
 371       - name: filter
 372         in: query
 373         description: Filter of the query.
 374         required: false
 375         type: string
 376       - name: exclude_default
 377         in: query
 378         description: "Exclude showing all default fields, Set \"true\" to enable."
 379         required: false
 380         type: string
 381       - name: exclude_fields
 382         in: query
 383         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
 384         required: false
 385         type: string
 386       - name: fields
 387         in: query
 388         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
 389         required: false
 390         type: string
 391       - name: all_fields
 392         in: query
 393         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
 394         required: false
 395         type: string
 396       - name: nextpage_opaque_marker
 397         in: query
 398         description: "Page number of the results to fetch. Default: 1"
 399         required: false
 400         type: string
 401         default: "1"
 402       responses:
 403         "200":
 404           description: Success
 405           schema:
 406             type: array
 407             items:
 408               $ref: '#/definitions/ResourceTypeGetDto'
 409   /o2ims-infrastructureInventory/v1/resourceTypes/{resourceTypeID}:
 410     get:
 411       tags:
 412       - O2IMS_Inventory
 413       operationId: Get resource type
 414       parameters:
 415       - name: exclude_default
 416         in: query
 417         description: "Exclude showing all default fields, Set \"true\" to enable."
 418         required: false
 419         type: string
 420       - name: exclude_fields
 421         in: query
 422         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
 423         required: false
 424         type: string
 425       - name: fields
 426         in: query
 427         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
 428         required: false
 429         type: string
 430       - name: all_fields
 431         in: query
 432         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
 433         required: false
 434         type: string
 435       - name: resourceTypeID
 436         in: path
 437         description: ID of the resource type
 438         required: true
 439         type: string
 440       responses:
 441         "200":
 442           description: Success
 443           schema:
 444             $ref: '#/definitions/ResourceTypeGetDto'
 445         "404":
 446           description: Resource type not found
 447   /o2ims-infrastructureInventory/v1/subscriptions:
 448     get:
 449       tags:
 450       - O2IMS_Inventory
 451       operationId: List subscriptions
 452       parameters:
 453       - name: filter
 454         in: query
 455         description: Filter of the query.
 456         required: false
 457         type: string
 458       - name: exclude_default
 459         in: query
 460         description: "Exclude showing all default fields, Set \"true\" to enable."
 461         required: false
 462         type: string
 463       - name: exclude_fields
 464         in: query
 465         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
 466         required: false
 467         type: string
 468       - name: fields
 469         in: query
 470         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
 471         required: false
 472         type: string
 473       - name: all_fields
 474         in: query
 475         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
 476         required: false
 477         type: string
 478       - name: nextpage_opaque_marker
 479         in: query
 480         description: "Page number of the results to fetch. Default: 1"
 481         required: false
 482         type: string
 483         default: "1"
 484       responses:
 485         "200":
 486           description: Success
 487           schema:
 488             type: array
 489             items:
 490               $ref: '#/definitions/SubscriptionGetDto'
 491     post:
 492       tags:
 493       - O2IMS_Inventory
 494       operationId: Create a subscription
 495       parameters:
 496       - in: body
 497         name: payload
 498         required: true
 499         schema:
 500           $ref: '#/definitions/SubscriptionCreateDto'
 501       responses:
 502         "201":
 503           description: Success
 504           schema:
 505             $ref: '#/definitions/SubscriptionGetDto'
 506   /o2ims-infrastructureInventory/v1/subscriptions/{subscriptionID}:
 507     get:
 508       tags:
 509       - O2IMS_Inventory
 510       operationId: Get subscription by ID
 511       parameters:
 512       - name: subscriptionID
 513         in: path
 514         description: ID of the subscription
 515         required: true
 516         type: string
 517       - name: exclude_default
 518         in: query
 519         description: "Exclude showing all default fields, Set \"true\" to enable."
 520         required: false
 521         type: string
 522       - name: exclude_fields
 523         in: query
 524         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
 525         required: false
 526         type: string
 527       - name: fields
 528         in: query
 529         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
 530         required: false
 531         type: string
 532       - name: all_fields
 533         in: query
 534         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
 535         required: false
 536         type: string
 537       responses:
 538         "200":
 539           description: Success
 540           schema:
 541             $ref: '#/definitions/SubscriptionGetDto'
 542         "404":
 543           description: Subscription not found
 544     delete:
 545       tags:
 546       - O2IMS_Inventory
 547       operationId: Delete subscription by ID
 548       parameters:
 549       - name: subscriptionID
 550         in: path
 551         description: ID of the subscription
 552         required: true
 553         type: string
 554       responses:
 555         "200":
 556           description: Subscription deleted
 557         "404":
 558           description: Subscription not found
 559   /o2ims-infrastructureMonitoring/api_versions:
 560     get:
 561       tags:
 562       - O2IMS_InfrastructureMonitoring
 563       operationId: get_monitoring_version
 564       parameters: []
 565       responses:
 566         "200":
 567           description: Success
 568   /o2ims-infrastructureMonitoring/v1/alarmSubscriptions:
 569     get:
 570       tags:
 571       - O2IMS_InfrastructureMonitoring
 572       operationId: List alarm subscriptions
 573       parameters:
 574       - name: filter
 575         in: query
 576         description: Filter of the query.
 577         required: false
 578         type: string
 579       - name: exclude_default
 580         in: query
 581         description: "Exclude showing all default fields, Set \"true\" to enable."
 582         required: false
 583         type: string
 584       - name: exclude_fields
 585         in: query
 586         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
 587         required: false
 588         type: string
 589       - name: fields
 590         in: query
 591         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
 592         required: false
 593         type: string
 594       - name: all_fields
 595         in: query
 596         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
 597         required: false
 598         type: string
 599       - name: nextpage_opaque_marker
 600         in: query
 601         description: "Page number of the results to fetch. Default: 1"
 602         required: false
 603         type: string
 604         default: "1"
 605       responses:
 606         "200":
 607           description: Success
 608           schema:
 609             type: array
 610             items:
 611               $ref: '#/definitions/AlarmSubscriptionGetDto'
 612     post:
 613       tags:
 614       - O2IMS_InfrastructureMonitoring
 615       operationId: Create a alarm subscription
 616       parameters:
 617       - in: body
 618         name: payload
 619         required: true
 620         schema:
 621           $ref: '#/definitions/AlarmSubscriptionCreateDto'
 622       responses:
 623         "201":
 624           description: Success
 625           schema:
 626             $ref: '#/definitions/AlarmSubscriptionGetDto'
 627   /o2ims-infrastructureMonitoring/v1/alarmSubscriptions/{alarmSubscriptionID}:
 628     get:
 629       tags:
 630       - O2IMS_InfrastructureMonitoring
 631       operationId: Get Alarm Subscription by ID
 632       parameters:
 633       - name: alarmSubscriptionID
 634         in: path
 635         description: ID of the Alarm Subscription
 636         required: true
 637         type: string
 638       - name: exclude_default
 639         in: query
 640         description: "Exclude showing all default fields, Set \"true\" to enable."
 641         required: false
 642         type: string
 643       - name: exclude_fields
 644         in: query
 645         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
 646         required: false
 647         type: string
 648       - name: fields
 649         in: query
 650         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
 651         required: false
 652         type: string
 653       - name: all_fields
 654         in: query
 655         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
 656         required: false
 657         type: string
 658       responses:
 659         "200":
 660           description: Success
 661           schema:
 662             $ref: '#/definitions/AlarmSubscriptionGetDto'
 663         "404":
 664           description: Alarm Subscription not found
 665     delete:
 666       tags:
 667       - O2IMS_InfrastructureMonitoring
 668       operationId: Delete subscription by ID
 669       parameters:
 670       - name: alarmSubscriptionID
 671         in: path
 672         description: ID of the Alarm Subscription
 673         required: true
 674         type: string
 675       responses:
 676         "200":
 677           description: Subscription deleted
 678         "404":
 679           description: Alarm Subscription not found
 680   /o2ims-infrastructureMonitoring/v1/alarms:
 681     get:
 682       tags:
 683       - O2IMS_InfrastructureMonitoring
 684       operationId: get_alarm_list_router
 685       parameters:
 686       - name: filter
 687         in: query
 688         description: Filter of the query.
 689         required: false
 690         type: string
 691       - name: exclude_default
 692         in: query
 693         description: "Exclude showing all default fields, Set \"true\" to enable."
 694         required: false
 695         type: string
 696       - name: exclude_fields
 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         required: false
 700         type: string
 701       - name: fields
 702         in: query
 703         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
 704         required: false
 705         type: string
 706       - name: all_fields
 707         in: query
 708         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
 709         required: false
 710         type: string
 711       - name: nextpage_opaque_marker
 712         in: query
 713         description: "Page number of the results to fetch. Default: 1"
 714         required: false
 715         type: string
 716         default: "1"
 717       responses:
 718         "200":
 719           description: Success
 720           schema:
 721             type: array
 722             items:
 723               $ref: '#/definitions/AlarmGetDto'
 724   /o2ims-infrastructureMonitoring/v1/alarms/{alarmEventRecordId}:
 725     get:
 726       tags:
 727       - O2IMS_InfrastructureMonitoring
 728       operationId: Get AlarmEventRecord
 729       parameters:
 730       - name: exclude_default
 731         in: query
 732         description: "Exclude showing all default fields, Set \"true\" to enable."
 733         required: false
 734         type: string
 735       - name: exclude_fields
 736         in: query
 737         description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
 738         required: false
 739         type: string
 740       - name: fields
 741         in: query
 742         description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
 743         required: false
 744         type: string
 745       - name: all_fields
 746         in: query
 747         description: Set any value for show all fields. This value will cover "fields" and "all_fields".
 748         required: false
 749         type: string
 750       - name: alarmEventRecordId
 751         in: path
 752         description: ID of the alarm event record
 753         required: true
 754         type: string
 755       responses:
 756         "200":
 757           description: Success
 758           schema:
 759             $ref: '#/definitions/AlarmGetDto'
 760         "404":
 761           description: Alarm Event Record not found
 762   /o2ims-infrastructureMonitoring/v1/api_versions:
 763     get:
 764       tags:
 765       - O2IMS_InfrastructureMonitoring
 766       operationId: get_version_router
 767       parameters: []
 768       responses:
 769         "200":
 770           description: Success
 771 definitions:
 772   OcloudDto:
 773     type: object
 774     required:
 775     - oCloudId
 776     properties:
 777       oCloudId:
 778         type: string
 779       globalCloudId:
 780         type: string
 781       globalcloudId:
 782         type: string
 783       name:
 784         type: string
 785       description:
 786         type: string
 787       serviceUri:
 788         type: string
 789       extensions:
 790         type: string
 791     x-mask: "{oCloudId,globalCloudId,globalcloudId,name,description,serviceUri}"
 792   ResourceTypeGetDto:
 793     type: object
 794     required:
 795     - resourceTypeId
 796     properties:
 797       resourceTypeId:
 798         type: string
 799         description: Resource type ID
 800       name:
 801         type: string
 802       description:
 803         type: string
 804       vendor:
 805         type: string
 806       model:
 807         type: string
 808       version:
 809         type: string
 810       alarmDictionary:
 811         $ref: '#/definitions/AlarmDictionaryDto'
 812       extensions:
 813         type: string
 814     x-mask: "{resourceTypeId,name,description,model,vendor,version}"
 815   AlarmDictionaryDto:
 816     type: object
 817     properties:
 818       id:
 819         type: string
 820       alarmDictionaryVersion:
 821         type: string
 822       alarmDictionarySchemaVersion:
 823         type: string
 824       entityType:
 825         type: string
 826       vendor:
 827         type: string
 828       managementInterfaceId:
 829         type: string
 830       pkNotificationField:
 831         type: string
 832       alarmDefinition:
 833         type: array
 834         items:
 835           $ref: '#/definitions/AlarmDefinitionDto'
 836   AlarmDefinitionDto:
 837     type: object
 838     properties:
 839       alarmDefinitionId:
 840         type: string
 841       alarmName:
 842         type: string
 843       alarmLastChange:
 844         type: string
 845       alarmChangeType:
 846         type: string
 847       alarmDescription:
 848         type: string
 849       proposedRepairActions:
 850         type: string
 851       clearingType:
 852         type: string
 853       managementInterfaceId:
 854         type: string
 855       pkNotificationField:
 856         type: string
 857       alarmAdditionalFields:
 858         type: string
 859   ResourcePoolGetDto:
 860     type: object
 861     required:
 862     - resourcePoolId
 863     properties:
 864       resourcePoolId:
 865         type: string
 866         description: Resource pool ID
 867       globalLocationId:
 868         type: string
 869       name:
 870         type: string
 871       description:
 872         type: string
 873       oCloudId:
 874         type: string
 875       location:
 876         type: string
 877       extensions:
 878         type: string
 879     x-mask: "{resourcePoolId,oCloudId,globalLocationId,name,description}"
 880   ResourceListDto:
 881     type: object
 882     required:
 883     - resourceId
 884     properties:
 885       resourceId:
 886         type: string
 887         description: Resource ID
 888       resourceTypeId:
 889         type: string
 890       resourcePoolId:
 891         type: string
 892       globalAssetId:
 893         type: string
 894       parentId:
 895         type: string
 896       description:
 897         type: string
 898       extensions:
 899         type: object
 900         properties: {}
 901     x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
 902   ResourceGetDto2:
 903     type: object
 904     required:
 905     - resourceId
 906     properties:
 907       resourceId:
 908         type: string
 909         description: Resource ID
 910       resourceTypeId:
 911         type: string
 912       resourcePoolId:
 913         type: string
 914       globalAssetId:
 915         type: string
 916       parentId:
 917         type: string
 918       description:
 919         type: string
 920       extensions:
 921         type: object
 922         properties: {}
 923       elements:
 924         type: array
 925         items:
 926           $ref: '#/definitions/ResourceGetDto1'
 927     x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
 928   ResourceGetDto1:
 929     type: object
 930     required:
 931     - resourceId
 932     properties:
 933       resourceId:
 934         type: string
 935         description: Resource ID
 936       resourceTypeId:
 937         type: string
 938       resourcePoolId:
 939         type: string
 940       globalAssetId:
 941         type: string
 942       parentId:
 943         type: string
 944       description:
 945         type: string
 946       extensions:
 947         type: object
 948         properties: {}
 949       elements:
 950         type: array
 951         items:
 952           $ref: '#/definitions/ResourceGetDto0'
 953     x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
 954   ResourceGetDto0:
 955     type: object
 956     required:
 957     - resourceId
 958     properties:
 959       resourceId:
 960         type: string
 961         description: Resource ID
 962       resourceTypeId:
 963         type: string
 964       resourcePoolId:
 965         type: string
 966       globalAssetId:
 967         type: string
 968       parentId:
 969         type: string
 970       description:
 971         type: string
 972       extensions:
 973         type: object
 974         properties: {}
 975     x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
 976   DeploymentManagerListDto:
 977     type: object
 978     required:
 979     - deploymentManagerId
 980     properties:
 981       deploymentManagerId:
 982         type: string
 983         description: Deployment manager ID
 984       name:
 985         type: string
 986       description:
 987         type: string
 988       oCloudId:
 989         type: string
 990       serviceUri:
 991         type: string
 992       profileSupportList:
 993         type: array
 994         description: "Profile support list, use default for the return                      endpoint"
 995         items:
 996           type: string
 997       extensions:
 998         type: string
 999     x-mask: "{deploymentManagerId,name,description,oCloudId,serviceUri,profileSupportList}"
1000   DeploymentManagerGetDto:
1001     type: object
1002     required:
1003     - deploymentManagerId
1004     properties:
1005       deploymentManagerId:
1006         type: string
1007         description: Deployment manager ID
1008       name:
1009         type: string
1010       description:
1011         type: string
1012       oCloudId:
1013         type: string
1014       serviceUri:
1015         type: string
1016       extensions:
1017         $ref: '#/definitions/DeploymentManagerExtensions'
1018     x-mask: "{deploymentManagerId,name,description,oCloudId,serviceUri,extensions,profileName,profileData}"
1019   DeploymentManagerExtensions:
1020     type: object
1021     properties:
1022       profileName:
1023         type: string
1024       profileData:
1025         $ref: '#/definitions/DeploymentManagerGetDtoProfile'
1026   DeploymentManagerGetDtoProfile:
1027     type: object
1028     properties:
1029       cluster_api_endpoint:
1030         type: string
1031       cluster_ca_cert:
1032         type: string
1033       admin_user:
1034         type: string
1035       admin_client_cert:
1036         type: string
1037       admin_client_key:
1038         type: string
1039       helmcli_host_with_port:
1040         type: string
1041       helmcli_username:
1042         type: string
1043       helmcli_password:
1044         type: string
1045       helmcli_kubeconfig:
1046         type: string
1047   SubscriptionCreateDto:
1048     type: object
1049     required:
1050     - callback
1051     properties:
1052       callback:
1053         type: string
1054         description: Subscription callback address
1055       consumerSubscriptionId:
1056         type: string
1057       filter:
1058         type: string
1059   SubscriptionGetDto:
1060     type: object
1061     required:
1062     - subscriptionId
1063     properties:
1064       subscriptionId:
1065         type: string
1066         description: Subscription ID
1067       callback:
1068         type: string
1069       consumerSubscriptionId:
1070         type: string
1071       filter:
1072         type: string
1073     x-mask: "{subscriptionId,callback}"
1074   AlarmGetDto:
1075     type: object
1076     required:
1077     - alarmEventRecordId
1078     properties:
1079       alarmEventRecordId:
1080         type: string
1081         description: Alarm Event Record ID
1082       resourceTypeId:
1083         type: string
1084       resourceTypeID:
1085         type: string
1086       resourceId:
1087         type: string
1088       resourceID:
1089         type: string
1090       alarmDefinitionId:
1091         type: string
1092       alarmDefinitionID:
1093         type: string
1094       probableCauseId:
1095         type: string
1096       probableCauseID:
1097         type: string
1098       alarmRaisedTime:
1099         type: string
1100       alarmChangedTime:
1101         type: string
1102       alarmAcknowledgeTime:
1103         type: string
1104       alarmAcknowledged:
1105         type: boolean
1106       perceivedSeverity:
1107         type: string
1108       extensions:
1109         type: object
1110         properties: {}
1111   AlarmSubscriptionCreateDto:
1112     type: object
1113     required:
1114     - callback
1115     properties:
1116       callback:
1117         type: string
1118         description: Alarm Subscription callback address
1119       consumerSubscriptionId:
1120         type: string
1121       filter:
1122         type: string
1123   AlarmSubscriptionGetDto:
1124     type: object
1125     required:
1126     - alarmSubscriptionId
1127     properties:
1128       alarmSubscriptionId:
1129         type: string
1130         description: Alarm Subscription ID
1131       callback:
1132         type: string
1133       consumerSubscriptionId:
1134         type: string
1135       filter:
1136         type: string
1137     x-mask: "{alarmSubscriptionId,callback}"
1138 responses:
1139   ParseError:
1140     description: When a mask can't be parsed
1141   MaskError:
1142     description: When any error occurs on mask
1143   HTTPException:
1144     description: Default error handler
1145   NotFound:
1146     description: notfound handler
1147   BadRequestException:
1148     description: Return a custom message and 400 status code
1149   NotFoundException:
1150     description: Return a custom message and 404 status code
1151   MethodNotAllowed:
1152     description: Return a custom message and 405 status code
1153   InternalServerError:
1154     description: Return a custom message and 500 status code
1155   Exception:
1156     description: Return a custom message and 500 status code