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-InfrastructureInventory
  10   description: O2 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-InfrastructureInventory
  22       operationId: Get Inventory Version
  23       parameters: []
  24       responses:
  25         "200":
  26           description: Success
  27   /o2ims-infrastructureInventory/v1:
  28     get:
  29       tags:
  30       - O2IMS-InfrastructureInventory
  31       operationId: Get Ocloud Information
  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-InfrastructureInventory
  64       operationId: Get Ocloud Information
  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-InfrastructureInventory
  97       operationId: Get Inventory API version
  98       parameters: []
  99       responses:
 100         "200":
 101           description: Success
 102   /o2ims-infrastructureInventory/v1/deploymentManagers:
 103     get:
 104       tags:
 105       - O2IMS-InfrastructureInventory
 106       operationId: Get Deployment Manager List
 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-InfrastructureInventory
 150       operationId: Get Deployment Manager Information
 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-InfrastructureInventory
 193       operationId: Get Resource Pool List
 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-InfrastructureInventory
 237       operationId: Get Resource Pool Information
 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-InfrastructureInventory
 275       operationId: Get Resource List
 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-InfrastructureInventory
 326       operationId: Get Resource Information
 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-InfrastructureInventory
 369       operationId: Get Resource Type List
 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-InfrastructureInventory
 413       operationId: Get Resource Type Information
 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-InfrastructureInventory
 451       operationId: Get Subscription List
 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-InfrastructureInventory
 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-InfrastructureInventory
 510       operationId: Get Subscription Information
 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-InfrastructureInventory
 547       operationId: Delete a Subscription
 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: Get Alarm Subscription List
 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 Information
 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 an Alarm Subscription
 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 Event Record List
 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 Alarm Event Record Information
 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 Monitoring API version
 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         example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
 780         description: Identifier for the containing O-Cloud.
 781       globalCloudId:
 782         type: string
 783         example: 10a07219-4201-4b3e-a52d-81ab6a755d8a
 784         description: Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.
 785       globalcloudId:
 786         type: string
 787         example: 10a07219-4201-4b3e-a52d-81ab6a755d8a
 788         description: Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.(Specification)
 789       name:
 790         type: string
 791         example: 95b818b8-b315-4d9f-af37-b82c492101f1
 792         description: Human readable name of the O-Cloud.
 793       description:
 794         type: string
 795         example: An ocloud
 796         description: Human readable description of the O-Cloud.
 797       serviceUri:
 798         type: string
 799         example: https://128.224.115.51:30205
 800         description: The fully qualified URI root to all services provided by the O2ims interface
 801       extensions:
 802         type: string
 803         example: ""
 804         description: These are unspecified (not standardized) properties (keys) which are tailored by the vendor to extend the information provided about the O-Cloud.
 805     x-mask: "{oCloudId,globalCloudId,globalcloudId,name,description,serviceUri}"
 806   ResourceTypeGetDto:
 807     type: object
 808     required:
 809     - resourceTypeId
 810     properties:
 811       resourceTypeId:
 812         type: string
 813         description: Resource type ID
 814       name:
 815         type: string
 816       description:
 817         type: string
 818       vendor:
 819         type: string
 820       model:
 821         type: string
 822       version:
 823         type: string
 824       alarmDictionary:
 825         $ref: '#/definitions/AlarmDictionaryDto'
 826       extensions:
 827         type: string
 828     x-mask: "{resourceTypeId,name,description,model,vendor,version}"
 829   AlarmDictionaryDto:
 830     type: object
 831     properties:
 832       id:
 833         type: string
 834       alarmDictionaryVersion:
 835         type: string
 836       alarmDictionarySchemaVersion:
 837         type: string
 838       entityType:
 839         type: string
 840       vendor:
 841         type: string
 842       managementInterfaceId:
 843         type: string
 844       pkNotificationField:
 845         type: string
 846       alarmDefinition:
 847         type: array
 848         items:
 849           $ref: '#/definitions/AlarmDefinitionDto'
 850   AlarmDefinitionDto:
 851     type: object
 852     properties:
 853       alarmDefinitionId:
 854         type: string
 855       alarmName:
 856         type: string
 857       alarmLastChange:
 858         type: string
 859       alarmChangeType:
 860         type: string
 861       alarmDescription:
 862         type: string
 863       proposedRepairActions:
 864         type: string
 865       clearingType:
 866         type: string
 867       managementInterfaceId:
 868         type: string
 869       pkNotificationField:
 870         type: string
 871       alarmAdditionalFields:
 872         type: string
 873   ResourcePoolGetDto:
 874     type: object
 875     required:
 876     - resourcePoolId
 877     properties:
 878       resourcePoolId:
 879         type: string
 880         example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
 881         description: Identifier for the Resource Pool in the O-Cloud instance.
 882       globalLocationId:
 883         type: string
 884         example: ""
 885         description: This identifier is copied from the O-Cloud Id assigned by the SMO during the O-Cloud deployment.
 886       name:
 887         type: string
 888         example: RegionOne
 889         description: Human readable name of the resource pool.
 890       description:
 891         type: string
 892         example: A Resource Pool
 893         description: Human readable description of the resource pool.
 894       oCloudId:
 895         type: string
 896         example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
 897         description: Identifier for the containing O-Cloud.
 898       location:
 899         type: string
 900         example: ""
 901         description: Information about the geographical location of the resource pool as detected by the O-Cloud.
 902       extensions:
 903         type: string
 904         example: ""
 905         description: List of metadata key-value pairs used to associate meaningful metadata to the related resource pool.
 906     x-mask: "{resourcePoolId,oCloudId,globalLocationId,name,description}"
 907   ResourceListDto:
 908     type: object
 909     required:
 910     - resourceId
 911     properties:
 912       resourceId:
 913         type: string
 914         description: Resource ID
 915       resourceTypeId:
 916         type: string
 917       resourcePoolId:
 918         type: string
 919       globalAssetId:
 920         type: string
 921       parentId:
 922         type: string
 923       description:
 924         type: string
 925       extensions:
 926         type: object
 927         properties: {}
 928     x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
 929   ResourceGetDto2:
 930     type: object
 931     required:
 932     - resourceId
 933     properties:
 934       resourceId:
 935         type: string
 936         description: Resource ID
 937       resourceTypeId:
 938         type: string
 939       resourcePoolId:
 940         type: string
 941       globalAssetId:
 942         type: string
 943       parentId:
 944         type: string
 945       description:
 946         type: string
 947       extensions:
 948         type: object
 949         properties: {}
 950       elements:
 951         type: array
 952         items:
 953           $ref: '#/definitions/ResourceGetDto1'
 954     x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
 955   ResourceGetDto1:
 956     type: object
 957     required:
 958     - resourceId
 959     properties:
 960       resourceId:
 961         type: string
 962         description: Resource ID
 963       resourceTypeId:
 964         type: string
 965       resourcePoolId:
 966         type: string
 967       globalAssetId:
 968         type: string
 969       parentId:
 970         type: string
 971       description:
 972         type: string
 973       extensions:
 974         type: object
 975         properties: {}
 976       elements:
 977         type: array
 978         items:
 979           $ref: '#/definitions/ResourceGetDto0'
 980     x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
 981   ResourceGetDto0:
 982     type: object
 983     required:
 984     - resourceId
 985     properties:
 986       resourceId:
 987         type: string
 988         description: Resource ID
 989       resourceTypeId:
 990         type: string
 991       resourcePoolId:
 992         type: string
 993       globalAssetId:
 994         type: string
 995       parentId:
 996         type: string
 997       description:
 998         type: string
 999       extensions:
1000         type: object
1001         properties: {}
1002     x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
1003   DeploymentManagerListDto:
1004     type: object
1005     required:
1006     - deploymentManagerId
1007     properties:
1008       deploymentManagerId:
1009         type: string
1010         description: Deployment manager ID
1011       name:
1012         type: string
1013       description:
1014         type: string
1015       oCloudId:
1016         type: string
1017       serviceUri:
1018         type: string
1019       profileSupportList:
1020         type: array
1021         description: "Profile support list, use default for the return                      endpoint"
1022         items:
1023           type: string
1024       extensions:
1025         type: string
1026     x-mask: "{deploymentManagerId,name,description,oCloudId,serviceUri,profileSupportList}"
1027   DeploymentManagerGetDto:
1028     type: object
1029     required:
1030     - deploymentManagerId
1031     properties:
1032       deploymentManagerId:
1033         type: string
1034         description: Deployment manager ID
1035       name:
1036         type: string
1037       description:
1038         type: string
1039       oCloudId:
1040         type: string
1041       serviceUri:
1042         type: string
1043       extensions:
1044         $ref: '#/definitions/DeploymentManagerExtensions'
1045     x-mask: "{deploymentManagerId,name,description,oCloudId,serviceUri,extensions,profileName,profileData}"
1046   DeploymentManagerExtensions:
1047     type: object
1048     properties:
1049       profileName:
1050         type: string
1051       profileData:
1052         $ref: '#/definitions/DeploymentManagerGetDtoProfile'
1053   DeploymentManagerGetDtoProfile:
1054     type: object
1055     properties:
1056       cluster_api_endpoint:
1057         type: string
1058       cluster_ca_cert:
1059         type: string
1060       admin_user:
1061         type: string
1062       admin_client_cert:
1063         type: string
1064       admin_client_key:
1065         type: string
1066       helmcli_host_with_port:
1067         type: string
1068       helmcli_username:
1069         type: string
1070       helmcli_password:
1071         type: string
1072       helmcli_kubeconfig:
1073         type: string
1074   SubscriptionCreateDto:
1075     type: object
1076     required:
1077     - callback
1078     properties:
1079       callback:
1080         type: string
1081         description: Subscription callback address
1082       consumerSubscriptionId:
1083         type: string
1084       filter:
1085         type: string
1086   SubscriptionGetDto:
1087     type: object
1088     required:
1089     - subscriptionId
1090     properties:
1091       subscriptionId:
1092         type: string
1093         description: Subscription ID
1094       callback:
1095         type: string
1096       consumerSubscriptionId:
1097         type: string
1098       filter:
1099         type: string
1100     x-mask: "{subscriptionId,callback}"
1101   AlarmGetDto:
1102     type: object
1103     required:
1104     - alarmEventRecordId
1105     properties:
1106       alarmEventRecordId:
1107         type: string
1108         example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1109         description: Alarm Event Record ID
1110       resourceTypeId:
1111         type: string
1112       resourceTypeID:
1113         type: string
1114       resourceId:
1115         type: string
1116       resourceID:
1117         type: string
1118       alarmDefinitionId:
1119         type: string
1120       alarmDefinitionID:
1121         type: string
1122       probableCauseId:
1123         type: string
1124       probableCauseID:
1125         type: string
1126       alarmRaisedTime:
1127         type: string
1128       alarmChangedTime:
1129         type: string
1130       alarmAcknowledgeTime:
1131         type: string
1132       alarmAcknowledged:
1133         type: boolean
1134       perceivedSeverity:
1135         type: string
1136       extensions:
1137         type: object
1138         properties: {}
1139   AlarmSubscriptionCreateDto:
1140     type: object
1141     required:
1142     - callback
1143     properties:
1144       callback:
1145         type: string
1146         description: Alarm Subscription callback address
1147       consumerSubscriptionId:
1148         type: string
1149       filter:
1150         type: string
1151   AlarmSubscriptionGetDto:
1152     type: object
1153     required:
1154     - alarmSubscriptionId
1155     properties:
1156       alarmSubscriptionId:
1157         type: string
1158         description: Alarm Subscription ID
1159       callback:
1160         type: string
1161       consumerSubscriptionId:
1162         type: string
1163       filter:
1164         type: string
1165     x-mask: "{alarmSubscriptionId,callback}"
1166 responses:
1167   ParseError:
1168     description: When a mask can't be parsed
1169   MaskError:
1170     description: When any error occurs on mask
1171   HTTPException:
1172     description: Default error handler
1173   NotFound:
1174     description: notfound handler
1175   BadRequestException:
1176     description: Return a custom message and 400 status code
1177   NotFoundException:
1178     description: Return a custom message and 404 status code
1179   MethodNotAllowed:
1180     description: Return a custom message and 405 status code
1181   InternalServerError:
1182     description: Return a custom message and 500 status code
1183   Exception:
1184     description: Return a custom message and 500 status code