aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml

   1 swagger: "2.0"
   2 info:
   3   description: |
   4
   5     [Differences versus the previous schema version](apidocs/aai_swagger_v13.diff)
   6
   7     Copyright &copy; 2017 AT&amp;T Intellectual Property. All rights reserved.
   8
   9     Licensed under the Creative Commons License, Attribution 4.0 Intl. (the &quot;License&quot;); you may not use this documentation except in compliance with the License.
  10
  11     You may obtain a copy of the License at
  12
  13     (https://creativecommons.org/licenses/by/4.0/)
  14
  15     Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  16
  17     ECOMP and OpenECOMP are trademarks and service marks of AT&amp;T Intellectual Property.
  18
  19     This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.
  20   version: "v13"
  21   title: Active and Available Inventory REST API
  22   license:
  23     name: Apache 2.0
  24     url: http://www.apache.org/licenses/LICENSE-2.0.html
  25   contact:
  26     name:
  27     url:
  28     email:
  29 host:
  30 basePath: /aai/v13
  31 schemes:
  32   - https
  33 paths:
  34   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship:
  35     put:
  36       tags:
  37         - CloudInfrastructure
  38       summary: see node definition for valid relationships
  39       operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
  40       consumes:
  41         - application/json
  42         - application/xml
  43       produces:
  44         - application/json
  45         - application/xml
  46       responses:
  47         "default":
  48           description: Response codes found in [response codes](https://wiki.onap.org/).
  49       parameters:
  50         - name: physical-location-id
  51           in: path
  52           description: Unique identifier for physical location, e.g., CLLI
  53           required: true
  54           type: string
  55           example: __PHYSICAL-LOCATION-ID__
  56         - name: target-pe
  57           in: path
  58           description: The Target provider edge router
  59           required: true
  60           type: string
  61           example: __TARGET-PE__
  62         - name: availability-zone-name
  63           in: path
  64           description: Name of the availability zone
  65           required: true
  66           type: string
  67           example: __AVAILABILITY-ZONE-NAME__
  68         - name: body
  69           in: body
  70           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
  71           required: true
  72           schema:
  73             $ref: "#/definitions/relationship"
  74     delete:
  75       tags:
  76         - CloudInfrastructure
  77       summary: delete an existing relationship
  78       description: delete an existing relationship
  79       operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
  80       consumes:
  81         - application/json
  82         - application/xml
  83       produces:
  84         - application/json
  85         - application/xml
  86       responses:
  87         "default":
  88           description: Response codes found in [response codes](https://wiki.onap.org/).
  89       parameters:
  90         - name: physical-location-id
  91           in: path
  92           description: Unique identifier for physical location, e.g., CLLI
  93           required: true
  94           type: string
  95           example: __PHYSICAL-LOCATION-ID__
  96         - name: target-pe
  97           in: path
  98           description: The Target provider edge router
  99           required: true
 100           type: string
 101           example: __TARGET-PE__
 102         - name: availability-zone-name
 103           in: path
 104           description: Name of the availability zone
 105           required: true
 106           type: string
 107           example: __AVAILABILITY-ZONE-NAME__
 108   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}:
 109     get:
 110       tags:
 111         - CloudInfrastructure
 112       summary: returns ctag-pool
 113       description: returns ctag-pool
 114       operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 115       produces:
 116         - application/json
 117         - application/xml
 118       responses:
 119         "200":
 120           description: successful operation
 121           schema:
 122               $ref: "#/getDefinitions/ctag-pool"
 123         "default":
 124           description: Response codes found in [response codes](https://wiki.onap.org/).
 125       parameters:
 126         - name: physical-location-id
 127           in: path
 128           description: Unique identifier for physical location, e.g., CLLI
 129           required: true
 130           type: string
 131           example: __PHYSICAL-LOCATION-ID__
 132         - name: target-pe
 133           in: path
 134           description: The Target provider edge router
 135           required: true
 136           type: string
 137           example: __TARGET-PE__
 138         - name: availability-zone-name
 139           in: path
 140           description: Name of the availability zone
 141           required: true
 142           type: string
 143           example: __AVAILABILITY-ZONE-NAME__
 144     put:
 145       tags:
 146         - CloudInfrastructure
 147       summary: create or update an existing ctag-pool
 148       description: |
 149         Create or update an existing ctag-pool.
 150         #
 151         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 152       operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 153       consumes:
 154         - application/json
 155         - application/xml
 156       produces:
 157         - application/json
 158         - application/xml
 159       responses:
 160         "default":
 161           description: Response codes found in [response codes](https://wiki.onap.org/).
 162       parameters:
 163         - name: physical-location-id
 164           in: path
 165           description: Unique identifier for physical location, e.g., CLLI
 166           required: true
 167           type: string
 168           example: __PHYSICAL-LOCATION-ID__
 169         - name: target-pe
 170           in: path
 171           description: The Target provider edge router
 172           required: true
 173           type: string
 174           example: __TARGET-PE__
 175         - name: availability-zone-name
 176           in: path
 177           description: Name of the availability zone
 178           required: true
 179           type: string
 180           example: __AVAILABILITY-ZONE-NAME__
 181         - name: body
 182           in: body
 183           description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
 184           required: true
 185           schema:
 186             $ref: "#/definitions/ctag-pool"
 187     patch:
 188       tags:
 189         - CloudInfrastructure
 190       summary: update an existing ctag-pool
 191       description: |
 192         Update an existing ctag-pool
 193         #
 194         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
 195         The PUT operation will entirely replace an existing object.
 196         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
 197         #
 198         Other differences between PUT and PATCH are:
 199         #
 200         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
 201         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
 202         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
 203       operationId: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 204       consumes:
 205         - application/json
 206         - application/xml
 207       produces:
 208         - application/json
 209         - application/xml
 210       responses:
 211         "default":
 212           description: Response codes found in [response codes](https://wiki.onap.org/).
 213       parameters:
 214         - name: physical-location-id
 215           in: path
 216           description: Unique identifier for physical location, e.g., CLLI
 217           required: true
 218           type: string
 219           example: __PHYSICAL-LOCATION-ID__
 220         - name: target-pe
 221           in: path
 222           description: The Target provider edge router
 223           required: true
 224           type: string
 225           example: __TARGET-PE__
 226         - name: availability-zone-name
 227           in: path
 228           description: Name of the availability zone
 229           required: true
 230           type: string
 231           example: __AVAILABILITY-ZONE-NAME__
 232         - name: body
 233           in: body
 234           description: ctag-pool object that needs to be updated.
 235           required: true
 236           schema:
 237             $ref: "#/patchDefinitions/ctag-pool"
 238     delete:
 239       tags:
 240         - CloudInfrastructure
 241       summary: delete an existing ctag-pool
 242       description: delete an existing ctag-pool
 243       operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 244       consumes:
 245         - application/json
 246         - application/xml
 247       produces:
 248         - application/json
 249         - application/xml
 250       responses:
 251         "default":
 252           description: Response codes found in [response codes](https://wiki.onap.org/).
 253       parameters:
 254         - name: physical-location-id
 255           in: path
 256           description: Unique identifier for physical location, e.g., CLLI
 257           required: true
 258           type: string
 259           example: __PHYSICAL-LOCATION-ID__
 260         - name: target-pe
 261           in: path
 262           description: The Target provider edge router
 263           required: true
 264           type: string
 265           example: __TARGET-PE__
 266         - name: availability-zone-name
 267           in: path
 268           description: Name of the availability zone
 269           required: true
 270           type: string
 271           example: __AVAILABILITY-ZONE-NAME__
 272         - name: resource-version
 273           in: query
 274           description: resource-version for concurrency
 275           required: true
 276           type: string
 277   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools:
 278     get:
 279       tags:
 280         - CloudInfrastructure
 281       summary: returns ctag-pools
 282       description: returns ctag-pools
 283       operationId: getCloudInfrastructureComplexesComplexCtagPools
 284       produces:
 285         - application/json
 286         - application/xml
 287       responses:
 288         "200":
 289           description: successful operation
 290           schema:
 291               $ref: "#/getDefinitions/ctag-pools"
 292         "default":
 293           description: Response codes found in [response codes](https://wiki.onap.org/).
 294       parameters:
 295         - name: physical-location-id
 296           in: path
 297           description: Unique identifier for physical location, e.g., CLLI
 298           required: true
 299           type: string
 300           example: __PHYSICAL-LOCATION-ID__
 301         - name: availability-zone-name
 302           in: query
 303           description:
 304           required: false
 305           type: string
 306   /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship:
 307     put:
 308       tags:
 309         - CloudInfrastructure
 310       summary: see node definition for valid relationships
 311       operationId: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship
 312       consumes:
 313         - application/json
 314         - application/xml
 315       produces:
 316         - application/json
 317         - application/xml
 318       responses:
 319         "default":
 320           description: Response codes found in [response codes](https://wiki.onap.org/).
 321       parameters:
 322         - name: physical-location-id
 323           in: path
 324           description: Unique identifier for physical location, e.g., CLLI
 325           required: true
 326           type: string
 327           example: __PHYSICAL-LOCATION-ID__
 328         - name: body
 329           in: body
 330           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplex.json)
 331           required: true
 332           schema:
 333             $ref: "#/definitions/relationship"
 334     delete:
 335       tags:
 336         - CloudInfrastructure
 337       summary: delete an existing relationship
 338       description: delete an existing relationship
 339       operationId: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship
 340       consumes:
 341         - application/json
 342         - application/xml
 343       produces:
 344         - application/json
 345         - application/xml
 346       responses:
 347         "default":
 348           description: Response codes found in [response codes](https://wiki.onap.org/).
 349       parameters:
 350         - name: physical-location-id
 351           in: path
 352           description: Unique identifier for physical location, e.g., CLLI
 353           required: true
 354           type: string
 355           example: __PHYSICAL-LOCATION-ID__
 356   /cloud-infrastructure/complexes/complex/{physical-location-id}:
 357     get:
 358       tags:
 359         - CloudInfrastructure
 360       summary: returns complex
 361       description: returns complex
 362       operationId: getCloudInfrastructureComplexesComplex
 363       produces:
 364         - application/json
 365         - application/xml
 366       responses:
 367         "200":
 368           description: successful operation
 369           schema:
 370               $ref: "#/getDefinitions/complex"
 371         "default":
 372           description: Response codes found in [response codes](https://wiki.onap.org/).
 373       parameters:
 374         - name: physical-location-id
 375           in: path
 376           description: Unique identifier for physical location, e.g., CLLI
 377           required: true
 378           type: string
 379           example: __PHYSICAL-LOCATION-ID__
 380     put:
 381       tags:
 382         - CloudInfrastructure
 383       summary: create or update an existing complex
 384       description: |
 385         Create or update an existing complex.
 386         #
 387         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 388       operationId: createOrUpdateCloudInfrastructureComplexesComplex
 389       consumes:
 390         - application/json
 391         - application/xml
 392       produces:
 393         - application/json
 394         - application/xml
 395       responses:
 396         "default":
 397           description: Response codes found in [response codes](https://wiki.onap.org/).
 398       parameters:
 399         - name: physical-location-id
 400           in: path
 401           description: Unique identifier for physical location, e.g., CLLI
 402           required: true
 403           type: string
 404           example: __PHYSICAL-LOCATION-ID__
 405         - name: body
 406           in: body
 407           description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplex.json)
 408           required: true
 409           schema:
 410             $ref: "#/definitions/complex"
 411     patch:
 412       tags:
 413         - CloudInfrastructure
 414       summary: update an existing complex
 415       description: |
 416         Update an existing complex
 417         #
 418         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
 419         The PUT operation will entirely replace an existing object.
 420         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
 421         #
 422         Other differences between PUT and PATCH are:
 423         #
 424         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
 425         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
 426         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
 427       operationId: UpdateCloudInfrastructureComplexesComplex
 428       consumes:
 429         - application/json
 430         - application/xml
 431       produces:
 432         - application/json
 433         - application/xml
 434       responses:
 435         "default":
 436           description: Response codes found in [response codes](https://wiki.onap.org/).
 437       parameters:
 438         - name: physical-location-id
 439           in: path
 440           description: Unique identifier for physical location, e.g., CLLI
 441           required: true
 442           type: string
 443           example: __PHYSICAL-LOCATION-ID__
 444         - name: body
 445           in: body
 446           description: complex object that needs to be updated.
 447           required: true
 448           schema:
 449             $ref: "#/patchDefinitions/complex"
 450     delete:
 451       tags:
 452         - CloudInfrastructure
 453       summary: delete an existing complex
 454       description: delete an existing complex
 455       operationId: deleteCloudInfrastructureComplexesComplex
 456       consumes:
 457         - application/json
 458         - application/xml
 459       produces:
 460         - application/json
 461         - application/xml
 462       responses:
 463         "default":
 464           description: Response codes found in [response codes](https://wiki.onap.org/).
 465       parameters:
 466         - name: physical-location-id
 467           in: path
 468           description: Unique identifier for physical location, e.g., CLLI
 469           required: true
 470           type: string
 471           example: __PHYSICAL-LOCATION-ID__
 472         - name: resource-version
 473           in: query
 474           description: resource-version for concurrency
 475           required: true
 476           type: string
 477   /cloud-infrastructure/complexes:
 478     get:
 479       tags:
 480         - CloudInfrastructure
 481       summary: returns complexes
 482       description: returns complexes
 483       operationId: getCloudInfrastructureComplexes
 484       produces:
 485         - application/json
 486         - application/xml
 487       responses:
 488         "200":
 489           description: successful operation
 490           schema:
 491               $ref: "#/getDefinitions/complexes"
 492         "default":
 493           description: Response codes found in [response codes](https://wiki.onap.org/).
 494       parameters:
 495         - name: physical-location-id
 496           in: query
 497           description:
 498           required: false
 499           type: string
 500         - name: data-center-code
 501           in: query
 502           description:
 503           required: false
 504           type: string
 505         - name: complex-name
 506           in: query
 507           description:
 508           required: false
 509           type: string
 510         - name: identity-url
 511           in: query
 512           description:
 513           required: false
 514           type: string
 515   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship:
 516     put:
 517       tags:
 518         - CloudInfrastructure
 519       summary: see node definition for valid relationships
 520       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
 521       consumes:
 522         - application/json
 523         - application/xml
 524       produces:
 525         - application/json
 526         - application/xml
 527       responses:
 528         "default":
 529           description: Response codes found in [response codes](https://wiki.onap.org/).
 530       parameters:
 531         - name: cloud-owner
 532           in: path
 533           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 534           required: true
 535           type: string
 536           example: __CLOUD-OWNER__
 537         - name: cloud-region-id
 538           in: path
 539           description: Identifier used by the vendor for the region. Second part of composite key
 540           required: true
 541           type: string
 542           example: __CLOUD-REGION-ID__
 543         - name: volume-group-id
 544           in: path
 545           description: Unique ID of volume-group.
 546           required: true
 547           type: string
 548           example: __VOLUME-GROUP-ID__
 549         - name: body
 550           in: body
 551           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
 552           required: true
 553           schema:
 554             $ref: "#/definitions/relationship"
 555     delete:
 556       tags:
 557         - CloudInfrastructure
 558       summary: delete an existing relationship
 559       description: delete an existing relationship
 560       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
 561       consumes:
 562         - application/json
 563         - application/xml
 564       produces:
 565         - application/json
 566         - application/xml
 567       responses:
 568         "default":
 569           description: Response codes found in [response codes](https://wiki.onap.org/).
 570       parameters:
 571         - name: cloud-owner
 572           in: path
 573           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 574           required: true
 575           type: string
 576           example: __CLOUD-OWNER__
 577         - name: cloud-region-id
 578           in: path
 579           description: Identifier used by the vendor for the region. Second part of composite key
 580           required: true
 581           type: string
 582           example: __CLOUD-REGION-ID__
 583         - name: volume-group-id
 584           in: path
 585           description: Unique ID of volume-group.
 586           required: true
 587           type: string
 588           example: __VOLUME-GROUP-ID__
 589   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}:
 590     get:
 591       tags:
 592         - CloudInfrastructure
 593       summary: returns volume-group
 594       description: returns volume-group
 595       operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 596       produces:
 597         - application/json
 598         - application/xml
 599       responses:
 600         "200":
 601           description: successful operation
 602           schema:
 603               $ref: "#/getDefinitions/volume-group"
 604         "default":
 605           description: Response codes found in [response codes](https://wiki.onap.org/).
 606       parameters:
 607         - name: cloud-owner
 608           in: path
 609           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 610           required: true
 611           type: string
 612           example: __CLOUD-OWNER__
 613         - name: cloud-region-id
 614           in: path
 615           description: Identifier used by the vendor for the region. Second part of composite key
 616           required: true
 617           type: string
 618           example: __CLOUD-REGION-ID__
 619         - name: volume-group-id
 620           in: path
 621           description: Unique ID of volume-group.
 622           required: true
 623           type: string
 624           example: __VOLUME-GROUP-ID__
 625     put:
 626       tags:
 627         - CloudInfrastructure
 628       summary: create or update an existing volume-group
 629       description: |
 630         Create or update an existing volume-group.
 631         #
 632         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 633       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 634       consumes:
 635         - application/json
 636         - application/xml
 637       produces:
 638         - application/json
 639         - application/xml
 640       responses:
 641         "default":
 642           description: Response codes found in [response codes](https://wiki.onap.org/).
 643       parameters:
 644         - name: cloud-owner
 645           in: path
 646           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 647           required: true
 648           type: string
 649           example: __CLOUD-OWNER__
 650         - name: cloud-region-id
 651           in: path
 652           description: Identifier used by the vendor for the region. Second part of composite key
 653           required: true
 654           type: string
 655           example: __CLOUD-REGION-ID__
 656         - name: volume-group-id
 657           in: path
 658           description: Unique ID of volume-group.
 659           required: true
 660           type: string
 661           example: __VOLUME-GROUP-ID__
 662         - name: body
 663           in: body
 664           description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
 665           required: true
 666           schema:
 667             $ref: "#/definitions/volume-group"
 668     patch:
 669       tags:
 670         - CloudInfrastructure
 671       summary: update an existing volume-group
 672       description: |
 673         Update an existing volume-group
 674         #
 675         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
 676         The PUT operation will entirely replace an existing object.
 677         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
 678         #
 679         Other differences between PUT and PATCH are:
 680         #
 681         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
 682         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
 683         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
 684       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 685       consumes:
 686         - application/json
 687         - application/xml
 688       produces:
 689         - application/json
 690         - application/xml
 691       responses:
 692         "default":
 693           description: Response codes found in [response codes](https://wiki.onap.org/).
 694       parameters:
 695         - name: cloud-owner
 696           in: path
 697           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 698           required: true
 699           type: string
 700           example: __CLOUD-OWNER__
 701         - name: cloud-region-id
 702           in: path
 703           description: Identifier used by the vendor for the region. Second part of composite key
 704           required: true
 705           type: string
 706           example: __CLOUD-REGION-ID__
 707         - name: volume-group-id
 708           in: path
 709           description: Unique ID of volume-group.
 710           required: true
 711           type: string
 712           example: __VOLUME-GROUP-ID__
 713         - name: body
 714           in: body
 715           description: volume-group object that needs to be updated.
 716           required: true
 717           schema:
 718             $ref: "#/patchDefinitions/volume-group"
 719     delete:
 720       tags:
 721         - CloudInfrastructure
 722       summary: delete an existing volume-group
 723       description: delete an existing volume-group
 724       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 725       consumes:
 726         - application/json
 727         - application/xml
 728       produces:
 729         - application/json
 730         - application/xml
 731       responses:
 732         "default":
 733           description: Response codes found in [response codes](https://wiki.onap.org/).
 734       parameters:
 735         - name: cloud-owner
 736           in: path
 737           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 738           required: true
 739           type: string
 740           example: __CLOUD-OWNER__
 741         - name: cloud-region-id
 742           in: path
 743           description: Identifier used by the vendor for the region. Second part of composite key
 744           required: true
 745           type: string
 746           example: __CLOUD-REGION-ID__
 747         - name: volume-group-id
 748           in: path
 749           description: Unique ID of volume-group.
 750           required: true
 751           type: string
 752           example: __VOLUME-GROUP-ID__
 753         - name: resource-version
 754           in: query
 755           description: resource-version for concurrency
 756           required: true
 757           type: string
 758   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups:
 759     get:
 760       tags:
 761         - CloudInfrastructure
 762       summary: returns volume-groups
 763       description: returns volume-groups
 764       operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups
 765       produces:
 766         - application/json
 767         - application/xml
 768       responses:
 769         "200":
 770           description: successful operation
 771           schema:
 772               $ref: "#/getDefinitions/volume-groups"
 773         "default":
 774           description: Response codes found in [response codes](https://wiki.onap.org/).
 775       parameters:
 776         - name: cloud-owner
 777           in: path
 778           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 779           required: true
 780           type: string
 781           example: __CLOUD-OWNER__
 782         - name: cloud-region-id
 783           in: path
 784           description: Identifier used by the vendor for the region. Second part of composite key
 785           required: true
 786           type: string
 787           example: __CLOUD-REGION-ID__
 788         - name: volume-group-id
 789           in: query
 790           description:
 791           required: false
 792           type: string
 793         - name: volume-group-name
 794           in: query
 795           description:
 796           required: false
 797           type: string
 798         - name: heat-stack-id
 799           in: query
 800           description:
 801           required: false
 802           type: string
 803         - name: vnf-type
 804           in: query
 805           description:
 806           required: false
 807           type: string
 808   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship:
 809     put:
 810       tags:
 811         - CloudInfrastructure
 812       summary: see node definition for valid relationships
 813       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
 814       consumes:
 815         - application/json
 816         - application/xml
 817       produces:
 818         - application/json
 819         - application/xml
 820       responses:
 821         "default":
 822           description: Response codes found in [response codes](https://wiki.onap.org/).
 823       parameters:
 824         - name: cloud-owner
 825           in: path
 826           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 827           required: true
 828           type: string
 829           example: __CLOUD-OWNER__
 830         - name: cloud-region-id
 831           in: path
 832           description: Identifier used by the vendor for the region. Second part of composite key
 833           required: true
 834           type: string
 835           example: __CLOUD-REGION-ID__
 836         - name: tenant-id
 837           in: path
 838           description: Unique id relative to the cloud-region.
 839           required: true
 840           type: string
 841           example: __TENANT-ID__
 842         - name: vserver-id
 843           in: path
 844           description: Unique identifier for this vserver relative to its tenant
 845           required: true
 846           type: string
 847           example: __VSERVER-ID__
 848         - name: volume-id
 849           in: path
 850           description: Unique ID of block storage volume relative to the vserver.
 851           required: true
 852           type: string
 853           example: __VOLUME-ID__
 854         - name: body
 855           in: body
 856           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
 857           required: true
 858           schema:
 859             $ref: "#/definitions/relationship"
 860     delete:
 861       tags:
 862         - CloudInfrastructure
 863       summary: delete an existing relationship
 864       description: delete an existing relationship
 865       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
 866       consumes:
 867         - application/json
 868         - application/xml
 869       produces:
 870         - application/json
 871         - application/xml
 872       responses:
 873         "default":
 874           description: Response codes found in [response codes](https://wiki.onap.org/).
 875       parameters:
 876         - name: cloud-owner
 877           in: path
 878           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 879           required: true
 880           type: string
 881           example: __CLOUD-OWNER__
 882         - name: cloud-region-id
 883           in: path
 884           description: Identifier used by the vendor for the region. Second part of composite key
 885           required: true
 886           type: string
 887           example: __CLOUD-REGION-ID__
 888         - name: tenant-id
 889           in: path
 890           description: Unique id relative to the cloud-region.
 891           required: true
 892           type: string
 893           example: __TENANT-ID__
 894         - name: vserver-id
 895           in: path
 896           description: Unique identifier for this vserver relative to its tenant
 897           required: true
 898           type: string
 899           example: __VSERVER-ID__
 900         - name: volume-id
 901           in: path
 902           description: Unique ID of block storage volume relative to the vserver.
 903           required: true
 904           type: string
 905           example: __VOLUME-ID__
 906   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}:
 907     get:
 908       tags:
 909         - CloudInfrastructure
 910       summary: returns volume
 911       description: returns volume
 912       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
 913       produces:
 914         - application/json
 915         - application/xml
 916       responses:
 917         "200":
 918           description: successful operation
 919           schema:
 920               $ref: "#/getDefinitions/volume"
 921         "default":
 922           description: Response codes found in [response codes](https://wiki.onap.org/).
 923       parameters:
 924         - name: cloud-owner
 925           in: path
 926           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 927           required: true
 928           type: string
 929           example: __CLOUD-OWNER__
 930         - name: cloud-region-id
 931           in: path
 932           description: Identifier used by the vendor for the region. Second part of composite key
 933           required: true
 934           type: string
 935           example: __CLOUD-REGION-ID__
 936         - name: tenant-id
 937           in: path
 938           description: Unique id relative to the cloud-region.
 939           required: true
 940           type: string
 941           example: __TENANT-ID__
 942         - name: vserver-id
 943           in: path
 944           description: Unique identifier for this vserver relative to its tenant
 945           required: true
 946           type: string
 947           example: __VSERVER-ID__
 948         - name: volume-id
 949           in: path
 950           description: Unique ID of block storage volume relative to the vserver.
 951           required: true
 952           type: string
 953           example: __VOLUME-ID__
 954     put:
 955       tags:
 956         - CloudInfrastructure
 957       summary: create or update an existing volume
 958       description: |
 959         Create or update an existing volume.
 960         #
 961         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 962       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
 963       consumes:
 964         - application/json
 965         - application/xml
 966       produces:
 967         - application/json
 968         - application/xml
 969       responses:
 970         "default":
 971           description: Response codes found in [response codes](https://wiki.onap.org/).
 972       parameters:
 973         - name: cloud-owner
 974           in: path
 975           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 976           required: true
 977           type: string
 978           example: __CLOUD-OWNER__
 979         - name: cloud-region-id
 980           in: path
 981           description: Identifier used by the vendor for the region. Second part of composite key
 982           required: true
 983           type: string
 984           example: __CLOUD-REGION-ID__
 985         - name: tenant-id
 986           in: path
 987           description: Unique id relative to the cloud-region.
 988           required: true
 989           type: string
 990           example: __TENANT-ID__
 991         - name: vserver-id
 992           in: path
 993           description: Unique identifier for this vserver relative to its tenant
 994           required: true
 995           type: string
 996           example: __VSERVER-ID__
 997         - name: volume-id
 998           in: path
 999           description: Unique ID of block storage volume relative to the vserver.
1000           required: true
1001           type: string
1002           example: __VOLUME-ID__
1003         - name: body
1004           in: body
1005           description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
1006           required: true
1007           schema:
1008             $ref: "#/definitions/volume"
1009     patch:
1010       tags:
1011         - CloudInfrastructure
1012       summary: update an existing volume
1013       description: |
1014         Update an existing volume
1015         #
1016         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1017         The PUT operation will entirely replace an existing object.
1018         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
1019         #
1020         Other differences between PUT and PATCH are:
1021         #
1022         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
1023         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1024         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1025       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1026       consumes:
1027         - application/json
1028         - application/xml
1029       produces:
1030         - application/json
1031         - application/xml
1032       responses:
1033         "default":
1034           description: Response codes found in [response codes](https://wiki.onap.org/).
1035       parameters:
1036         - name: cloud-owner
1037           in: path
1038           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1039           required: true
1040           type: string
1041           example: __CLOUD-OWNER__
1042         - name: cloud-region-id
1043           in: path
1044           description: Identifier used by the vendor for the region. Second part of composite key
1045           required: true
1046           type: string
1047           example: __CLOUD-REGION-ID__
1048         - name: tenant-id
1049           in: path
1050           description: Unique id relative to the cloud-region.
1051           required: true
1052           type: string
1053           example: __TENANT-ID__
1054         - name: vserver-id
1055           in: path
1056           description: Unique identifier for this vserver relative to its tenant
1057           required: true
1058           type: string
1059           example: __VSERVER-ID__
1060         - name: volume-id
1061           in: path
1062           description: Unique ID of block storage volume relative to the vserver.
1063           required: true
1064           type: string
1065           example: __VOLUME-ID__
1066         - name: body
1067           in: body
1068           description: volume object that needs to be updated.
1069           required: true
1070           schema:
1071             $ref: "#/patchDefinitions/volume"
1072     delete:
1073       tags:
1074         - CloudInfrastructure
1075       summary: delete an existing volume
1076       description: delete an existing volume
1077       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1078       consumes:
1079         - application/json
1080         - application/xml
1081       produces:
1082         - application/json
1083         - application/xml
1084       responses:
1085         "default":
1086           description: Response codes found in [response codes](https://wiki.onap.org/).
1087       parameters:
1088         - name: cloud-owner
1089           in: path
1090           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1091           required: true
1092           type: string
1093           example: __CLOUD-OWNER__
1094         - name: cloud-region-id
1095           in: path
1096           description: Identifier used by the vendor for the region. Second part of composite key
1097           required: true
1098           type: string
1099           example: __CLOUD-REGION-ID__
1100         - name: tenant-id
1101           in: path
1102           description: Unique id relative to the cloud-region.
1103           required: true
1104           type: string
1105           example: __TENANT-ID__
1106         - name: vserver-id
1107           in: path
1108           description: Unique identifier for this vserver relative to its tenant
1109           required: true
1110           type: string
1111           example: __VSERVER-ID__
1112         - name: volume-id
1113           in: path
1114           description: Unique ID of block storage volume relative to the vserver.
1115           required: true
1116           type: string
1117           example: __VOLUME-ID__
1118         - name: resource-version
1119           in: query
1120           description: resource-version for concurrency
1121           required: true
1122           type: string
1123   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes:
1124     get:
1125       tags:
1126         - CloudInfrastructure
1127       summary: returns volumes
1128       description: returns volumes
1129       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes
1130       produces:
1131         - application/json
1132         - application/xml
1133       responses:
1134         "200":
1135           description: successful operation
1136           schema:
1137               $ref: "#/getDefinitions/volumes"
1138         "default":
1139           description: Response codes found in [response codes](https://wiki.onap.org/).
1140       parameters:
1141         - name: cloud-owner
1142           in: path
1143           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1144           required: true
1145           type: string
1146           example: __CLOUD-OWNER__
1147         - name: cloud-region-id
1148           in: path
1149           description: Identifier used by the vendor for the region. Second part of composite key
1150           required: true
1151           type: string
1152           example: __CLOUD-REGION-ID__
1153         - name: tenant-id
1154           in: path
1155           description: Unique id relative to the cloud-region.
1156           required: true
1157           type: string
1158           example: __TENANT-ID__
1159         - name: vserver-id
1160           in: path
1161           description: Unique identifier for this vserver relative to its tenant
1162           required: true
1163           type: string
1164           example: __VSERVER-ID__
1165         - name: volume-id
1166           in: query
1167           description:
1168           required: false
1169           type: string
1170   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship:
1171     put:
1172       tags:
1173         - CloudInfrastructure
1174       summary: see node definition for valid relationships
1175       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1176       consumes:
1177         - application/json
1178         - application/xml
1179       produces:
1180         - application/json
1181         - application/xml
1182       responses:
1183         "default":
1184           description: Response codes found in [response codes](https://wiki.onap.org/).
1185       parameters:
1186         - name: cloud-owner
1187           in: path
1188           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1189           required: true
1190           type: string
1191           example: __CLOUD-OWNER__
1192         - name: cloud-region-id
1193           in: path
1194           description: Identifier used by the vendor for the region. Second part of composite key
1195           required: true
1196           type: string
1197           example: __CLOUD-REGION-ID__
1198         - name: tenant-id
1199           in: path
1200           description: Unique id relative to the cloud-region.
1201           required: true
1202           type: string
1203           example: __TENANT-ID__
1204         - name: vserver-id
1205           in: path
1206           description: Unique identifier for this vserver relative to its tenant
1207           required: true
1208           type: string
1209           example: __VSERVER-ID__
1210         - name: body
1211           in: body
1212           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
1213           required: true
1214           schema:
1215             $ref: "#/definitions/relationship"
1216     delete:
1217       tags:
1218         - CloudInfrastructure
1219       summary: delete an existing relationship
1220       description: delete an existing relationship
1221       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1222       consumes:
1223         - application/json
1224         - application/xml
1225       produces:
1226         - application/json
1227         - application/xml
1228       responses:
1229         "default":
1230           description: Response codes found in [response codes](https://wiki.onap.org/).
1231       parameters:
1232         - name: cloud-owner
1233           in: path
1234           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1235           required: true
1236           type: string
1237           example: __CLOUD-OWNER__
1238         - name: cloud-region-id
1239           in: path
1240           description: Identifier used by the vendor for the region. Second part of composite key
1241           required: true
1242           type: string
1243           example: __CLOUD-REGION-ID__
1244         - name: tenant-id
1245           in: path
1246           description: Unique id relative to the cloud-region.
1247           required: true
1248           type: string
1249           example: __TENANT-ID__
1250         - name: vserver-id
1251           in: path
1252           description: Unique identifier for this vserver relative to its tenant
1253           required: true
1254           type: string
1255           example: __VSERVER-ID__
1256   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
1257     put:
1258       tags:
1259         - CloudInfrastructure
1260       summary: see node definition for valid relationships
1261       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1262       consumes:
1263         - application/json
1264         - application/xml
1265       produces:
1266         - application/json
1267         - application/xml
1268       responses:
1269         "default":
1270           description: Response codes found in [response codes](https://wiki.onap.org/).
1271       parameters:
1272         - name: cloud-owner
1273           in: path
1274           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1275           required: true
1276           type: string
1277           example: __CLOUD-OWNER__
1278         - name: cloud-region-id
1279           in: path
1280           description: Identifier used by the vendor for the region. Second part of composite key
1281           required: true
1282           type: string
1283           example: __CLOUD-REGION-ID__
1284         - name: tenant-id
1285           in: path
1286           description: Unique id relative to the cloud-region.
1287           required: true
1288           type: string
1289           example: __TENANT-ID__
1290         - name: vserver-id
1291           in: path
1292           description: Unique identifier for this vserver relative to its tenant
1293           required: true
1294           type: string
1295           example: __VSERVER-ID__
1296         - name: interface-name
1297           in: path
1298           description: Name given to the interface
1299           required: true
1300           type: string
1301           example: __INTERFACE-NAME__
1302         - name: vlan-interface
1303           in: path
1304           description: String that identifies the interface
1305           required: true
1306           type: string
1307           example: __VLAN-INTERFACE__
1308         - name: body
1309           in: body
1310           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
1311           required: true
1312           schema:
1313             $ref: "#/definitions/relationship"
1314     delete:
1315       tags:
1316         - CloudInfrastructure
1317       summary: delete an existing relationship
1318       description: delete an existing relationship
1319       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1320       consumes:
1321         - application/json
1322         - application/xml
1323       produces:
1324         - application/json
1325         - application/xml
1326       responses:
1327         "default":
1328           description: Response codes found in [response codes](https://wiki.onap.org/).
1329       parameters:
1330         - name: cloud-owner
1331           in: path
1332           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1333           required: true
1334           type: string
1335           example: __CLOUD-OWNER__
1336         - name: cloud-region-id
1337           in: path
1338           description: Identifier used by the vendor for the region. Second part of composite key
1339           required: true
1340           type: string
1341           example: __CLOUD-REGION-ID__
1342         - name: tenant-id
1343           in: path
1344           description: Unique id relative to the cloud-region.
1345           required: true
1346           type: string
1347           example: __TENANT-ID__
1348         - name: vserver-id
1349           in: path
1350           description: Unique identifier for this vserver relative to its tenant
1351           required: true
1352           type: string
1353           example: __VSERVER-ID__
1354         - name: interface-name
1355           in: path
1356           description: Name given to the interface
1357           required: true
1358           type: string
1359           example: __INTERFACE-NAME__
1360         - name: vlan-interface
1361           in: path
1362           description: String that identifies the interface
1363           required: true
1364           type: string
1365           example: __VLAN-INTERFACE__
1366   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
1367     put:
1368       tags:
1369         - CloudInfrastructure
1370       summary: see node definition for valid relationships
1371       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1372       consumes:
1373         - application/json
1374         - application/xml
1375       produces:
1376         - application/json
1377         - application/xml
1378       responses:
1379         "default":
1380           description: Response codes found in [response codes](https://wiki.onap.org/).
1381       parameters:
1382         - name: cloud-owner
1383           in: path
1384           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1385           required: true
1386           type: string
1387           example: __CLOUD-OWNER__
1388         - name: cloud-region-id
1389           in: path
1390           description: Identifier used by the vendor for the region. Second part of composite key
1391           required: true
1392           type: string
1393           example: __CLOUD-REGION-ID__
1394         - name: tenant-id
1395           in: path
1396           description: Unique id relative to the cloud-region.
1397           required: true
1398           type: string
1399           example: __TENANT-ID__
1400         - name: vserver-id
1401           in: path
1402           description: Unique identifier for this vserver relative to its tenant
1403           required: true
1404           type: string
1405           example: __VSERVER-ID__
1406         - name: interface-name
1407           in: path
1408           description: Name given to the interface
1409           required: true
1410           type: string
1411           example: __INTERFACE-NAME__
1412         - name: vlan-interface
1413           in: path
1414           description: String that identifies the interface
1415           required: true
1416           type: string
1417           example: __VLAN-INTERFACE__
1418         - name: l3-interface-ipv4-address
1419           in: path
1420           description: IP address
1421           required: true
1422           type: string
1423           example: __L3-INTERFACE-IPV4-ADDRESS__
1424         - name: body
1425           in: body
1426           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1427           required: true
1428           schema:
1429             $ref: "#/definitions/relationship"
1430     delete:
1431       tags:
1432         - CloudInfrastructure
1433       summary: delete an existing relationship
1434       description: delete an existing relationship
1435       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1436       consumes:
1437         - application/json
1438         - application/xml
1439       produces:
1440         - application/json
1441         - application/xml
1442       responses:
1443         "default":
1444           description: Response codes found in [response codes](https://wiki.onap.org/).
1445       parameters:
1446         - name: cloud-owner
1447           in: path
1448           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1449           required: true
1450           type: string
1451           example: __CLOUD-OWNER__
1452         - name: cloud-region-id
1453           in: path
1454           description: Identifier used by the vendor for the region. Second part of composite key
1455           required: true
1456           type: string
1457           example: __CLOUD-REGION-ID__
1458         - name: tenant-id
1459           in: path
1460           description: Unique id relative to the cloud-region.
1461           required: true
1462           type: string
1463           example: __TENANT-ID__
1464         - name: vserver-id
1465           in: path
1466           description: Unique identifier for this vserver relative to its tenant
1467           required: true
1468           type: string
1469           example: __VSERVER-ID__
1470         - name: interface-name
1471           in: path
1472           description: Name given to the interface
1473           required: true
1474           type: string
1475           example: __INTERFACE-NAME__
1476         - name: vlan-interface
1477           in: path
1478           description: String that identifies the interface
1479           required: true
1480           type: string
1481           example: __VLAN-INTERFACE__
1482         - name: l3-interface-ipv4-address
1483           in: path
1484           description: IP address
1485           required: true
1486           type: string
1487           example: __L3-INTERFACE-IPV4-ADDRESS__
1488   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
1489     get:
1490       tags:
1491         - CloudInfrastructure
1492       summary: returns l3-interface-ipv4-address-list
1493       description: returns l3-interface-ipv4-address-list
1494       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1495       produces:
1496         - application/json
1497         - application/xml
1498       responses:
1499         "200":
1500           description: successful operation
1501           schema:
1502               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
1503         "default":
1504           description: Response codes found in [response codes](https://wiki.onap.org/).
1505       parameters:
1506         - name: cloud-owner
1507           in: path
1508           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1509           required: true
1510           type: string
1511           example: __CLOUD-OWNER__
1512         - name: cloud-region-id
1513           in: path
1514           description: Identifier used by the vendor for the region. Second part of composite key
1515           required: true
1516           type: string
1517           example: __CLOUD-REGION-ID__
1518         - name: tenant-id
1519           in: path
1520           description: Unique id relative to the cloud-region.
1521           required: true
1522           type: string
1523           example: __TENANT-ID__
1524         - name: vserver-id
1525           in: path
1526           description: Unique identifier for this vserver relative to its tenant
1527           required: true
1528           type: string
1529           example: __VSERVER-ID__
1530         - name: interface-name
1531           in: path
1532           description: Name given to the interface
1533           required: true
1534           type: string
1535           example: __INTERFACE-NAME__
1536         - name: vlan-interface
1537           in: path
1538           description: String that identifies the interface
1539           required: true
1540           type: string
1541           example: __VLAN-INTERFACE__
1542         - name: l3-interface-ipv4-address
1543           in: path
1544           description: IP address
1545           required: true
1546           type: string
1547           example: __L3-INTERFACE-IPV4-ADDRESS__
1548     put:
1549       tags:
1550         - CloudInfrastructure
1551       summary: create or update an existing l3-interface-ipv4-address-list
1552       description: |
1553         Create or update an existing l3-interface-ipv4-address-list.
1554         #
1555         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
1556       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1557       consumes:
1558         - application/json
1559         - application/xml
1560       produces:
1561         - application/json
1562         - application/xml
1563       responses:
1564         "default":
1565           description: Response codes found in [response codes](https://wiki.onap.org/).
1566       parameters:
1567         - name: cloud-owner
1568           in: path
1569           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1570           required: true
1571           type: string
1572           example: __CLOUD-OWNER__
1573         - name: cloud-region-id
1574           in: path
1575           description: Identifier used by the vendor for the region. Second part of composite key
1576           required: true
1577           type: string
1578           example: __CLOUD-REGION-ID__
1579         - name: tenant-id
1580           in: path
1581           description: Unique id relative to the cloud-region.
1582           required: true
1583           type: string
1584           example: __TENANT-ID__
1585         - name: vserver-id
1586           in: path
1587           description: Unique identifier for this vserver relative to its tenant
1588           required: true
1589           type: string
1590           example: __VSERVER-ID__
1591         - name: interface-name
1592           in: path
1593           description: Name given to the interface
1594           required: true
1595           type: string
1596           example: __INTERFACE-NAME__
1597         - name: vlan-interface
1598           in: path
1599           description: String that identifies the interface
1600           required: true
1601           type: string
1602           example: __VLAN-INTERFACE__
1603         - name: l3-interface-ipv4-address
1604           in: path
1605           description: IP address
1606           required: true
1607           type: string
1608           example: __L3-INTERFACE-IPV4-ADDRESS__
1609         - name: body
1610           in: body
1611           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1612           required: true
1613           schema:
1614             $ref: "#/definitions/l3-interface-ipv4-address-list"
1615     patch:
1616       tags:
1617         - CloudInfrastructure
1618       summary: update an existing l3-interface-ipv4-address-list
1619       description: |
1620         Update an existing l3-interface-ipv4-address-list
1621         #
1622         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1623         The PUT operation will entirely replace an existing object.
1624         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
1625         #
1626         Other differences between PUT and PATCH are:
1627         #
1628         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
1629         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1630         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1631       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1632       consumes:
1633         - application/json
1634         - application/xml
1635       produces:
1636         - application/json
1637         - application/xml
1638       responses:
1639         "default":
1640           description: Response codes found in [response codes](https://wiki.onap.org/).
1641       parameters:
1642         - name: cloud-owner
1643           in: path
1644           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1645           required: true
1646           type: string
1647           example: __CLOUD-OWNER__
1648         - name: cloud-region-id
1649           in: path
1650           description: Identifier used by the vendor for the region. Second part of composite key
1651           required: true
1652           type: string
1653           example: __CLOUD-REGION-ID__
1654         - name: tenant-id
1655           in: path
1656           description: Unique id relative to the cloud-region.
1657           required: true
1658           type: string
1659           example: __TENANT-ID__
1660         - name: vserver-id
1661           in: path
1662           description: Unique identifier for this vserver relative to its tenant
1663           required: true
1664           type: string
1665           example: __VSERVER-ID__
1666         - name: interface-name
1667           in: path
1668           description: Name given to the interface
1669           required: true
1670           type: string
1671           example: __INTERFACE-NAME__
1672         - name: vlan-interface
1673           in: path
1674           description: String that identifies the interface
1675           required: true
1676           type: string
1677           example: __VLAN-INTERFACE__
1678         - name: l3-interface-ipv4-address
1679           in: path
1680           description: IP address
1681           required: true
1682           type: string
1683           example: __L3-INTERFACE-IPV4-ADDRESS__
1684         - name: body
1685           in: body
1686           description: l3-interface-ipv4-address-list object that needs to be updated.
1687           required: true
1688           schema:
1689             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
1690     delete:
1691       tags:
1692         - CloudInfrastructure
1693       summary: delete an existing l3-interface-ipv4-address-list
1694       description: delete an existing l3-interface-ipv4-address-list
1695       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1696       consumes:
1697         - application/json
1698         - application/xml
1699       produces:
1700         - application/json
1701         - application/xml
1702       responses:
1703         "default":
1704           description: Response codes found in [response codes](https://wiki.onap.org/).
1705       parameters:
1706         - name: cloud-owner
1707           in: path
1708           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1709           required: true
1710           type: string
1711           example: __CLOUD-OWNER__
1712         - name: cloud-region-id
1713           in: path
1714           description: Identifier used by the vendor for the region. Second part of composite key
1715           required: true
1716           type: string
1717           example: __CLOUD-REGION-ID__
1718         - name: tenant-id
1719           in: path
1720           description: Unique id relative to the cloud-region.
1721           required: true
1722           type: string
1723           example: __TENANT-ID__
1724         - name: vserver-id
1725           in: path
1726           description: Unique identifier for this vserver relative to its tenant
1727           required: true
1728           type: string
1729           example: __VSERVER-ID__
1730         - name: interface-name
1731           in: path
1732           description: Name given to the interface
1733           required: true
1734           type: string
1735           example: __INTERFACE-NAME__
1736         - name: vlan-interface
1737           in: path
1738           description: String that identifies the interface
1739           required: true
1740           type: string
1741           example: __VLAN-INTERFACE__
1742         - name: l3-interface-ipv4-address
1743           in: path
1744           description: IP address
1745           required: true
1746           type: string
1747           example: __L3-INTERFACE-IPV4-ADDRESS__
1748         - name: resource-version
1749           in: query
1750           description: resource-version for concurrency
1751           required: true
1752           type: string
1753   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
1754     put:
1755       tags:
1756         - CloudInfrastructure
1757       summary: see node definition for valid relationships
1758       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
1759       consumes:
1760         - application/json
1761         - application/xml
1762       produces:
1763         - application/json
1764         - application/xml
1765       responses:
1766         "default":
1767           description: Response codes found in [response codes](https://wiki.onap.org/).
1768       parameters:
1769         - name: cloud-owner
1770           in: path
1771           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1772           required: true
1773           type: string
1774           example: __CLOUD-OWNER__
1775         - name: cloud-region-id
1776           in: path
1777           description: Identifier used by the vendor for the region. Second part of composite key
1778           required: true
1779           type: string
1780           example: __CLOUD-REGION-ID__
1781         - name: tenant-id
1782           in: path
1783           description: Unique id relative to the cloud-region.
1784           required: true
1785           type: string
1786           example: __TENANT-ID__
1787         - name: vserver-id
1788           in: path
1789           description: Unique identifier for this vserver relative to its tenant
1790           required: true
1791           type: string
1792           example: __VSERVER-ID__
1793         - name: interface-name
1794           in: path
1795           description: Name given to the interface
1796           required: true
1797           type: string
1798           example: __INTERFACE-NAME__
1799         - name: vlan-interface
1800           in: path
1801           description: String that identifies the interface
1802           required: true
1803           type: string
1804           example: __VLAN-INTERFACE__
1805         - name: l3-interface-ipv6-address
1806           in: path
1807           description: IP address
1808           required: true
1809           type: string
1810           example: __L3-INTERFACE-IPV6-ADDRESS__
1811         - name: body
1812           in: body
1813           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
1814           required: true
1815           schema:
1816             $ref: "#/definitions/relationship"
1817     delete:
1818       tags:
1819         - CloudInfrastructure
1820       summary: delete an existing relationship
1821       description: delete an existing relationship
1822       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
1823       consumes:
1824         - application/json
1825         - application/xml
1826       produces:
1827         - application/json
1828         - application/xml
1829       responses:
1830         "default":
1831           description: Response codes found in [response codes](https://wiki.onap.org/).
1832       parameters:
1833         - name: cloud-owner
1834           in: path
1835           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1836           required: true
1837           type: string
1838           example: __CLOUD-OWNER__
1839         - name: cloud-region-id
1840           in: path
1841           description: Identifier used by the vendor for the region. Second part of composite key
1842           required: true
1843           type: string
1844           example: __CLOUD-REGION-ID__
1845         - name: tenant-id
1846           in: path
1847           description: Unique id relative to the cloud-region.
1848           required: true
1849           type: string
1850           example: __TENANT-ID__
1851         - name: vserver-id
1852           in: path
1853           description: Unique identifier for this vserver relative to its tenant
1854           required: true
1855           type: string
1856           example: __VSERVER-ID__
1857         - name: interface-name
1858           in: path
1859           description: Name given to the interface
1860           required: true
1861           type: string
1862           example: __INTERFACE-NAME__
1863         - name: vlan-interface
1864           in: path
1865           description: String that identifies the interface
1866           required: true
1867           type: string
1868           example: __VLAN-INTERFACE__
1869         - name: l3-interface-ipv6-address
1870           in: path
1871           description: IP address
1872           required: true
1873           type: string
1874           example: __L3-INTERFACE-IPV6-ADDRESS__
1875   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
1876     get:
1877       tags:
1878         - CloudInfrastructure
1879       summary: returns l3-interface-ipv6-address-list
1880       description: returns l3-interface-ipv6-address-list
1881       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
1882       produces:
1883         - application/json
1884         - application/xml
1885       responses:
1886         "200":
1887           description: successful operation
1888           schema:
1889               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
1890         "default":
1891           description: Response codes found in [response codes](https://wiki.onap.org/).
1892       parameters:
1893         - name: cloud-owner
1894           in: path
1895           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1896           required: true
1897           type: string
1898           example: __CLOUD-OWNER__
1899         - name: cloud-region-id
1900           in: path
1901           description: Identifier used by the vendor for the region. Second part of composite key
1902           required: true
1903           type: string
1904           example: __CLOUD-REGION-ID__
1905         - name: tenant-id
1906           in: path
1907           description: Unique id relative to the cloud-region.
1908           required: true
1909           type: string
1910           example: __TENANT-ID__
1911         - name: vserver-id
1912           in: path
1913           description: Unique identifier for this vserver relative to its tenant
1914           required: true
1915           type: string
1916           example: __VSERVER-ID__
1917         - name: interface-name
1918           in: path
1919           description: Name given to the interface
1920           required: true
1921           type: string
1922           example: __INTERFACE-NAME__
1923         - name: vlan-interface
1924           in: path
1925           description: String that identifies the interface
1926           required: true
1927           type: string
1928           example: __VLAN-INTERFACE__
1929         - name: l3-interface-ipv6-address
1930           in: path
1931           description: IP address
1932           required: true
1933           type: string
1934           example: __L3-INTERFACE-IPV6-ADDRESS__
1935     put:
1936       tags:
1937         - CloudInfrastructure
1938       summary: create or update an existing l3-interface-ipv6-address-list
1939       description: |
1940         Create or update an existing l3-interface-ipv6-address-list.
1941         #
1942         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
1943       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
1944       consumes:
1945         - application/json
1946         - application/xml
1947       produces:
1948         - application/json
1949         - application/xml
1950       responses:
1951         "default":
1952           description: Response codes found in [response codes](https://wiki.onap.org/).
1953       parameters:
1954         - name: cloud-owner
1955           in: path
1956           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1957           required: true
1958           type: string
1959           example: __CLOUD-OWNER__
1960         - name: cloud-region-id
1961           in: path
1962           description: Identifier used by the vendor for the region. Second part of composite key
1963           required: true
1964           type: string
1965           example: __CLOUD-REGION-ID__
1966         - name: tenant-id
1967           in: path
1968           description: Unique id relative to the cloud-region.
1969           required: true
1970           type: string
1971           example: __TENANT-ID__
1972         - name: vserver-id
1973           in: path
1974           description: Unique identifier for this vserver relative to its tenant
1975           required: true
1976           type: string
1977           example: __VSERVER-ID__
1978         - name: interface-name
1979           in: path
1980           description: Name given to the interface
1981           required: true
1982           type: string
1983           example: __INTERFACE-NAME__
1984         - name: vlan-interface
1985           in: path
1986           description: String that identifies the interface
1987           required: true
1988           type: string
1989           example: __VLAN-INTERFACE__
1990         - name: l3-interface-ipv6-address
1991           in: path
1992           description: IP address
1993           required: true
1994           type: string
1995           example: __L3-INTERFACE-IPV6-ADDRESS__
1996         - name: body
1997           in: body
1998           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
1999           required: true
2000           schema:
2001             $ref: "#/definitions/l3-interface-ipv6-address-list"
2002     patch:
2003       tags:
2004         - CloudInfrastructure
2005       summary: update an existing l3-interface-ipv6-address-list
2006       description: |
2007         Update an existing l3-interface-ipv6-address-list
2008         #
2009         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2010         The PUT operation will entirely replace an existing object.
2011         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
2012         #
2013         Other differences between PUT and PATCH are:
2014         #
2015         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2016         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2017         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2018       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2019       consumes:
2020         - application/json
2021         - application/xml
2022       produces:
2023         - application/json
2024         - application/xml
2025       responses:
2026         "default":
2027           description: Response codes found in [response codes](https://wiki.onap.org/).
2028       parameters:
2029         - name: cloud-owner
2030           in: path
2031           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2032           required: true
2033           type: string
2034           example: __CLOUD-OWNER__
2035         - name: cloud-region-id
2036           in: path
2037           description: Identifier used by the vendor for the region. Second part of composite key
2038           required: true
2039           type: string
2040           example: __CLOUD-REGION-ID__
2041         - name: tenant-id
2042           in: path
2043           description: Unique id relative to the cloud-region.
2044           required: true
2045           type: string
2046           example: __TENANT-ID__
2047         - name: vserver-id
2048           in: path
2049           description: Unique identifier for this vserver relative to its tenant
2050           required: true
2051           type: string
2052           example: __VSERVER-ID__
2053         - name: interface-name
2054           in: path
2055           description: Name given to the interface
2056           required: true
2057           type: string
2058           example: __INTERFACE-NAME__
2059         - name: vlan-interface
2060           in: path
2061           description: String that identifies the interface
2062           required: true
2063           type: string
2064           example: __VLAN-INTERFACE__
2065         - name: l3-interface-ipv6-address
2066           in: path
2067           description: IP address
2068           required: true
2069           type: string
2070           example: __L3-INTERFACE-IPV6-ADDRESS__
2071         - name: body
2072           in: body
2073           description: l3-interface-ipv6-address-list object that needs to be updated.
2074           required: true
2075           schema:
2076             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
2077     delete:
2078       tags:
2079         - CloudInfrastructure
2080       summary: delete an existing l3-interface-ipv6-address-list
2081       description: delete an existing l3-interface-ipv6-address-list
2082       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2083       consumes:
2084         - application/json
2085         - application/xml
2086       produces:
2087         - application/json
2088         - application/xml
2089       responses:
2090         "default":
2091           description: Response codes found in [response codes](https://wiki.onap.org/).
2092       parameters:
2093         - name: cloud-owner
2094           in: path
2095           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2096           required: true
2097           type: string
2098           example: __CLOUD-OWNER__
2099         - name: cloud-region-id
2100           in: path
2101           description: Identifier used by the vendor for the region. Second part of composite key
2102           required: true
2103           type: string
2104           example: __CLOUD-REGION-ID__
2105         - name: tenant-id
2106           in: path
2107           description: Unique id relative to the cloud-region.
2108           required: true
2109           type: string
2110           example: __TENANT-ID__
2111         - name: vserver-id
2112           in: path
2113           description: Unique identifier for this vserver relative to its tenant
2114           required: true
2115           type: string
2116           example: __VSERVER-ID__
2117         - name: interface-name
2118           in: path
2119           description: Name given to the interface
2120           required: true
2121           type: string
2122           example: __INTERFACE-NAME__
2123         - name: vlan-interface
2124           in: path
2125           description: String that identifies the interface
2126           required: true
2127           type: string
2128           example: __VLAN-INTERFACE__
2129         - name: l3-interface-ipv6-address
2130           in: path
2131           description: IP address
2132           required: true
2133           type: string
2134           example: __L3-INTERFACE-IPV6-ADDRESS__
2135         - name: resource-version
2136           in: query
2137           description: resource-version for concurrency
2138           required: true
2139           type: string
2140   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
2141     get:
2142       tags:
2143         - CloudInfrastructure
2144       summary: returns vlan
2145       description: returns vlan
2146       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2147       produces:
2148         - application/json
2149         - application/xml
2150       responses:
2151         "200":
2152           description: successful operation
2153           schema:
2154               $ref: "#/getDefinitions/vlan"
2155         "default":
2156           description: Response codes found in [response codes](https://wiki.onap.org/).
2157       parameters:
2158         - name: cloud-owner
2159           in: path
2160           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2161           required: true
2162           type: string
2163           example: __CLOUD-OWNER__
2164         - name: cloud-region-id
2165           in: path
2166           description: Identifier used by the vendor for the region. Second part of composite key
2167           required: true
2168           type: string
2169           example: __CLOUD-REGION-ID__
2170         - name: tenant-id
2171           in: path
2172           description: Unique id relative to the cloud-region.
2173           required: true
2174           type: string
2175           example: __TENANT-ID__
2176         - name: vserver-id
2177           in: path
2178           description: Unique identifier for this vserver relative to its tenant
2179           required: true
2180           type: string
2181           example: __VSERVER-ID__
2182         - name: interface-name
2183           in: path
2184           description: Name given to the interface
2185           required: true
2186           type: string
2187           example: __INTERFACE-NAME__
2188         - name: vlan-interface
2189           in: path
2190           description: String that identifies the interface
2191           required: true
2192           type: string
2193           example: __VLAN-INTERFACE__
2194     put:
2195       tags:
2196         - CloudInfrastructure
2197       summary: create or update an existing vlan
2198       description: |
2199         Create or update an existing vlan.
2200         #
2201         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
2202       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2203       consumes:
2204         - application/json
2205         - application/xml
2206       produces:
2207         - application/json
2208         - application/xml
2209       responses:
2210         "default":
2211           description: Response codes found in [response codes](https://wiki.onap.org/).
2212       parameters:
2213         - name: cloud-owner
2214           in: path
2215           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2216           required: true
2217           type: string
2218           example: __CLOUD-OWNER__
2219         - name: cloud-region-id
2220           in: path
2221           description: Identifier used by the vendor for the region. Second part of composite key
2222           required: true
2223           type: string
2224           example: __CLOUD-REGION-ID__
2225         - name: tenant-id
2226           in: path
2227           description: Unique id relative to the cloud-region.
2228           required: true
2229           type: string
2230           example: __TENANT-ID__
2231         - name: vserver-id
2232           in: path
2233           description: Unique identifier for this vserver relative to its tenant
2234           required: true
2235           type: string
2236           example: __VSERVER-ID__
2237         - name: interface-name
2238           in: path
2239           description: Name given to the interface
2240           required: true
2241           type: string
2242           example: __INTERFACE-NAME__
2243         - name: vlan-interface
2244           in: path
2245           description: String that identifies the interface
2246           required: true
2247           type: string
2248           example: __VLAN-INTERFACE__
2249         - name: body
2250           in: body
2251           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
2252           required: true
2253           schema:
2254             $ref: "#/definitions/vlan"
2255     patch:
2256       tags:
2257         - CloudInfrastructure
2258       summary: update an existing vlan
2259       description: |
2260         Update an existing vlan
2261         #
2262         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2263         The PUT operation will entirely replace an existing object.
2264         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
2265         #
2266         Other differences between PUT and PATCH are:
2267         #
2268         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2269         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2270         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2271       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2272       consumes:
2273         - application/json
2274         - application/xml
2275       produces:
2276         - application/json
2277         - application/xml
2278       responses:
2279         "default":
2280           description: Response codes found in [response codes](https://wiki.onap.org/).
2281       parameters:
2282         - name: cloud-owner
2283           in: path
2284           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2285           required: true
2286           type: string
2287           example: __CLOUD-OWNER__
2288         - name: cloud-region-id
2289           in: path
2290           description: Identifier used by the vendor for the region. Second part of composite key
2291           required: true
2292           type: string
2293           example: __CLOUD-REGION-ID__
2294         - name: tenant-id
2295           in: path
2296           description: Unique id relative to the cloud-region.
2297           required: true
2298           type: string
2299           example: __TENANT-ID__
2300         - name: vserver-id
2301           in: path
2302           description: Unique identifier for this vserver relative to its tenant
2303           required: true
2304           type: string
2305           example: __VSERVER-ID__
2306         - name: interface-name
2307           in: path
2308           description: Name given to the interface
2309           required: true
2310           type: string
2311           example: __INTERFACE-NAME__
2312         - name: vlan-interface
2313           in: path
2314           description: String that identifies the interface
2315           required: true
2316           type: string
2317           example: __VLAN-INTERFACE__
2318         - name: body
2319           in: body
2320           description: vlan object that needs to be updated.
2321           required: true
2322           schema:
2323             $ref: "#/patchDefinitions/vlan"
2324     delete:
2325       tags:
2326         - CloudInfrastructure
2327       summary: delete an existing vlan
2328       description: delete an existing vlan
2329       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2330       consumes:
2331         - application/json
2332         - application/xml
2333       produces:
2334         - application/json
2335         - application/xml
2336       responses:
2337         "default":
2338           description: Response codes found in [response codes](https://wiki.onap.org/).
2339       parameters:
2340         - name: cloud-owner
2341           in: path
2342           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2343           required: true
2344           type: string
2345           example: __CLOUD-OWNER__
2346         - name: cloud-region-id
2347           in: path
2348           description: Identifier used by the vendor for the region. Second part of composite key
2349           required: true
2350           type: string
2351           example: __CLOUD-REGION-ID__
2352         - name: tenant-id
2353           in: path
2354           description: Unique id relative to the cloud-region.
2355           required: true
2356           type: string
2357           example: __TENANT-ID__
2358         - name: vserver-id
2359           in: path
2360           description: Unique identifier for this vserver relative to its tenant
2361           required: true
2362           type: string
2363           example: __VSERVER-ID__
2364         - name: interface-name
2365           in: path
2366           description: Name given to the interface
2367           required: true
2368           type: string
2369           example: __INTERFACE-NAME__
2370         - name: vlan-interface
2371           in: path
2372           description: String that identifies the interface
2373           required: true
2374           type: string
2375           example: __VLAN-INTERFACE__
2376         - name: resource-version
2377           in: query
2378           description: resource-version for concurrency
2379           required: true
2380           type: string
2381   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans:
2382     get:
2383       tags:
2384         - CloudInfrastructure
2385       summary: returns vlans
2386       description: returns vlans
2387       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans
2388       produces:
2389         - application/json
2390         - application/xml
2391       responses:
2392         "200":
2393           description: successful operation
2394           schema:
2395               $ref: "#/getDefinitions/vlans"
2396         "default":
2397           description: Response codes found in [response codes](https://wiki.onap.org/).
2398       parameters:
2399         - name: cloud-owner
2400           in: path
2401           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2402           required: true
2403           type: string
2404           example: __CLOUD-OWNER__
2405         - name: cloud-region-id
2406           in: path
2407           description: Identifier used by the vendor for the region. Second part of composite key
2408           required: true
2409           type: string
2410           example: __CLOUD-REGION-ID__
2411         - name: tenant-id
2412           in: path
2413           description: Unique id relative to the cloud-region.
2414           required: true
2415           type: string
2416           example: __TENANT-ID__
2417         - name: vserver-id
2418           in: path
2419           description: Unique identifier for this vserver relative to its tenant
2420           required: true
2421           type: string
2422           example: __VSERVER-ID__
2423         - name: interface-name
2424           in: path
2425           description: Name given to the interface
2426           required: true
2427           type: string
2428           example: __INTERFACE-NAME__
2429         - name: vlan-interface
2430           in: query
2431           description:
2432           required: false
2433           type: string
2434         - name: vlan-id-inner
2435           in: query
2436           description:
2437           required: false
2438           type: integer
2439           format: int64
2440         - name: vpn-key
2441           in: query
2442           description:
2443           required: false
2444           type: string
2445   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
2446     put:
2447       tags:
2448         - CloudInfrastructure
2449       summary: see node definition for valid relationships
2450       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2451       consumes:
2452         - application/json
2453         - application/xml
2454       produces:
2455         - application/json
2456         - application/xml
2457       responses:
2458         "default":
2459           description: Response codes found in [response codes](https://wiki.onap.org/).
2460       parameters:
2461         - name: cloud-owner
2462           in: path
2463           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2464           required: true
2465           type: string
2466           example: __CLOUD-OWNER__
2467         - name: cloud-region-id
2468           in: path
2469           description: Identifier used by the vendor for the region. Second part of composite key
2470           required: true
2471           type: string
2472           example: __CLOUD-REGION-ID__
2473         - name: tenant-id
2474           in: path
2475           description: Unique id relative to the cloud-region.
2476           required: true
2477           type: string
2478           example: __TENANT-ID__
2479         - name: vserver-id
2480           in: path
2481           description: Unique identifier for this vserver relative to its tenant
2482           required: true
2483           type: string
2484           example: __VSERVER-ID__
2485         - name: interface-name
2486           in: path
2487           description: Name given to the interface
2488           required: true
2489           type: string
2490           example: __INTERFACE-NAME__
2491         - name: pci-id
2492           in: path
2493           description: PCI ID used to identify the sriov-vf
2494           required: true
2495           type: string
2496           example: __PCI-ID__
2497         - name: body
2498           in: body
2499           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
2500           required: true
2501           schema:
2502             $ref: "#/definitions/relationship"
2503     delete:
2504       tags:
2505         - CloudInfrastructure
2506       summary: delete an existing relationship
2507       description: delete an existing relationship
2508       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2509       consumes:
2510         - application/json
2511         - application/xml
2512       produces:
2513         - application/json
2514         - application/xml
2515       responses:
2516         "default":
2517           description: Response codes found in [response codes](https://wiki.onap.org/).
2518       parameters:
2519         - name: cloud-owner
2520           in: path
2521           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2522           required: true
2523           type: string
2524           example: __CLOUD-OWNER__
2525         - name: cloud-region-id
2526           in: path
2527           description: Identifier used by the vendor for the region. Second part of composite key
2528           required: true
2529           type: string
2530           example: __CLOUD-REGION-ID__
2531         - name: tenant-id
2532           in: path
2533           description: Unique id relative to the cloud-region.
2534           required: true
2535           type: string
2536           example: __TENANT-ID__
2537         - name: vserver-id
2538           in: path
2539           description: Unique identifier for this vserver relative to its tenant
2540           required: true
2541           type: string
2542           example: __VSERVER-ID__
2543         - name: interface-name
2544           in: path
2545           description: Name given to the interface
2546           required: true
2547           type: string
2548           example: __INTERFACE-NAME__
2549         - name: pci-id
2550           in: path
2551           description: PCI ID used to identify the sriov-vf
2552           required: true
2553           type: string
2554           example: __PCI-ID__
2555   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
2556     get:
2557       tags:
2558         - CloudInfrastructure
2559       summary: returns sriov-vf
2560       description: returns sriov-vf
2561       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2562       produces:
2563         - application/json
2564         - application/xml
2565       responses:
2566         "200":
2567           description: successful operation
2568           schema:
2569               $ref: "#/getDefinitions/sriov-vf"
2570         "default":
2571           description: Response codes found in [response codes](https://wiki.onap.org/).
2572       parameters:
2573         - name: cloud-owner
2574           in: path
2575           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2576           required: true
2577           type: string
2578           example: __CLOUD-OWNER__
2579         - name: cloud-region-id
2580           in: path
2581           description: Identifier used by the vendor for the region. Second part of composite key
2582           required: true
2583           type: string
2584           example: __CLOUD-REGION-ID__
2585         - name: tenant-id
2586           in: path
2587           description: Unique id relative to the cloud-region.
2588           required: true
2589           type: string
2590           example: __TENANT-ID__
2591         - name: vserver-id
2592           in: path
2593           description: Unique identifier for this vserver relative to its tenant
2594           required: true
2595           type: string
2596           example: __VSERVER-ID__
2597         - name: interface-name
2598           in: path
2599           description: Name given to the interface
2600           required: true
2601           type: string
2602           example: __INTERFACE-NAME__
2603         - name: pci-id
2604           in: path
2605           description: PCI ID used to identify the sriov-vf
2606           required: true
2607           type: string
2608           example: __PCI-ID__
2609     put:
2610       tags:
2611         - CloudInfrastructure
2612       summary: create or update an existing sriov-vf
2613       description: |
2614         Create or update an existing sriov-vf.
2615         #
2616         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
2617       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2618       consumes:
2619         - application/json
2620         - application/xml
2621       produces:
2622         - application/json
2623         - application/xml
2624       responses:
2625         "default":
2626           description: Response codes found in [response codes](https://wiki.onap.org/).
2627       parameters:
2628         - name: cloud-owner
2629           in: path
2630           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2631           required: true
2632           type: string
2633           example: __CLOUD-OWNER__
2634         - name: cloud-region-id
2635           in: path
2636           description: Identifier used by the vendor for the region. Second part of composite key
2637           required: true
2638           type: string
2639           example: __CLOUD-REGION-ID__
2640         - name: tenant-id
2641           in: path
2642           description: Unique id relative to the cloud-region.
2643           required: true
2644           type: string
2645           example: __TENANT-ID__
2646         - name: vserver-id
2647           in: path
2648           description: Unique identifier for this vserver relative to its tenant
2649           required: true
2650           type: string
2651           example: __VSERVER-ID__
2652         - name: interface-name
2653           in: path
2654           description: Name given to the interface
2655           required: true
2656           type: string
2657           example: __INTERFACE-NAME__
2658         - name: pci-id
2659           in: path
2660           description: PCI ID used to identify the sriov-vf
2661           required: true
2662           type: string
2663           example: __PCI-ID__
2664         - name: body
2665           in: body
2666           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
2667           required: true
2668           schema:
2669             $ref: "#/definitions/sriov-vf"
2670     patch:
2671       tags:
2672         - CloudInfrastructure
2673       summary: update an existing sriov-vf
2674       description: |
2675         Update an existing sriov-vf
2676         #
2677         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2678         The PUT operation will entirely replace an existing object.
2679         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
2680         #
2681         Other differences between PUT and PATCH are:
2682         #
2683         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2684         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2685         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2686       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2687       consumes:
2688         - application/json
2689         - application/xml
2690       produces:
2691         - application/json
2692         - application/xml
2693       responses:
2694         "default":
2695           description: Response codes found in [response codes](https://wiki.onap.org/).
2696       parameters:
2697         - name: cloud-owner
2698           in: path
2699           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2700           required: true
2701           type: string
2702           example: __CLOUD-OWNER__
2703         - name: cloud-region-id
2704           in: path
2705           description: Identifier used by the vendor for the region. Second part of composite key
2706           required: true
2707           type: string
2708           example: __CLOUD-REGION-ID__
2709         - name: tenant-id
2710           in: path
2711           description: Unique id relative to the cloud-region.
2712           required: true
2713           type: string
2714           example: __TENANT-ID__
2715         - name: vserver-id
2716           in: path
2717           description: Unique identifier for this vserver relative to its tenant
2718           required: true
2719           type: string
2720           example: __VSERVER-ID__
2721         - name: interface-name
2722           in: path
2723           description: Name given to the interface
2724           required: true
2725           type: string
2726           example: __INTERFACE-NAME__
2727         - name: pci-id
2728           in: path
2729           description: PCI ID used to identify the sriov-vf
2730           required: true
2731           type: string
2732           example: __PCI-ID__
2733         - name: body
2734           in: body
2735           description: sriov-vf object that needs to be updated.
2736           required: true
2737           schema:
2738             $ref: "#/patchDefinitions/sriov-vf"
2739     delete:
2740       tags:
2741         - CloudInfrastructure
2742       summary: delete an existing sriov-vf
2743       description: delete an existing sriov-vf
2744       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2745       consumes:
2746         - application/json
2747         - application/xml
2748       produces:
2749         - application/json
2750         - application/xml
2751       responses:
2752         "default":
2753           description: Response codes found in [response codes](https://wiki.onap.org/).
2754       parameters:
2755         - name: cloud-owner
2756           in: path
2757           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2758           required: true
2759           type: string
2760           example: __CLOUD-OWNER__
2761         - name: cloud-region-id
2762           in: path
2763           description: Identifier used by the vendor for the region. Second part of composite key
2764           required: true
2765           type: string
2766           example: __CLOUD-REGION-ID__
2767         - name: tenant-id
2768           in: path
2769           description: Unique id relative to the cloud-region.
2770           required: true
2771           type: string
2772           example: __TENANT-ID__
2773         - name: vserver-id
2774           in: path
2775           description: Unique identifier for this vserver relative to its tenant
2776           required: true
2777           type: string
2778           example: __VSERVER-ID__
2779         - name: interface-name
2780           in: path
2781           description: Name given to the interface
2782           required: true
2783           type: string
2784           example: __INTERFACE-NAME__
2785         - name: pci-id
2786           in: path
2787           description: PCI ID used to identify the sriov-vf
2788           required: true
2789           type: string
2790           example: __PCI-ID__
2791         - name: resource-version
2792           in: query
2793           description: resource-version for concurrency
2794           required: true
2795           type: string
2796   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
2797     get:
2798       tags:
2799         - CloudInfrastructure
2800       summary: returns sriov-vfs
2801       description: returns sriov-vfs
2802       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs
2803       produces:
2804         - application/json
2805         - application/xml
2806       responses:
2807         "200":
2808           description: successful operation
2809           schema:
2810               $ref: "#/getDefinitions/sriov-vfs"
2811         "default":
2812           description: Response codes found in [response codes](https://wiki.onap.org/).
2813       parameters:
2814         - name: cloud-owner
2815           in: path
2816           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2817           required: true
2818           type: string
2819           example: __CLOUD-OWNER__
2820         - name: cloud-region-id
2821           in: path
2822           description: Identifier used by the vendor for the region. Second part of composite key
2823           required: true
2824           type: string
2825           example: __CLOUD-REGION-ID__
2826         - name: tenant-id
2827           in: path
2828           description: Unique id relative to the cloud-region.
2829           required: true
2830           type: string
2831           example: __TENANT-ID__
2832         - name: vserver-id
2833           in: path
2834           description: Unique identifier for this vserver relative to its tenant
2835           required: true
2836           type: string
2837           example: __VSERVER-ID__
2838         - name: interface-name
2839           in: path
2840           description: Name given to the interface
2841           required: true
2842           type: string
2843           example: __INTERFACE-NAME__
2844         - name: pci-id
2845           in: query
2846           description:
2847           required: false
2848           type: string
2849         - name: vf-vlan-filter
2850           in: query
2851           description:
2852           required: false
2853           type: string
2854         - name: vf-mac-filter
2855           in: query
2856           description:
2857           required: false
2858           type: string
2859         - name: vf-vlan-strip
2860           in: query
2861           description:
2862           required: false
2863           type: boolean
2864         - name: neutron-network-id
2865           in: query
2866           description:
2867           required: false
2868           type: string
2869   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
2870     put:
2871       tags:
2872         - CloudInfrastructure
2873       summary: see node definition for valid relationships
2874       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
2875       consumes:
2876         - application/json
2877         - application/xml
2878       produces:
2879         - application/json
2880         - application/xml
2881       responses:
2882         "default":
2883           description: Response codes found in [response codes](https://wiki.onap.org/).
2884       parameters:
2885         - name: cloud-owner
2886           in: path
2887           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2888           required: true
2889           type: string
2890           example: __CLOUD-OWNER__
2891         - name: cloud-region-id
2892           in: path
2893           description: Identifier used by the vendor for the region. Second part of composite key
2894           required: true
2895           type: string
2896           example: __CLOUD-REGION-ID__
2897         - name: tenant-id
2898           in: path
2899           description: Unique id relative to the cloud-region.
2900           required: true
2901           type: string
2902           example: __TENANT-ID__
2903         - name: vserver-id
2904           in: path
2905           description: Unique identifier for this vserver relative to its tenant
2906           required: true
2907           type: string
2908           example: __VSERVER-ID__
2909         - name: interface-name
2910           in: path
2911           description: Name given to the interface
2912           required: true
2913           type: string
2914           example: __INTERFACE-NAME__
2915         - name: body
2916           in: body
2917           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
2918           required: true
2919           schema:
2920             $ref: "#/definitions/relationship"
2921     delete:
2922       tags:
2923         - CloudInfrastructure
2924       summary: delete an existing relationship
2925       description: delete an existing relationship
2926       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
2927       consumes:
2928         - application/json
2929         - application/xml
2930       produces:
2931         - application/json
2932         - application/xml
2933       responses:
2934         "default":
2935           description: Response codes found in [response codes](https://wiki.onap.org/).
2936       parameters:
2937         - name: cloud-owner
2938           in: path
2939           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2940           required: true
2941           type: string
2942           example: __CLOUD-OWNER__
2943         - name: cloud-region-id
2944           in: path
2945           description: Identifier used by the vendor for the region. Second part of composite key
2946           required: true
2947           type: string
2948           example: __CLOUD-REGION-ID__
2949         - name: tenant-id
2950           in: path
2951           description: Unique id relative to the cloud-region.
2952           required: true
2953           type: string
2954           example: __TENANT-ID__
2955         - name: vserver-id
2956           in: path
2957           description: Unique identifier for this vserver relative to its tenant
2958           required: true
2959           type: string
2960           example: __VSERVER-ID__
2961         - name: interface-name
2962           in: path
2963           description: Name given to the interface
2964           required: true
2965           type: string
2966           example: __INTERFACE-NAME__
2967   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
2968     put:
2969       tags:
2970         - CloudInfrastructure
2971       summary: see node definition for valid relationships
2972       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
2973       consumes:
2974         - application/json
2975         - application/xml
2976       produces:
2977         - application/json
2978         - application/xml
2979       responses:
2980         "default":
2981           description: Response codes found in [response codes](https://wiki.onap.org/).
2982       parameters:
2983         - name: cloud-owner
2984           in: path
2985           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2986           required: true
2987           type: string
2988           example: __CLOUD-OWNER__
2989         - name: cloud-region-id
2990           in: path
2991           description: Identifier used by the vendor for the region. Second part of composite key
2992           required: true
2993           type: string
2994           example: __CLOUD-REGION-ID__
2995         - name: tenant-id
2996           in: path
2997           description: Unique id relative to the cloud-region.
2998           required: true
2999           type: string
3000           example: __TENANT-ID__
3001         - name: vserver-id
3002           in: path
3003           description: Unique identifier for this vserver relative to its tenant
3004           required: true
3005           type: string
3006           example: __VSERVER-ID__
3007         - name: interface-name
3008           in: path
3009           description: Name given to the interface
3010           required: true
3011           type: string
3012           example: __INTERFACE-NAME__
3013         - name: l3-interface-ipv4-address
3014           in: path
3015           description: IP address
3016           required: true
3017           type: string
3018           example: __L3-INTERFACE-IPV4-ADDRESS__
3019         - name: body
3020           in: body
3021           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3022           required: true
3023           schema:
3024             $ref: "#/definitions/relationship"
3025     delete:
3026       tags:
3027         - CloudInfrastructure
3028       summary: delete an existing relationship
3029       description: delete an existing relationship
3030       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
3031       consumes:
3032         - application/json
3033         - application/xml
3034       produces:
3035         - application/json
3036         - application/xml
3037       responses:
3038         "default":
3039           description: Response codes found in [response codes](https://wiki.onap.org/).
3040       parameters:
3041         - name: cloud-owner
3042           in: path
3043           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3044           required: true
3045           type: string
3046           example: __CLOUD-OWNER__
3047         - name: cloud-region-id
3048           in: path
3049           description: Identifier used by the vendor for the region. Second part of composite key
3050           required: true
3051           type: string
3052           example: __CLOUD-REGION-ID__
3053         - name: tenant-id
3054           in: path
3055           description: Unique id relative to the cloud-region.
3056           required: true
3057           type: string
3058           example: __TENANT-ID__
3059         - name: vserver-id
3060           in: path
3061           description: Unique identifier for this vserver relative to its tenant
3062           required: true
3063           type: string
3064           example: __VSERVER-ID__
3065         - name: interface-name
3066           in: path
3067           description: Name given to the interface
3068           required: true
3069           type: string
3070           example: __INTERFACE-NAME__
3071         - name: l3-interface-ipv4-address
3072           in: path
3073           description: IP address
3074           required: true
3075           type: string
3076           example: __L3-INTERFACE-IPV4-ADDRESS__
3077   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
3078     get:
3079       tags:
3080         - CloudInfrastructure
3081       summary: returns l3-interface-ipv4-address-list
3082       description: returns l3-interface-ipv4-address-list
3083       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3084       produces:
3085         - application/json
3086         - application/xml
3087       responses:
3088         "200":
3089           description: successful operation
3090           schema:
3091               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
3092         "default":
3093           description: Response codes found in [response codes](https://wiki.onap.org/).
3094       parameters:
3095         - name: cloud-owner
3096           in: path
3097           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3098           required: true
3099           type: string
3100           example: __CLOUD-OWNER__
3101         - name: cloud-region-id
3102           in: path
3103           description: Identifier used by the vendor for the region. Second part of composite key
3104           required: true
3105           type: string
3106           example: __CLOUD-REGION-ID__
3107         - name: tenant-id
3108           in: path
3109           description: Unique id relative to the cloud-region.
3110           required: true
3111           type: string
3112           example: __TENANT-ID__
3113         - name: vserver-id
3114           in: path
3115           description: Unique identifier for this vserver relative to its tenant
3116           required: true
3117           type: string
3118           example: __VSERVER-ID__
3119         - name: interface-name
3120           in: path
3121           description: Name given to the interface
3122           required: true
3123           type: string
3124           example: __INTERFACE-NAME__
3125         - name: l3-interface-ipv4-address
3126           in: path
3127           description: IP address
3128           required: true
3129           type: string
3130           example: __L3-INTERFACE-IPV4-ADDRESS__
3131     put:
3132       tags:
3133         - CloudInfrastructure
3134       summary: create or update an existing l3-interface-ipv4-address-list
3135       description: |
3136         Create or update an existing l3-interface-ipv4-address-list.
3137         #
3138         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3139       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3140       consumes:
3141         - application/json
3142         - application/xml
3143       produces:
3144         - application/json
3145         - application/xml
3146       responses:
3147         "default":
3148           description: Response codes found in [response codes](https://wiki.onap.org/).
3149       parameters:
3150         - name: cloud-owner
3151           in: path
3152           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3153           required: true
3154           type: string
3155           example: __CLOUD-OWNER__
3156         - name: cloud-region-id
3157           in: path
3158           description: Identifier used by the vendor for the region. Second part of composite key
3159           required: true
3160           type: string
3161           example: __CLOUD-REGION-ID__
3162         - name: tenant-id
3163           in: path
3164           description: Unique id relative to the cloud-region.
3165           required: true
3166           type: string
3167           example: __TENANT-ID__
3168         - name: vserver-id
3169           in: path
3170           description: Unique identifier for this vserver relative to its tenant
3171           required: true
3172           type: string
3173           example: __VSERVER-ID__
3174         - name: interface-name
3175           in: path
3176           description: Name given to the interface
3177           required: true
3178           type: string
3179           example: __INTERFACE-NAME__
3180         - name: l3-interface-ipv4-address
3181           in: path
3182           description: IP address
3183           required: true
3184           type: string
3185           example: __L3-INTERFACE-IPV4-ADDRESS__
3186         - name: body
3187           in: body
3188           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3189           required: true
3190           schema:
3191             $ref: "#/definitions/l3-interface-ipv4-address-list"
3192     patch:
3193       tags:
3194         - CloudInfrastructure
3195       summary: update an existing l3-interface-ipv4-address-list
3196       description: |
3197         Update an existing l3-interface-ipv4-address-list
3198         #
3199         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3200         The PUT operation will entirely replace an existing object.
3201         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
3202         #
3203         Other differences between PUT and PATCH are:
3204         #
3205         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
3206         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3207         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3208       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3209       consumes:
3210         - application/json
3211         - application/xml
3212       produces:
3213         - application/json
3214         - application/xml
3215       responses:
3216         "default":
3217           description: Response codes found in [response codes](https://wiki.onap.org/).
3218       parameters:
3219         - name: cloud-owner
3220           in: path
3221           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3222           required: true
3223           type: string
3224           example: __CLOUD-OWNER__
3225         - name: cloud-region-id
3226           in: path
3227           description: Identifier used by the vendor for the region. Second part of composite key
3228           required: true
3229           type: string
3230           example: __CLOUD-REGION-ID__
3231         - name: tenant-id
3232           in: path
3233           description: Unique id relative to the cloud-region.
3234           required: true
3235           type: string
3236           example: __TENANT-ID__
3237         - name: vserver-id
3238           in: path
3239           description: Unique identifier for this vserver relative to its tenant
3240           required: true
3241           type: string
3242           example: __VSERVER-ID__
3243         - name: interface-name
3244           in: path
3245           description: Name given to the interface
3246           required: true
3247           type: string
3248           example: __INTERFACE-NAME__
3249         - name: l3-interface-ipv4-address
3250           in: path
3251           description: IP address
3252           required: true
3253           type: string
3254           example: __L3-INTERFACE-IPV4-ADDRESS__
3255         - name: body
3256           in: body
3257           description: l3-interface-ipv4-address-list object that needs to be updated.
3258           required: true
3259           schema:
3260             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
3261     delete:
3262       tags:
3263         - CloudInfrastructure
3264       summary: delete an existing l3-interface-ipv4-address-list
3265       description: delete an existing l3-interface-ipv4-address-list
3266       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3267       consumes:
3268         - application/json
3269         - application/xml
3270       produces:
3271         - application/json
3272         - application/xml
3273       responses:
3274         "default":
3275           description: Response codes found in [response codes](https://wiki.onap.org/).
3276       parameters:
3277         - name: cloud-owner
3278           in: path
3279           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3280           required: true
3281           type: string
3282           example: __CLOUD-OWNER__
3283         - name: cloud-region-id
3284           in: path
3285           description: Identifier used by the vendor for the region. Second part of composite key
3286           required: true
3287           type: string
3288           example: __CLOUD-REGION-ID__
3289         - name: tenant-id
3290           in: path
3291           description: Unique id relative to the cloud-region.
3292           required: true
3293           type: string
3294           example: __TENANT-ID__
3295         - name: vserver-id
3296           in: path
3297           description: Unique identifier for this vserver relative to its tenant
3298           required: true
3299           type: string
3300           example: __VSERVER-ID__
3301         - name: interface-name
3302           in: path
3303           description: Name given to the interface
3304           required: true
3305           type: string
3306           example: __INTERFACE-NAME__
3307         - name: l3-interface-ipv4-address
3308           in: path
3309           description: IP address
3310           required: true
3311           type: string
3312           example: __L3-INTERFACE-IPV4-ADDRESS__
3313         - name: resource-version
3314           in: query
3315           description: resource-version for concurrency
3316           required: true
3317           type: string
3318   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
3319     put:
3320       tags:
3321         - CloudInfrastructure
3322       summary: see node definition for valid relationships
3323       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3324       consumes:
3325         - application/json
3326         - application/xml
3327       produces:
3328         - application/json
3329         - application/xml
3330       responses:
3331         "default":
3332           description: Response codes found in [response codes](https://wiki.onap.org/).
3333       parameters:
3334         - name: cloud-owner
3335           in: path
3336           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3337           required: true
3338           type: string
3339           example: __CLOUD-OWNER__
3340         - name: cloud-region-id
3341           in: path
3342           description: Identifier used by the vendor for the region. Second part of composite key
3343           required: true
3344           type: string
3345           example: __CLOUD-REGION-ID__
3346         - name: tenant-id
3347           in: path
3348           description: Unique id relative to the cloud-region.
3349           required: true
3350           type: string
3351           example: __TENANT-ID__
3352         - name: vserver-id
3353           in: path
3354           description: Unique identifier for this vserver relative to its tenant
3355           required: true
3356           type: string
3357           example: __VSERVER-ID__
3358         - name: interface-name
3359           in: path
3360           description: Name given to the interface
3361           required: true
3362           type: string
3363           example: __INTERFACE-NAME__
3364         - name: l3-interface-ipv6-address
3365           in: path
3366           description: IP address
3367           required: true
3368           type: string
3369           example: __L3-INTERFACE-IPV6-ADDRESS__
3370         - name: body
3371           in: body
3372           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
3373           required: true
3374           schema:
3375             $ref: "#/definitions/relationship"
3376     delete:
3377       tags:
3378         - CloudInfrastructure
3379       summary: delete an existing relationship
3380       description: delete an existing relationship
3381       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3382       consumes:
3383         - application/json
3384         - application/xml
3385       produces:
3386         - application/json
3387         - application/xml
3388       responses:
3389         "default":
3390           description: Response codes found in [response codes](https://wiki.onap.org/).
3391       parameters:
3392         - name: cloud-owner
3393           in: path
3394           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3395           required: true
3396           type: string
3397           example: __CLOUD-OWNER__
3398         - name: cloud-region-id
3399           in: path
3400           description: Identifier used by the vendor for the region. Second part of composite key
3401           required: true
3402           type: string
3403           example: __CLOUD-REGION-ID__
3404         - name: tenant-id
3405           in: path
3406           description: Unique id relative to the cloud-region.
3407           required: true
3408           type: string
3409           example: __TENANT-ID__
3410         - name: vserver-id
3411           in: path
3412           description: Unique identifier for this vserver relative to its tenant
3413           required: true
3414           type: string
3415           example: __VSERVER-ID__
3416         - name: interface-name
3417           in: path
3418           description: Name given to the interface
3419           required: true
3420           type: string
3421           example: __INTERFACE-NAME__
3422         - name: l3-interface-ipv6-address
3423           in: path
3424           description: IP address
3425           required: true
3426           type: string
3427           example: __L3-INTERFACE-IPV6-ADDRESS__
3428   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
3429     get:
3430       tags:
3431         - CloudInfrastructure
3432       summary: returns l3-interface-ipv6-address-list
3433       description: returns l3-interface-ipv6-address-list
3434       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3435       produces:
3436         - application/json
3437         - application/xml
3438       responses:
3439         "200":
3440           description: successful operation
3441           schema:
3442               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
3443         "default":
3444           description: Response codes found in [response codes](https://wiki.onap.org/).
3445       parameters:
3446         - name: cloud-owner
3447           in: path
3448           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3449           required: true
3450           type: string
3451           example: __CLOUD-OWNER__
3452         - name: cloud-region-id
3453           in: path
3454           description: Identifier used by the vendor for the region. Second part of composite key
3455           required: true
3456           type: string
3457           example: __CLOUD-REGION-ID__
3458         - name: tenant-id
3459           in: path
3460           description: Unique id relative to the cloud-region.
3461           required: true
3462           type: string
3463           example: __TENANT-ID__
3464         - name: vserver-id
3465           in: path
3466           description: Unique identifier for this vserver relative to its tenant
3467           required: true
3468           type: string
3469           example: __VSERVER-ID__
3470         - name: interface-name
3471           in: path
3472           description: Name given to the interface
3473           required: true
3474           type: string
3475           example: __INTERFACE-NAME__
3476         - name: l3-interface-ipv6-address
3477           in: path
3478           description: IP address
3479           required: true
3480           type: string
3481           example: __L3-INTERFACE-IPV6-ADDRESS__
3482     put:
3483       tags:
3484         - CloudInfrastructure
3485       summary: create or update an existing l3-interface-ipv6-address-list
3486       description: |
3487         Create or update an existing l3-interface-ipv6-address-list.
3488         #
3489         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3490       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3491       consumes:
3492         - application/json
3493         - application/xml
3494       produces:
3495         - application/json
3496         - application/xml
3497       responses:
3498         "default":
3499           description: Response codes found in [response codes](https://wiki.onap.org/).
3500       parameters:
3501         - name: cloud-owner
3502           in: path
3503           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3504           required: true
3505           type: string
3506           example: __CLOUD-OWNER__
3507         - name: cloud-region-id
3508           in: path
3509           description: Identifier used by the vendor for the region. Second part of composite key
3510           required: true
3511           type: string
3512           example: __CLOUD-REGION-ID__
3513         - name: tenant-id
3514           in: path
3515           description: Unique id relative to the cloud-region.
3516           required: true
3517           type: string
3518           example: __TENANT-ID__
3519         - name: vserver-id
3520           in: path
3521           description: Unique identifier for this vserver relative to its tenant
3522           required: true
3523           type: string
3524           example: __VSERVER-ID__
3525         - name: interface-name
3526           in: path
3527           description: Name given to the interface
3528           required: true
3529           type: string
3530           example: __INTERFACE-NAME__
3531         - name: l3-interface-ipv6-address
3532           in: path
3533           description: IP address
3534           required: true
3535           type: string
3536           example: __L3-INTERFACE-IPV6-ADDRESS__
3537         - name: body
3538           in: body
3539           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
3540           required: true
3541           schema:
3542             $ref: "#/definitions/l3-interface-ipv6-address-list"
3543     patch:
3544       tags:
3545         - CloudInfrastructure
3546       summary: update an existing l3-interface-ipv6-address-list
3547       description: |
3548         Update an existing l3-interface-ipv6-address-list
3549         #
3550         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3551         The PUT operation will entirely replace an existing object.
3552         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
3553         #
3554         Other differences between PUT and PATCH are:
3555         #
3556         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
3557         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3558         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3559       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3560       consumes:
3561         - application/json
3562         - application/xml
3563       produces:
3564         - application/json
3565         - application/xml
3566       responses:
3567         "default":
3568           description: Response codes found in [response codes](https://wiki.onap.org/).
3569       parameters:
3570         - name: cloud-owner
3571           in: path
3572           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3573           required: true
3574           type: string
3575           example: __CLOUD-OWNER__
3576         - name: cloud-region-id
3577           in: path
3578           description: Identifier used by the vendor for the region. Second part of composite key
3579           required: true
3580           type: string
3581           example: __CLOUD-REGION-ID__
3582         - name: tenant-id
3583           in: path
3584           description: Unique id relative to the cloud-region.
3585           required: true
3586           type: string
3587           example: __TENANT-ID__
3588         - name: vserver-id
3589           in: path
3590           description: Unique identifier for this vserver relative to its tenant
3591           required: true
3592           type: string
3593           example: __VSERVER-ID__
3594         - name: interface-name
3595           in: path
3596           description: Name given to the interface
3597           required: true
3598           type: string
3599           example: __INTERFACE-NAME__
3600         - name: l3-interface-ipv6-address
3601           in: path
3602           description: IP address
3603           required: true
3604           type: string
3605           example: __L3-INTERFACE-IPV6-ADDRESS__
3606         - name: body
3607           in: body
3608           description: l3-interface-ipv6-address-list object that needs to be updated.
3609           required: true
3610           schema:
3611             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
3612     delete:
3613       tags:
3614         - CloudInfrastructure
3615       summary: delete an existing l3-interface-ipv6-address-list
3616       description: delete an existing l3-interface-ipv6-address-list
3617       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3618       consumes:
3619         - application/json
3620         - application/xml
3621       produces:
3622         - application/json
3623         - application/xml
3624       responses:
3625         "default":
3626           description: Response codes found in [response codes](https://wiki.onap.org/).
3627       parameters:
3628         - name: cloud-owner
3629           in: path
3630           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3631           required: true
3632           type: string
3633           example: __CLOUD-OWNER__
3634         - name: cloud-region-id
3635           in: path
3636           description: Identifier used by the vendor for the region. Second part of composite key
3637           required: true
3638           type: string
3639           example: __CLOUD-REGION-ID__
3640         - name: tenant-id
3641           in: path
3642           description: Unique id relative to the cloud-region.
3643           required: true
3644           type: string
3645           example: __TENANT-ID__
3646         - name: vserver-id
3647           in: path
3648           description: Unique identifier for this vserver relative to its tenant
3649           required: true
3650           type: string
3651           example: __VSERVER-ID__
3652         - name: interface-name
3653           in: path
3654           description: Name given to the interface
3655           required: true
3656           type: string
3657           example: __INTERFACE-NAME__
3658         - name: l3-interface-ipv6-address
3659           in: path
3660           description: IP address
3661           required: true
3662           type: string
3663           example: __L3-INTERFACE-IPV6-ADDRESS__
3664         - name: resource-version
3665           in: query
3666           description: resource-version for concurrency
3667           required: true
3668           type: string
3669   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}:
3670     get:
3671       tags:
3672         - CloudInfrastructure
3673       summary: returns l-interface
3674       description: returns l-interface
3675       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3676       produces:
3677         - application/json
3678         - application/xml
3679       responses:
3680         "200":
3681           description: successful operation
3682           schema:
3683               $ref: "#/getDefinitions/l-interface"
3684         "default":
3685           description: Response codes found in [response codes](https://wiki.onap.org/).
3686       parameters:
3687         - name: cloud-owner
3688           in: path
3689           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3690           required: true
3691           type: string
3692           example: __CLOUD-OWNER__
3693         - name: cloud-region-id
3694           in: path
3695           description: Identifier used by the vendor for the region. Second part of composite key
3696           required: true
3697           type: string
3698           example: __CLOUD-REGION-ID__
3699         - name: tenant-id
3700           in: path
3701           description: Unique id relative to the cloud-region.
3702           required: true
3703           type: string
3704           example: __TENANT-ID__
3705         - name: vserver-id
3706           in: path
3707           description: Unique identifier for this vserver relative to its tenant
3708           required: true
3709           type: string
3710           example: __VSERVER-ID__
3711         - name: interface-name
3712           in: path
3713           description: Name given to the interface
3714           required: true
3715           type: string
3716           example: __INTERFACE-NAME__
3717     put:
3718       tags:
3719         - CloudInfrastructure
3720       summary: create or update an existing l-interface
3721       description: |
3722         Create or update an existing l-interface.
3723         #
3724         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3725       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3726       consumes:
3727         - application/json
3728         - application/xml
3729       produces:
3730         - application/json
3731         - application/xml
3732       responses:
3733         "default":
3734           description: Response codes found in [response codes](https://wiki.onap.org/).
3735       parameters:
3736         - name: cloud-owner
3737           in: path
3738           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3739           required: true
3740           type: string
3741           example: __CLOUD-OWNER__
3742         - name: cloud-region-id
3743           in: path
3744           description: Identifier used by the vendor for the region. Second part of composite key
3745           required: true
3746           type: string
3747           example: __CLOUD-REGION-ID__
3748         - name: tenant-id
3749           in: path
3750           description: Unique id relative to the cloud-region.
3751           required: true
3752           type: string
3753           example: __TENANT-ID__
3754         - name: vserver-id
3755           in: path
3756           description: Unique identifier for this vserver relative to its tenant
3757           required: true
3758           type: string
3759           example: __VSERVER-ID__
3760         - name: interface-name
3761           in: path
3762           description: Name given to the interface
3763           required: true
3764           type: string
3765           example: __INTERFACE-NAME__
3766         - name: body
3767           in: body
3768           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
3769           required: true
3770           schema:
3771             $ref: "#/definitions/l-interface"
3772     patch:
3773       tags:
3774         - CloudInfrastructure
3775       summary: update an existing l-interface
3776       description: |
3777         Update an existing l-interface
3778         #
3779         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3780         The PUT operation will entirely replace an existing object.
3781         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
3782         #
3783         Other differences between PUT and PATCH are:
3784         #
3785         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
3786         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3787         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3788       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3789       consumes:
3790         - application/json
3791         - application/xml
3792       produces:
3793         - application/json
3794         - application/xml
3795       responses:
3796         "default":
3797           description: Response codes found in [response codes](https://wiki.onap.org/).
3798       parameters:
3799         - name: cloud-owner
3800           in: path
3801           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3802           required: true
3803           type: string
3804           example: __CLOUD-OWNER__
3805         - name: cloud-region-id
3806           in: path
3807           description: Identifier used by the vendor for the region. Second part of composite key
3808           required: true
3809           type: string
3810           example: __CLOUD-REGION-ID__
3811         - name: tenant-id
3812           in: path
3813           description: Unique id relative to the cloud-region.
3814           required: true
3815           type: string
3816           example: __TENANT-ID__
3817         - name: vserver-id
3818           in: path
3819           description: Unique identifier for this vserver relative to its tenant
3820           required: true
3821           type: string
3822           example: __VSERVER-ID__
3823         - name: interface-name
3824           in: path
3825           description: Name given to the interface
3826           required: true
3827           type: string
3828           example: __INTERFACE-NAME__
3829         - name: body
3830           in: body
3831           description: l-interface object that needs to be updated.
3832           required: true
3833           schema:
3834             $ref: "#/patchDefinitions/l-interface"
3835     delete:
3836       tags:
3837         - CloudInfrastructure
3838       summary: delete an existing l-interface
3839       description: delete an existing l-interface
3840       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3841       consumes:
3842         - application/json
3843         - application/xml
3844       produces:
3845         - application/json
3846         - application/xml
3847       responses:
3848         "default":
3849           description: Response codes found in [response codes](https://wiki.onap.org/).
3850       parameters:
3851         - name: cloud-owner
3852           in: path
3853           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3854           required: true
3855           type: string
3856           example: __CLOUD-OWNER__
3857         - name: cloud-region-id
3858           in: path
3859           description: Identifier used by the vendor for the region. Second part of composite key
3860           required: true
3861           type: string
3862           example: __CLOUD-REGION-ID__
3863         - name: tenant-id
3864           in: path
3865           description: Unique id relative to the cloud-region.
3866           required: true
3867           type: string
3868           example: __TENANT-ID__
3869         - name: vserver-id
3870           in: path
3871           description: Unique identifier for this vserver relative to its tenant
3872           required: true
3873           type: string
3874           example: __VSERVER-ID__
3875         - name: interface-name
3876           in: path
3877           description: Name given to the interface
3878           required: true
3879           type: string
3880           example: __INTERFACE-NAME__
3881         - name: resource-version
3882           in: query
3883           description: resource-version for concurrency
3884           required: true
3885           type: string
3886   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces:
3887     get:
3888       tags:
3889         - CloudInfrastructure
3890       summary: returns l-interfaces
3891       description: returns l-interfaces
3892       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces
3893       produces:
3894         - application/json
3895         - application/xml
3896       responses:
3897         "200":
3898           description: successful operation
3899           schema:
3900               $ref: "#/getDefinitions/l-interfaces"
3901         "default":
3902           description: Response codes found in [response codes](https://wiki.onap.org/).
3903       parameters:
3904         - name: cloud-owner
3905           in: path
3906           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3907           required: true
3908           type: string
3909           example: __CLOUD-OWNER__
3910         - name: cloud-region-id
3911           in: path
3912           description: Identifier used by the vendor for the region. Second part of composite key
3913           required: true
3914           type: string
3915           example: __CLOUD-REGION-ID__
3916         - name: tenant-id
3917           in: path
3918           description: Unique id relative to the cloud-region.
3919           required: true
3920           type: string
3921           example: __TENANT-ID__
3922         - name: vserver-id
3923           in: path
3924           description: Unique identifier for this vserver relative to its tenant
3925           required: true
3926           type: string
3927           example: __VSERVER-ID__
3928         - name: interface-name
3929           in: query
3930           description:
3931           required: false
3932           type: string
3933         - name: interface-id
3934           in: query
3935           description:
3936           required: false
3937           type: string
3938         - name: macaddr
3939           in: query
3940           description:
3941           required: false
3942           type: string
3943         - name: network-name
3944           in: query
3945           description:
3946           required: false
3947           type: string
3948   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}:
3949     get:
3950       tags:
3951         - CloudInfrastructure
3952       summary: returns vserver
3953       description: returns vserver
3954       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
3955       produces:
3956         - application/json
3957         - application/xml
3958       responses:
3959         "200":
3960           description: successful operation
3961           schema:
3962               $ref: "#/getDefinitions/vserver"
3963         "default":
3964           description: Response codes found in [response codes](https://wiki.onap.org/).
3965       parameters:
3966         - name: cloud-owner
3967           in: path
3968           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3969           required: true
3970           type: string
3971           example: __CLOUD-OWNER__
3972         - name: cloud-region-id
3973           in: path
3974           description: Identifier used by the vendor for the region. Second part of composite key
3975           required: true
3976           type: string
3977           example: __CLOUD-REGION-ID__
3978         - name: tenant-id
3979           in: path
3980           description: Unique id relative to the cloud-region.
3981           required: true
3982           type: string
3983           example: __TENANT-ID__
3984         - name: vserver-id
3985           in: path
3986           description: Unique identifier for this vserver relative to its tenant
3987           required: true
3988           type: string
3989           example: __VSERVER-ID__
3990     put:
3991       tags:
3992         - CloudInfrastructure
3993       summary: create or update an existing vserver
3994       description: |
3995         Create or update an existing vserver.
3996         #
3997         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3998       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
3999       consumes:
4000         - application/json
4001         - application/xml
4002       produces:
4003         - application/json
4004         - application/xml
4005       responses:
4006         "default":
4007           description: Response codes found in [response codes](https://wiki.onap.org/).
4008       parameters:
4009         - name: cloud-owner
4010           in: path
4011           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4012           required: true
4013           type: string
4014           example: __CLOUD-OWNER__
4015         - name: cloud-region-id
4016           in: path
4017           description: Identifier used by the vendor for the region. Second part of composite key
4018           required: true
4019           type: string
4020           example: __CLOUD-REGION-ID__
4021         - name: tenant-id
4022           in: path
4023           description: Unique id relative to the cloud-region.
4024           required: true
4025           type: string
4026           example: __TENANT-ID__
4027         - name: vserver-id
4028           in: path
4029           description: Unique identifier for this vserver relative to its tenant
4030           required: true
4031           type: string
4032           example: __VSERVER-ID__
4033         - name: body
4034           in: body
4035           description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
4036           required: true
4037           schema:
4038             $ref: "#/definitions/vserver"
4039     patch:
4040       tags:
4041         - CloudInfrastructure
4042       summary: update an existing vserver
4043       description: |
4044         Update an existing vserver
4045         #
4046         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4047         The PUT operation will entirely replace an existing object.
4048         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4049         #
4050         Other differences between PUT and PATCH are:
4051         #
4052         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4053         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4054         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4055       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4056       consumes:
4057         - application/json
4058         - application/xml
4059       produces:
4060         - application/json
4061         - application/xml
4062       responses:
4063         "default":
4064           description: Response codes found in [response codes](https://wiki.onap.org/).
4065       parameters:
4066         - name: cloud-owner
4067           in: path
4068           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4069           required: true
4070           type: string
4071           example: __CLOUD-OWNER__
4072         - name: cloud-region-id
4073           in: path
4074           description: Identifier used by the vendor for the region. Second part of composite key
4075           required: true
4076           type: string
4077           example: __CLOUD-REGION-ID__
4078         - name: tenant-id
4079           in: path
4080           description: Unique id relative to the cloud-region.
4081           required: true
4082           type: string
4083           example: __TENANT-ID__
4084         - name: vserver-id
4085           in: path
4086           description: Unique identifier for this vserver relative to its tenant
4087           required: true
4088           type: string
4089           example: __VSERVER-ID__
4090         - name: body
4091           in: body
4092           description: vserver object that needs to be updated.
4093           required: true
4094           schema:
4095             $ref: "#/patchDefinitions/vserver"
4096     delete:
4097       tags:
4098         - CloudInfrastructure
4099       summary: delete an existing vserver
4100       description: delete an existing vserver
4101       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4102       consumes:
4103         - application/json
4104         - application/xml
4105       produces:
4106         - application/json
4107         - application/xml
4108       responses:
4109         "default":
4110           description: Response codes found in [response codes](https://wiki.onap.org/).
4111       parameters:
4112         - name: cloud-owner
4113           in: path
4114           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4115           required: true
4116           type: string
4117           example: __CLOUD-OWNER__
4118         - name: cloud-region-id
4119           in: path
4120           description: Identifier used by the vendor for the region. Second part of composite key
4121           required: true
4122           type: string
4123           example: __CLOUD-REGION-ID__
4124         - name: tenant-id
4125           in: path
4126           description: Unique id relative to the cloud-region.
4127           required: true
4128           type: string
4129           example: __TENANT-ID__
4130         - name: vserver-id
4131           in: path
4132           description: Unique identifier for this vserver relative to its tenant
4133           required: true
4134           type: string
4135           example: __VSERVER-ID__
4136         - name: resource-version
4137           in: query
4138           description: resource-version for concurrency
4139           required: true
4140           type: string
4141   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers:
4142     get:
4143       tags:
4144         - CloudInfrastructure
4145       summary: returns vservers
4146       description: returns vservers
4147       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers
4148       produces:
4149         - application/json
4150         - application/xml
4151       responses:
4152         "200":
4153           description: successful operation
4154           schema:
4155               $ref: "#/getDefinitions/vservers"
4156         "default":
4157           description: Response codes found in [response codes](https://wiki.onap.org/).
4158       parameters:
4159         - name: cloud-owner
4160           in: path
4161           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4162           required: true
4163           type: string
4164           example: __CLOUD-OWNER__
4165         - name: cloud-region-id
4166           in: path
4167           description: Identifier used by the vendor for the region. Second part of composite key
4168           required: true
4169           type: string
4170           example: __CLOUD-REGION-ID__
4171         - name: tenant-id
4172           in: path
4173           description: Unique id relative to the cloud-region.
4174           required: true
4175           type: string
4176           example: __TENANT-ID__
4177         - name: vserver-id
4178           in: query
4179           description:
4180           required: false
4181           type: string
4182         - name: vserver-name
4183           in: query
4184           description:
4185           required: false
4186           type: string
4187         - name: vserver-name2
4188           in: query
4189           description:
4190           required: false
4191           type: string
4192         - name: prov-status
4193           in: query
4194           description:
4195           required: false
4196           type: string
4197         - name: in-maint
4198           in: query
4199           description:
4200           required: false
4201           type: boolean
4202         - name: is-closed-loop-disabled
4203           in: query
4204           description:
4205           required: false
4206           type: boolean
4207   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship:
4208     put:
4209       tags:
4210         - CloudInfrastructure
4211       summary: see node definition for valid relationships
4212       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
4213       consumes:
4214         - application/json
4215         - application/xml
4216       produces:
4217         - application/json
4218         - application/xml
4219       responses:
4220         "default":
4221           description: Response codes found in [response codes](https://wiki.onap.org/).
4222       parameters:
4223         - name: cloud-owner
4224           in: path
4225           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4226           required: true
4227           type: string
4228           example: __CLOUD-OWNER__
4229         - name: cloud-region-id
4230           in: path
4231           description: Identifier used by the vendor for the region. Second part of composite key
4232           required: true
4233           type: string
4234           example: __CLOUD-REGION-ID__
4235         - name: tenant-id
4236           in: path
4237           description: Unique id relative to the cloud-region.
4238           required: true
4239           type: string
4240           example: __TENANT-ID__
4241         - name: body
4242           in: body
4243           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
4244           required: true
4245           schema:
4246             $ref: "#/definitions/relationship"
4247     delete:
4248       tags:
4249         - CloudInfrastructure
4250       summary: delete an existing relationship
4251       description: delete an existing relationship
4252       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
4253       consumes:
4254         - application/json
4255         - application/xml
4256       produces:
4257         - application/json
4258         - application/xml
4259       responses:
4260         "default":
4261           description: Response codes found in [response codes](https://wiki.onap.org/).
4262       parameters:
4263         - name: cloud-owner
4264           in: path
4265           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4266           required: true
4267           type: string
4268           example: __CLOUD-OWNER__
4269         - name: cloud-region-id
4270           in: path
4271           description: Identifier used by the vendor for the region. Second part of composite key
4272           required: true
4273           type: string
4274           example: __CLOUD-REGION-ID__
4275         - name: tenant-id
4276           in: path
4277           description: Unique id relative to the cloud-region.
4278           required: true
4279           type: string
4280           example: __TENANT-ID__
4281   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}:
4282     get:
4283       tags:
4284         - CloudInfrastructure
4285       summary: returns tenant
4286       description: returns tenant
4287       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4288       produces:
4289         - application/json
4290         - application/xml
4291       responses:
4292         "200":
4293           description: successful operation
4294           schema:
4295               $ref: "#/getDefinitions/tenant"
4296         "default":
4297           description: Response codes found in [response codes](https://wiki.onap.org/).
4298       parameters:
4299         - name: cloud-owner
4300           in: path
4301           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4302           required: true
4303           type: string
4304           example: __CLOUD-OWNER__
4305         - name: cloud-region-id
4306           in: path
4307           description: Identifier used by the vendor for the region. Second part of composite key
4308           required: true
4309           type: string
4310           example: __CLOUD-REGION-ID__
4311         - name: tenant-id
4312           in: path
4313           description: Unique id relative to the cloud-region.
4314           required: true
4315           type: string
4316           example: __TENANT-ID__
4317     put:
4318       tags:
4319         - CloudInfrastructure
4320       summary: create or update an existing tenant
4321       description: |
4322         Create or update an existing tenant.
4323         #
4324         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4325       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4326       consumes:
4327         - application/json
4328         - application/xml
4329       produces:
4330         - application/json
4331         - application/xml
4332       responses:
4333         "default":
4334           description: Response codes found in [response codes](https://wiki.onap.org/).
4335       parameters:
4336         - name: cloud-owner
4337           in: path
4338           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4339           required: true
4340           type: string
4341           example: __CLOUD-OWNER__
4342         - name: cloud-region-id
4343           in: path
4344           description: Identifier used by the vendor for the region. Second part of composite key
4345           required: true
4346           type: string
4347           example: __CLOUD-REGION-ID__
4348         - name: tenant-id
4349           in: path
4350           description: Unique id relative to the cloud-region.
4351           required: true
4352           type: string
4353           example: __TENANT-ID__
4354         - name: body
4355           in: body
4356           description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
4357           required: true
4358           schema:
4359             $ref: "#/definitions/tenant"
4360     patch:
4361       tags:
4362         - CloudInfrastructure
4363       summary: update an existing tenant
4364       description: |
4365         Update an existing tenant
4366         #
4367         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4368         The PUT operation will entirely replace an existing object.
4369         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4370         #
4371         Other differences between PUT and PATCH are:
4372         #
4373         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4374         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4375         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4376       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4377       consumes:
4378         - application/json
4379         - application/xml
4380       produces:
4381         - application/json
4382         - application/xml
4383       responses:
4384         "default":
4385           description: Response codes found in [response codes](https://wiki.onap.org/).
4386       parameters:
4387         - name: cloud-owner
4388           in: path
4389           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4390           required: true
4391           type: string
4392           example: __CLOUD-OWNER__
4393         - name: cloud-region-id
4394           in: path
4395           description: Identifier used by the vendor for the region. Second part of composite key
4396           required: true
4397           type: string
4398           example: __CLOUD-REGION-ID__
4399         - name: tenant-id
4400           in: path
4401           description: Unique id relative to the cloud-region.
4402           required: true
4403           type: string
4404           example: __TENANT-ID__
4405         - name: body
4406           in: body
4407           description: tenant object that needs to be updated.
4408           required: true
4409           schema:
4410             $ref: "#/patchDefinitions/tenant"
4411     delete:
4412       tags:
4413         - CloudInfrastructure
4414       summary: delete an existing tenant
4415       description: delete an existing tenant
4416       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4417       consumes:
4418         - application/json
4419         - application/xml
4420       produces:
4421         - application/json
4422         - application/xml
4423       responses:
4424         "default":
4425           description: Response codes found in [response codes](https://wiki.onap.org/).
4426       parameters:
4427         - name: cloud-owner
4428           in: path
4429           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4430           required: true
4431           type: string
4432           example: __CLOUD-OWNER__
4433         - name: cloud-region-id
4434           in: path
4435           description: Identifier used by the vendor for the region. Second part of composite key
4436           required: true
4437           type: string
4438           example: __CLOUD-REGION-ID__
4439         - name: tenant-id
4440           in: path
4441           description: Unique id relative to the cloud-region.
4442           required: true
4443           type: string
4444           example: __TENANT-ID__
4445         - name: resource-version
4446           in: query
4447           description: resource-version for concurrency
4448           required: true
4449           type: string
4450   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants:
4451     get:
4452       tags:
4453         - CloudInfrastructure
4454       summary: returns tenants
4455       description: returns tenants
4456       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants
4457       produces:
4458         - application/json
4459         - application/xml
4460       responses:
4461         "200":
4462           description: successful operation
4463           schema:
4464               $ref: "#/getDefinitions/tenants"
4465         "default":
4466           description: Response codes found in [response codes](https://wiki.onap.org/).
4467       parameters:
4468         - name: cloud-owner
4469           in: path
4470           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4471           required: true
4472           type: string
4473           example: __CLOUD-OWNER__
4474         - name: cloud-region-id
4475           in: path
4476           description: Identifier used by the vendor for the region. Second part of composite key
4477           required: true
4478           type: string
4479           example: __CLOUD-REGION-ID__
4480         - name: tenant-id
4481           in: query
4482           description:
4483           required: false
4484           type: string
4485         - name: tenant-name
4486           in: query
4487           description:
4488           required: false
4489           type: string
4490         - name: tenant-context
4491           in: query
4492           description:
4493           required: false
4494           type: string
4495   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship:
4496     put:
4497       tags:
4498         - CloudInfrastructure
4499       summary: see node definition for valid relationships
4500       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship
4501       consumes:
4502         - application/json
4503         - application/xml
4504       produces:
4505         - application/json
4506         - application/xml
4507       responses:
4508         "default":
4509           description: Response codes found in [response codes](https://wiki.onap.org/).
4510       parameters:
4511         - name: cloud-owner
4512           in: path
4513           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4514           required: true
4515           type: string
4516           example: __CLOUD-OWNER__
4517         - name: cloud-region-id
4518           in: path
4519           description: Identifier used by the vendor for the region. Second part of composite key
4520           required: true
4521           type: string
4522           example: __CLOUD-REGION-ID__
4523         - name: flavor-id
4524           in: path
4525           description: Flavor id, expected to be unique across cloud-region.
4526           required: true
4527           type: string
4528           example: __FLAVOR-ID__
4529         - name: hpa-capability-id
4530           in: path
4531           description: UUID to uniquely identify a HPA capability
4532           required: true
4533           type: string
4534           example: __HPA-CAPABILITY-ID__
4535         - name: body
4536           in: body
4537           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)
4538           required: true
4539           schema:
4540             $ref: "#/definitions/relationship"
4541     delete:
4542       tags:
4543         - CloudInfrastructure
4544       summary: delete an existing relationship
4545       description: delete an existing relationship
4546       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship
4547       consumes:
4548         - application/json
4549         - application/xml
4550       produces:
4551         - application/json
4552         - application/xml
4553       responses:
4554         "default":
4555           description: Response codes found in [response codes](https://wiki.onap.org/).
4556       parameters:
4557         - name: cloud-owner
4558           in: path
4559           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4560           required: true
4561           type: string
4562           example: __CLOUD-OWNER__
4563         - name: cloud-region-id
4564           in: path
4565           description: Identifier used by the vendor for the region. Second part of composite key
4566           required: true
4567           type: string
4568           example: __CLOUD-REGION-ID__
4569         - name: flavor-id
4570           in: path
4571           description: Flavor id, expected to be unique across cloud-region.
4572           required: true
4573           type: string
4574           example: __FLAVOR-ID__
4575         - name: hpa-capability-id
4576           in: path
4577           description: UUID to uniquely identify a HPA capability
4578           required: true
4579           type: string
4580           example: __HPA-CAPABILITY-ID__
4581   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship:
4582     put:
4583       tags:
4584         - CloudInfrastructure
4585       summary: see node definition for valid relationships
4586       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
4587       consumes:
4588         - application/json
4589         - application/xml
4590       produces:
4591         - application/json
4592         - application/xml
4593       responses:
4594         "default":
4595           description: Response codes found in [response codes](https://wiki.onap.org/).
4596       parameters:
4597         - name: cloud-owner
4598           in: path
4599           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4600           required: true
4601           type: string
4602           example: __CLOUD-OWNER__
4603         - name: cloud-region-id
4604           in: path
4605           description: Identifier used by the vendor for the region. Second part of composite key
4606           required: true
4607           type: string
4608           example: __CLOUD-REGION-ID__
4609         - name: flavor-id
4610           in: path
4611           description: Flavor id, expected to be unique across cloud-region.
4612           required: true
4613           type: string
4614           example: __FLAVOR-ID__
4615         - name: hpa-capability-id
4616           in: path
4617           description: UUID to uniquely identify a HPA capability
4618           required: true
4619           type: string
4620           example: __HPA-CAPABILITY-ID__
4621         - name: hpa-attribute-key
4622           in: path
4623           description: name of the specific HPA attribute
4624           required: true
4625           type: string
4626           example: __HPA-ATTRIBUTE-KEY__
4627         - name: body
4628           in: body
4629           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
4630           required: true
4631           schema:
4632             $ref: "#/definitions/relationship"
4633     delete:
4634       tags:
4635         - CloudInfrastructure
4636       summary: delete an existing relationship
4637       description: delete an existing relationship
4638       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
4639       consumes:
4640         - application/json
4641         - application/xml
4642       produces:
4643         - application/json
4644         - application/xml
4645       responses:
4646         "default":
4647           description: Response codes found in [response codes](https://wiki.onap.org/).
4648       parameters:
4649         - name: cloud-owner
4650           in: path
4651           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4652           required: true
4653           type: string
4654           example: __CLOUD-OWNER__
4655         - name: cloud-region-id
4656           in: path
4657           description: Identifier used by the vendor for the region. Second part of composite key
4658           required: true
4659           type: string
4660           example: __CLOUD-REGION-ID__
4661         - name: flavor-id
4662           in: path
4663           description: Flavor id, expected to be unique across cloud-region.
4664           required: true
4665           type: string
4666           example: __FLAVOR-ID__
4667         - name: hpa-capability-id
4668           in: path
4669           description: UUID to uniquely identify a HPA capability
4670           required: true
4671           type: string
4672           example: __HPA-CAPABILITY-ID__
4673         - name: hpa-attribute-key
4674           in: path
4675           description: name of the specific HPA attribute
4676           required: true
4677           type: string
4678           example: __HPA-ATTRIBUTE-KEY__
4679   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}:
4680     get:
4681       tags:
4682         - CloudInfrastructure
4683       summary: returns hpa-feature-attributes
4684       description: returns hpa-feature-attributes
4685       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4686       produces:
4687         - application/json
4688         - application/xml
4689       responses:
4690         "200":
4691           description: successful operation
4692           schema:
4693               $ref: "#/getDefinitions/hpa-feature-attributes"
4694         "default":
4695           description: Response codes found in [response codes](https://wiki.onap.org/).
4696       parameters:
4697         - name: cloud-owner
4698           in: path
4699           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4700           required: true
4701           type: string
4702           example: __CLOUD-OWNER__
4703         - name: cloud-region-id
4704           in: path
4705           description: Identifier used by the vendor for the region. Second part of composite key
4706           required: true
4707           type: string
4708           example: __CLOUD-REGION-ID__
4709         - name: flavor-id
4710           in: path
4711           description: Flavor id, expected to be unique across cloud-region.
4712           required: true
4713           type: string
4714           example: __FLAVOR-ID__
4715         - name: hpa-capability-id
4716           in: path
4717           description: UUID to uniquely identify a HPA capability
4718           required: true
4719           type: string
4720           example: __HPA-CAPABILITY-ID__
4721         - name: hpa-attribute-key
4722           in: path
4723           description: name of the specific HPA attribute
4724           required: true
4725           type: string
4726           example: __HPA-ATTRIBUTE-KEY__
4727     put:
4728       tags:
4729         - CloudInfrastructure
4730       summary: create or update an existing hpa-feature-attributes
4731       description: |
4732         Create or update an existing hpa-feature-attributes.
4733         #
4734         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4735       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4736       consumes:
4737         - application/json
4738         - application/xml
4739       produces:
4740         - application/json
4741         - application/xml
4742       responses:
4743         "default":
4744           description: Response codes found in [response codes](https://wiki.onap.org/).
4745       parameters:
4746         - name: cloud-owner
4747           in: path
4748           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4749           required: true
4750           type: string
4751           example: __CLOUD-OWNER__
4752         - name: cloud-region-id
4753           in: path
4754           description: Identifier used by the vendor for the region. Second part of composite key
4755           required: true
4756           type: string
4757           example: __CLOUD-REGION-ID__
4758         - name: flavor-id
4759           in: path
4760           description: Flavor id, expected to be unique across cloud-region.
4761           required: true
4762           type: string
4763           example: __FLAVOR-ID__
4764         - name: hpa-capability-id
4765           in: path
4766           description: UUID to uniquely identify a HPA capability
4767           required: true
4768           type: string
4769           example: __HPA-CAPABILITY-ID__
4770         - name: hpa-attribute-key
4771           in: path
4772           description: name of the specific HPA attribute
4773           required: true
4774           type: string
4775           example: __HPA-ATTRIBUTE-KEY__
4776         - name: body
4777           in: body
4778           description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
4779           required: true
4780           schema:
4781             $ref: "#/definitions/hpa-feature-attributes"
4782     patch:
4783       tags:
4784         - CloudInfrastructure
4785       summary: update an existing hpa-feature-attributes
4786       description: |
4787         Update an existing hpa-feature-attributes
4788         #
4789         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4790         The PUT operation will entirely replace an existing object.
4791         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4792         #
4793         Other differences between PUT and PATCH are:
4794         #
4795         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4796         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4797         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4798       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4799       consumes:
4800         - application/json
4801         - application/xml
4802       produces:
4803         - application/json
4804         - application/xml
4805       responses:
4806         "default":
4807           description: Response codes found in [response codes](https://wiki.onap.org/).
4808       parameters:
4809         - name: cloud-owner
4810           in: path
4811           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4812           required: true
4813           type: string
4814           example: __CLOUD-OWNER__
4815         - name: cloud-region-id
4816           in: path
4817           description: Identifier used by the vendor for the region. Second part of composite key
4818           required: true
4819           type: string
4820           example: __CLOUD-REGION-ID__
4821         - name: flavor-id
4822           in: path
4823           description: Flavor id, expected to be unique across cloud-region.
4824           required: true
4825           type: string
4826           example: __FLAVOR-ID__
4827         - name: hpa-capability-id
4828           in: path
4829           description: UUID to uniquely identify a HPA capability
4830           required: true
4831           type: string
4832           example: __HPA-CAPABILITY-ID__
4833         - name: hpa-attribute-key
4834           in: path
4835           description: name of the specific HPA attribute
4836           required: true
4837           type: string
4838           example: __HPA-ATTRIBUTE-KEY__
4839         - name: body
4840           in: body
4841           description: hpa-feature-attributes object that needs to be updated.
4842           required: true
4843           schema:
4844             $ref: "#/patchDefinitions/hpa-feature-attributes"
4845     delete:
4846       tags:
4847         - CloudInfrastructure
4848       summary: delete an existing hpa-feature-attributes
4849       description: delete an existing hpa-feature-attributes
4850       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4851       consumes:
4852         - application/json
4853         - application/xml
4854       produces:
4855         - application/json
4856         - application/xml
4857       responses:
4858         "default":
4859           description: Response codes found in [response codes](https://wiki.onap.org/).
4860       parameters:
4861         - name: cloud-owner
4862           in: path
4863           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4864           required: true
4865           type: string
4866           example: __CLOUD-OWNER__
4867         - name: cloud-region-id
4868           in: path
4869           description: Identifier used by the vendor for the region. Second part of composite key
4870           required: true
4871           type: string
4872           example: __CLOUD-REGION-ID__
4873         - name: flavor-id
4874           in: path
4875           description: Flavor id, expected to be unique across cloud-region.
4876           required: true
4877           type: string
4878           example: __FLAVOR-ID__
4879         - name: hpa-capability-id
4880           in: path
4881           description: UUID to uniquely identify a HPA capability
4882           required: true
4883           type: string
4884           example: __HPA-CAPABILITY-ID__
4885         - name: hpa-attribute-key
4886           in: path
4887           description: name of the specific HPA attribute
4888           required: true
4889           type: string
4890           example: __HPA-ATTRIBUTE-KEY__
4891         - name: resource-version
4892           in: query
4893           description: resource-version for concurrency
4894           required: true
4895           type: string
4896   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
4897     get:
4898       tags:
4899         - CloudInfrastructure
4900       summary: returns hpa-capability
4901       description: returns hpa-capability
4902       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
4903       produces:
4904         - application/json
4905         - application/xml
4906       responses:
4907         "200":
4908           description: successful operation
4909           schema:
4910               $ref: "#/getDefinitions/hpa-capability"
4911         "default":
4912           description: Response codes found in [response codes](https://wiki.onap.org/).
4913       parameters:
4914         - name: cloud-owner
4915           in: path
4916           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4917           required: true
4918           type: string
4919           example: __CLOUD-OWNER__
4920         - name: cloud-region-id
4921           in: path
4922           description: Identifier used by the vendor for the region. Second part of composite key
4923           required: true
4924           type: string
4925           example: __CLOUD-REGION-ID__
4926         - name: flavor-id
4927           in: path
4928           description: Flavor id, expected to be unique across cloud-region.
4929           required: true
4930           type: string
4931           example: __FLAVOR-ID__
4932         - name: hpa-capability-id
4933           in: path
4934           description: UUID to uniquely identify a HPA capability
4935           required: true
4936           type: string
4937           example: __HPA-CAPABILITY-ID__
4938     put:
4939       tags:
4940         - CloudInfrastructure
4941       summary: create or update an existing hpa-capability
4942       description: |
4943         Create or update an existing hpa-capability.
4944         #
4945         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4946       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
4947       consumes:
4948         - application/json
4949         - application/xml
4950       produces:
4951         - application/json
4952         - application/xml
4953       responses:
4954         "default":
4955           description: Response codes found in [response codes](https://wiki.onap.org/).
4956       parameters:
4957         - name: cloud-owner
4958           in: path
4959           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4960           required: true
4961           type: string
4962           example: __CLOUD-OWNER__
4963         - name: cloud-region-id
4964           in: path
4965           description: Identifier used by the vendor for the region. Second part of composite key
4966           required: true
4967           type: string
4968           example: __CLOUD-REGION-ID__
4969         - name: flavor-id
4970           in: path
4971           description: Flavor id, expected to be unique across cloud-region.
4972           required: true
4973           type: string
4974           example: __FLAVOR-ID__
4975         - name: hpa-capability-id
4976           in: path
4977           description: UUID to uniquely identify a HPA capability
4978           required: true
4979           type: string
4980           example: __HPA-CAPABILITY-ID__
4981         - name: body
4982           in: body
4983           description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)
4984           required: true
4985           schema:
4986             $ref: "#/definitions/hpa-capability"
4987     patch:
4988       tags:
4989         - CloudInfrastructure
4990       summary: update an existing hpa-capability
4991       description: |
4992         Update an existing hpa-capability
4993         #
4994         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4995         The PUT operation will entirely replace an existing object.
4996         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4997         #
4998         Other differences between PUT and PATCH are:
4999         #
5000         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5001         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5002         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5003       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5004       consumes:
5005         - application/json
5006         - application/xml
5007       produces:
5008         - application/json
5009         - application/xml
5010       responses:
5011         "default":
5012           description: Response codes found in [response codes](https://wiki.onap.org/).
5013       parameters:
5014         - name: cloud-owner
5015           in: path
5016           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5017           required: true
5018           type: string
5019           example: __CLOUD-OWNER__
5020         - name: cloud-region-id
5021           in: path
5022           description: Identifier used by the vendor for the region. Second part of composite key
5023           required: true
5024           type: string
5025           example: __CLOUD-REGION-ID__
5026         - name: flavor-id
5027           in: path
5028           description: Flavor id, expected to be unique across cloud-region.
5029           required: true
5030           type: string
5031           example: __FLAVOR-ID__
5032         - name: hpa-capability-id
5033           in: path
5034           description: UUID to uniquely identify a HPA capability
5035           required: true
5036           type: string
5037           example: __HPA-CAPABILITY-ID__
5038         - name: body
5039           in: body
5040           description: hpa-capability object that needs to be updated.
5041           required: true
5042           schema:
5043             $ref: "#/patchDefinitions/hpa-capability"
5044     delete:
5045       tags:
5046         - CloudInfrastructure
5047       summary: delete an existing hpa-capability
5048       description: delete an existing hpa-capability
5049       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5050       consumes:
5051         - application/json
5052         - application/xml
5053       produces:
5054         - application/json
5055         - application/xml
5056       responses:
5057         "default":
5058           description: Response codes found in [response codes](https://wiki.onap.org/).
5059       parameters:
5060         - name: cloud-owner
5061           in: path
5062           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5063           required: true
5064           type: string
5065           example: __CLOUD-OWNER__
5066         - name: cloud-region-id
5067           in: path
5068           description: Identifier used by the vendor for the region. Second part of composite key
5069           required: true
5070           type: string
5071           example: __CLOUD-REGION-ID__
5072         - name: flavor-id
5073           in: path
5074           description: Flavor id, expected to be unique across cloud-region.
5075           required: true
5076           type: string
5077           example: __FLAVOR-ID__
5078         - name: hpa-capability-id
5079           in: path
5080           description: UUID to uniquely identify a HPA capability
5081           required: true
5082           type: string
5083           example: __HPA-CAPABILITY-ID__
5084         - name: resource-version
5085           in: query
5086           description: resource-version for concurrency
5087           required: true
5088           type: string
5089   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities:
5090     get:
5091       tags:
5092         - CloudInfrastructure
5093       summary: returns hpa-capabilities
5094       description: returns hpa-capabilities
5095       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities
5096       produces:
5097         - application/json
5098         - application/xml
5099       responses:
5100         "200":
5101           description: successful operation
5102           schema:
5103               $ref: "#/getDefinitions/hpa-capabilities"
5104         "default":
5105           description: Response codes found in [response codes](https://wiki.onap.org/).
5106       parameters:
5107         - name: cloud-owner
5108           in: path
5109           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5110           required: true
5111           type: string
5112           example: __CLOUD-OWNER__
5113         - name: cloud-region-id
5114           in: path
5115           description: Identifier used by the vendor for the region. Second part of composite key
5116           required: true
5117           type: string
5118           example: __CLOUD-REGION-ID__
5119         - name: flavor-id
5120           in: path
5121           description: Flavor id, expected to be unique across cloud-region.
5122           required: true
5123           type: string
5124           example: __FLAVOR-ID__
5125         - name: hpa-capability-id
5126           in: query
5127           description:
5128           required: false
5129           type: string
5130         - name: hpa-feature
5131           in: query
5132           description:
5133           required: false
5134           type: string
5135         - name: architecture
5136           in: query
5137           description:
5138           required: false
5139           type: string
5140   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
5141     put:
5142       tags:
5143         - CloudInfrastructure
5144       summary: see node definition for valid relationships
5145       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5146       consumes:
5147         - application/json
5148         - application/xml
5149       produces:
5150         - application/json
5151         - application/xml
5152       responses:
5153         "default":
5154           description: Response codes found in [response codes](https://wiki.onap.org/).
5155       parameters:
5156         - name: cloud-owner
5157           in: path
5158           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5159           required: true
5160           type: string
5161           example: __CLOUD-OWNER__
5162         - name: cloud-region-id
5163           in: path
5164           description: Identifier used by the vendor for the region. Second part of composite key
5165           required: true
5166           type: string
5167           example: __CLOUD-REGION-ID__
5168         - name: flavor-id
5169           in: path
5170           description: Flavor id, expected to be unique across cloud-region.
5171           required: true
5172           type: string
5173           example: __FLAVOR-ID__
5174         - name: body
5175           in: body
5176           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5177           required: true
5178           schema:
5179             $ref: "#/definitions/relationship"
5180     delete:
5181       tags:
5182         - CloudInfrastructure
5183       summary: delete an existing relationship
5184       description: delete an existing relationship
5185       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5186       consumes:
5187         - application/json
5188         - application/xml
5189       produces:
5190         - application/json
5191         - application/xml
5192       responses:
5193         "default":
5194           description: Response codes found in [response codes](https://wiki.onap.org/).
5195       parameters:
5196         - name: cloud-owner
5197           in: path
5198           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5199           required: true
5200           type: string
5201           example: __CLOUD-OWNER__
5202         - name: cloud-region-id
5203           in: path
5204           description: Identifier used by the vendor for the region. Second part of composite key
5205           required: true
5206           type: string
5207           example: __CLOUD-REGION-ID__
5208         - name: flavor-id
5209           in: path
5210           description: Flavor id, expected to be unique across cloud-region.
5211           required: true
5212           type: string
5213           example: __FLAVOR-ID__
5214   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
5215     get:
5216       tags:
5217         - CloudInfrastructure
5218       summary: returns flavor
5219       description: returns flavor
5220       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5221       produces:
5222         - application/json
5223         - application/xml
5224       responses:
5225         "200":
5226           description: successful operation
5227           schema:
5228               $ref: "#/getDefinitions/flavor"
5229         "default":
5230           description: Response codes found in [response codes](https://wiki.onap.org/).
5231       parameters:
5232         - name: cloud-owner
5233           in: path
5234           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5235           required: true
5236           type: string
5237           example: __CLOUD-OWNER__
5238         - name: cloud-region-id
5239           in: path
5240           description: Identifier used by the vendor for the region. Second part of composite key
5241           required: true
5242           type: string
5243           example: __CLOUD-REGION-ID__
5244         - name: flavor-id
5245           in: path
5246           description: Flavor id, expected to be unique across cloud-region.
5247           required: true
5248           type: string
5249           example: __FLAVOR-ID__
5250     put:
5251       tags:
5252         - CloudInfrastructure
5253       summary: create or update an existing flavor
5254       description: |
5255         Create or update an existing flavor.
5256         #
5257         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5258       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5259       consumes:
5260         - application/json
5261         - application/xml
5262       produces:
5263         - application/json
5264         - application/xml
5265       responses:
5266         "default":
5267           description: Response codes found in [response codes](https://wiki.onap.org/).
5268       parameters:
5269         - name: cloud-owner
5270           in: path
5271           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5272           required: true
5273           type: string
5274           example: __CLOUD-OWNER__
5275         - name: cloud-region-id
5276           in: path
5277           description: Identifier used by the vendor for the region. Second part of composite key
5278           required: true
5279           type: string
5280           example: __CLOUD-REGION-ID__
5281         - name: flavor-id
5282           in: path
5283           description: Flavor id, expected to be unique across cloud-region.
5284           required: true
5285           type: string
5286           example: __FLAVOR-ID__
5287         - name: body
5288           in: body
5289           description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5290           required: true
5291           schema:
5292             $ref: "#/definitions/flavor"
5293     patch:
5294       tags:
5295         - CloudInfrastructure
5296       summary: update an existing flavor
5297       description: |
5298         Update an existing flavor
5299         #
5300         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5301         The PUT operation will entirely replace an existing object.
5302         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5303         #
5304         Other differences between PUT and PATCH are:
5305         #
5306         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5307         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5308         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5309       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5310       consumes:
5311         - application/json
5312         - application/xml
5313       produces:
5314         - application/json
5315         - application/xml
5316       responses:
5317         "default":
5318           description: Response codes found in [response codes](https://wiki.onap.org/).
5319       parameters:
5320         - name: cloud-owner
5321           in: path
5322           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5323           required: true
5324           type: string
5325           example: __CLOUD-OWNER__
5326         - name: cloud-region-id
5327           in: path
5328           description: Identifier used by the vendor for the region. Second part of composite key
5329           required: true
5330           type: string
5331           example: __CLOUD-REGION-ID__
5332         - name: flavor-id
5333           in: path
5334           description: Flavor id, expected to be unique across cloud-region.
5335           required: true
5336           type: string
5337           example: __FLAVOR-ID__
5338         - name: body
5339           in: body
5340           description: flavor object that needs to be updated.
5341           required: true
5342           schema:
5343             $ref: "#/patchDefinitions/flavor"
5344     delete:
5345       tags:
5346         - CloudInfrastructure
5347       summary: delete an existing flavor
5348       description: delete an existing flavor
5349       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5350       consumes:
5351         - application/json
5352         - application/xml
5353       produces:
5354         - application/json
5355         - application/xml
5356       responses:
5357         "default":
5358           description: Response codes found in [response codes](https://wiki.onap.org/).
5359       parameters:
5360         - name: cloud-owner
5361           in: path
5362           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5363           required: true
5364           type: string
5365           example: __CLOUD-OWNER__
5366         - name: cloud-region-id
5367           in: path
5368           description: Identifier used by the vendor for the region. Second part of composite key
5369           required: true
5370           type: string
5371           example: __CLOUD-REGION-ID__
5372         - name: flavor-id
5373           in: path
5374           description: Flavor id, expected to be unique across cloud-region.
5375           required: true
5376           type: string
5377           example: __FLAVOR-ID__
5378         - name: resource-version
5379           in: query
5380           description: resource-version for concurrency
5381           required: true
5382           type: string
5383   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
5384     get:
5385       tags:
5386         - CloudInfrastructure
5387       summary: returns flavors
5388       description: returns flavors
5389       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
5390       produces:
5391         - application/json
5392         - application/xml
5393       responses:
5394         "200":
5395           description: successful operation
5396           schema:
5397               $ref: "#/getDefinitions/flavors"
5398         "default":
5399           description: Response codes found in [response codes](https://wiki.onap.org/).
5400       parameters:
5401         - name: cloud-owner
5402           in: path
5403           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5404           required: true
5405           type: string
5406           example: __CLOUD-OWNER__
5407         - name: cloud-region-id
5408           in: path
5409           description: Identifier used by the vendor for the region. Second part of composite key
5410           required: true
5411           type: string
5412           example: __CLOUD-REGION-ID__
5413         - name: flavor-id
5414           in: query
5415           description:
5416           required: false
5417           type: string
5418         - name: flavor-name
5419           in: query
5420           description:
5421           required: false
5422           type: string
5423   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
5424     put:
5425       tags:
5426         - CloudInfrastructure
5427       summary: see node definition for valid relationships
5428       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5429       consumes:
5430         - application/json
5431         - application/xml
5432       produces:
5433         - application/json
5434         - application/xml
5435       responses:
5436         "default":
5437           description: Response codes found in [response codes](https://wiki.onap.org/).
5438       parameters:
5439         - name: cloud-owner
5440           in: path
5441           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5442           required: true
5443           type: string
5444           example: __CLOUD-OWNER__
5445         - name: cloud-region-id
5446           in: path
5447           description: Identifier used by the vendor for the region. Second part of composite key
5448           required: true
5449           type: string
5450           example: __CLOUD-REGION-ID__
5451         - name: group-id
5452           in: path
5453           description: Group id, expected to be unique across cloud-region.
5454           required: true
5455           type: string
5456           example: __GROUP-ID__
5457         - name: body
5458           in: body
5459           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5460           required: true
5461           schema:
5462             $ref: "#/definitions/relationship"
5463     delete:
5464       tags:
5465         - CloudInfrastructure
5466       summary: delete an existing relationship
5467       description: delete an existing relationship
5468       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5469       consumes:
5470         - application/json
5471         - application/xml
5472       produces:
5473         - application/json
5474         - application/xml
5475       responses:
5476         "default":
5477           description: Response codes found in [response codes](https://wiki.onap.org/).
5478       parameters:
5479         - name: cloud-owner
5480           in: path
5481           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5482           required: true
5483           type: string
5484           example: __CLOUD-OWNER__
5485         - name: cloud-region-id
5486           in: path
5487           description: Identifier used by the vendor for the region. Second part of composite key
5488           required: true
5489           type: string
5490           example: __CLOUD-REGION-ID__
5491         - name: group-id
5492           in: path
5493           description: Group id, expected to be unique across cloud-region.
5494           required: true
5495           type: string
5496           example: __GROUP-ID__
5497   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
5498     get:
5499       tags:
5500         - CloudInfrastructure
5501       summary: returns group-assignment
5502       description: returns group-assignment
5503       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5504       produces:
5505         - application/json
5506         - application/xml
5507       responses:
5508         "200":
5509           description: successful operation
5510           schema:
5511               $ref: "#/getDefinitions/group-assignment"
5512         "default":
5513           description: Response codes found in [response codes](https://wiki.onap.org/).
5514       parameters:
5515         - name: cloud-owner
5516           in: path
5517           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5518           required: true
5519           type: string
5520           example: __CLOUD-OWNER__
5521         - name: cloud-region-id
5522           in: path
5523           description: Identifier used by the vendor for the region. Second part of composite key
5524           required: true
5525           type: string
5526           example: __CLOUD-REGION-ID__
5527         - name: group-id
5528           in: path
5529           description: Group id, expected to be unique across cloud-region.
5530           required: true
5531           type: string
5532           example: __GROUP-ID__
5533     put:
5534       tags:
5535         - CloudInfrastructure
5536       summary: create or update an existing group-assignment
5537       description: |
5538         Create or update an existing group-assignment.
5539         #
5540         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5541       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5542       consumes:
5543         - application/json
5544         - application/xml
5545       produces:
5546         - application/json
5547         - application/xml
5548       responses:
5549         "default":
5550           description: Response codes found in [response codes](https://wiki.onap.org/).
5551       parameters:
5552         - name: cloud-owner
5553           in: path
5554           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5555           required: true
5556           type: string
5557           example: __CLOUD-OWNER__
5558         - name: cloud-region-id
5559           in: path
5560           description: Identifier used by the vendor for the region. Second part of composite key
5561           required: true
5562           type: string
5563           example: __CLOUD-REGION-ID__
5564         - name: group-id
5565           in: path
5566           description: Group id, expected to be unique across cloud-region.
5567           required: true
5568           type: string
5569           example: __GROUP-ID__
5570         - name: body
5571           in: body
5572           description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5573           required: true
5574           schema:
5575             $ref: "#/definitions/group-assignment"
5576     patch:
5577       tags:
5578         - CloudInfrastructure
5579       summary: update an existing group-assignment
5580       description: |
5581         Update an existing group-assignment
5582         #
5583         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5584         The PUT operation will entirely replace an existing object.
5585         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5586         #
5587         Other differences between PUT and PATCH are:
5588         #
5589         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5590         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5591         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5592       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5593       consumes:
5594         - application/json
5595         - application/xml
5596       produces:
5597         - application/json
5598         - application/xml
5599       responses:
5600         "default":
5601           description: Response codes found in [response codes](https://wiki.onap.org/).
5602       parameters:
5603         - name: cloud-owner
5604           in: path
5605           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5606           required: true
5607           type: string
5608           example: __CLOUD-OWNER__
5609         - name: cloud-region-id
5610           in: path
5611           description: Identifier used by the vendor for the region. Second part of composite key
5612           required: true
5613           type: string
5614           example: __CLOUD-REGION-ID__
5615         - name: group-id
5616           in: path
5617           description: Group id, expected to be unique across cloud-region.
5618           required: true
5619           type: string
5620           example: __GROUP-ID__
5621         - name: body
5622           in: body
5623           description: group-assignment object that needs to be updated.
5624           required: true
5625           schema:
5626             $ref: "#/patchDefinitions/group-assignment"
5627     delete:
5628       tags:
5629         - CloudInfrastructure
5630       summary: delete an existing group-assignment
5631       description: delete an existing group-assignment
5632       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5633       consumes:
5634         - application/json
5635         - application/xml
5636       produces:
5637         - application/json
5638         - application/xml
5639       responses:
5640         "default":
5641           description: Response codes found in [response codes](https://wiki.onap.org/).
5642       parameters:
5643         - name: cloud-owner
5644           in: path
5645           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5646           required: true
5647           type: string
5648           example: __CLOUD-OWNER__
5649         - name: cloud-region-id
5650           in: path
5651           description: Identifier used by the vendor for the region. Second part of composite key
5652           required: true
5653           type: string
5654           example: __CLOUD-REGION-ID__
5655         - name: group-id
5656           in: path
5657           description: Group id, expected to be unique across cloud-region.
5658           required: true
5659           type: string
5660           example: __GROUP-ID__
5661         - name: resource-version
5662           in: query
5663           description: resource-version for concurrency
5664           required: true
5665           type: string
5666   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
5667     get:
5668       tags:
5669         - CloudInfrastructure
5670       summary: returns group-assignments
5671       description: returns group-assignments
5672       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
5673       produces:
5674         - application/json
5675         - application/xml
5676       responses:
5677         "200":
5678           description: successful operation
5679           schema:
5680               $ref: "#/getDefinitions/group-assignments"
5681         "default":
5682           description: Response codes found in [response codes](https://wiki.onap.org/).
5683       parameters:
5684         - name: cloud-owner
5685           in: path
5686           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5687           required: true
5688           type: string
5689           example: __CLOUD-OWNER__
5690         - name: cloud-region-id
5691           in: path
5692           description: Identifier used by the vendor for the region. Second part of composite key
5693           required: true
5694           type: string
5695           example: __CLOUD-REGION-ID__
5696         - name: group-id
5697           in: query
5698           description:
5699           required: false
5700           type: string
5701         - name: group-type
5702           in: query
5703           description:
5704           required: false
5705           type: string
5706         - name: group-name
5707           in: query
5708           description:
5709           required: false
5710           type: string
5711   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
5712     put:
5713       tags:
5714         - CloudInfrastructure
5715       summary: see node definition for valid relationships
5716       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5717       consumes:
5718         - application/json
5719         - application/xml
5720       produces:
5721         - application/json
5722         - application/xml
5723       responses:
5724         "default":
5725           description: Response codes found in [response codes](https://wiki.onap.org/).
5726       parameters:
5727         - name: cloud-owner
5728           in: path
5729           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5730           required: true
5731           type: string
5732           example: __CLOUD-OWNER__
5733         - name: cloud-region-id
5734           in: path
5735           description: Identifier used by the vendor for the region. Second part of composite key
5736           required: true
5737           type: string
5738           example: __CLOUD-REGION-ID__
5739         - name: snapshot-id
5740           in: path
5741           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5742           required: true
5743           type: string
5744           example: __SNAPSHOT-ID__
5745         - name: body
5746           in: body
5747           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5748           required: true
5749           schema:
5750             $ref: "#/definitions/relationship"
5751     delete:
5752       tags:
5753         - CloudInfrastructure
5754       summary: delete an existing relationship
5755       description: delete an existing relationship
5756       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5757       consumes:
5758         - application/json
5759         - application/xml
5760       produces:
5761         - application/json
5762         - application/xml
5763       responses:
5764         "default":
5765           description: Response codes found in [response codes](https://wiki.onap.org/).
5766       parameters:
5767         - name: cloud-owner
5768           in: path
5769           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5770           required: true
5771           type: string
5772           example: __CLOUD-OWNER__
5773         - name: cloud-region-id
5774           in: path
5775           description: Identifier used by the vendor for the region. Second part of composite key
5776           required: true
5777           type: string
5778           example: __CLOUD-REGION-ID__
5779         - name: snapshot-id
5780           in: path
5781           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5782           required: true
5783           type: string
5784           example: __SNAPSHOT-ID__
5785   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
5786     get:
5787       tags:
5788         - CloudInfrastructure
5789       summary: returns snapshot
5790       description: returns snapshot
5791       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5792       produces:
5793         - application/json
5794         - application/xml
5795       responses:
5796         "200":
5797           description: successful operation
5798           schema:
5799               $ref: "#/getDefinitions/snapshot"
5800         "default":
5801           description: Response codes found in [response codes](https://wiki.onap.org/).
5802       parameters:
5803         - name: cloud-owner
5804           in: path
5805           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5806           required: true
5807           type: string
5808           example: __CLOUD-OWNER__
5809         - name: cloud-region-id
5810           in: path
5811           description: Identifier used by the vendor for the region. Second part of composite key
5812           required: true
5813           type: string
5814           example: __CLOUD-REGION-ID__
5815         - name: snapshot-id
5816           in: path
5817           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5818           required: true
5819           type: string
5820           example: __SNAPSHOT-ID__
5821     put:
5822       tags:
5823         - CloudInfrastructure
5824       summary: create or update an existing snapshot
5825       description: |
5826         Create or update an existing snapshot.
5827         #
5828         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5829       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5830       consumes:
5831         - application/json
5832         - application/xml
5833       produces:
5834         - application/json
5835         - application/xml
5836       responses:
5837         "default":
5838           description: Response codes found in [response codes](https://wiki.onap.org/).
5839       parameters:
5840         - name: cloud-owner
5841           in: path
5842           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5843           required: true
5844           type: string
5845           example: __CLOUD-OWNER__
5846         - name: cloud-region-id
5847           in: path
5848           description: Identifier used by the vendor for the region. Second part of composite key
5849           required: true
5850           type: string
5851           example: __CLOUD-REGION-ID__
5852         - name: snapshot-id
5853           in: path
5854           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5855           required: true
5856           type: string
5857           example: __SNAPSHOT-ID__
5858         - name: body
5859           in: body
5860           description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5861           required: true
5862           schema:
5863             $ref: "#/definitions/snapshot"
5864     patch:
5865       tags:
5866         - CloudInfrastructure
5867       summary: update an existing snapshot
5868       description: |
5869         Update an existing snapshot
5870         #
5871         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5872         The PUT operation will entirely replace an existing object.
5873         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5874         #
5875         Other differences between PUT and PATCH are:
5876         #
5877         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5878         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5879         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5880       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5881       consumes:
5882         - application/json
5883         - application/xml
5884       produces:
5885         - application/json
5886         - application/xml
5887       responses:
5888         "default":
5889           description: Response codes found in [response codes](https://wiki.onap.org/).
5890       parameters:
5891         - name: cloud-owner
5892           in: path
5893           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5894           required: true
5895           type: string
5896           example: __CLOUD-OWNER__
5897         - name: cloud-region-id
5898           in: path
5899           description: Identifier used by the vendor for the region. Second part of composite key
5900           required: true
5901           type: string
5902           example: __CLOUD-REGION-ID__
5903         - name: snapshot-id
5904           in: path
5905           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5906           required: true
5907           type: string
5908           example: __SNAPSHOT-ID__
5909         - name: body
5910           in: body
5911           description: snapshot object that needs to be updated.
5912           required: true
5913           schema:
5914             $ref: "#/patchDefinitions/snapshot"
5915     delete:
5916       tags:
5917         - CloudInfrastructure
5918       summary: delete an existing snapshot
5919       description: delete an existing snapshot
5920       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5921       consumes:
5922         - application/json
5923         - application/xml
5924       produces:
5925         - application/json
5926         - application/xml
5927       responses:
5928         "default":
5929           description: Response codes found in [response codes](https://wiki.onap.org/).
5930       parameters:
5931         - name: cloud-owner
5932           in: path
5933           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5934           required: true
5935           type: string
5936           example: __CLOUD-OWNER__
5937         - name: cloud-region-id
5938           in: path
5939           description: Identifier used by the vendor for the region. Second part of composite key
5940           required: true
5941           type: string
5942           example: __CLOUD-REGION-ID__
5943         - name: snapshot-id
5944           in: path
5945           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5946           required: true
5947           type: string
5948           example: __SNAPSHOT-ID__
5949         - name: resource-version
5950           in: query
5951           description: resource-version for concurrency
5952           required: true
5953           type: string
5954   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
5955     get:
5956       tags:
5957         - CloudInfrastructure
5958       summary: returns snapshots
5959       description: returns snapshots
5960       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
5961       produces:
5962         - application/json
5963         - application/xml
5964       responses:
5965         "200":
5966           description: successful operation
5967           schema:
5968               $ref: "#/getDefinitions/snapshots"
5969         "default":
5970           description: Response codes found in [response codes](https://wiki.onap.org/).
5971       parameters:
5972         - name: cloud-owner
5973           in: path
5974           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5975           required: true
5976           type: string
5977           example: __CLOUD-OWNER__
5978         - name: cloud-region-id
5979           in: path
5980           description: Identifier used by the vendor for the region. Second part of composite key
5981           required: true
5982           type: string
5983           example: __CLOUD-REGION-ID__
5984         - name: snapshot-id
5985           in: query
5986           description:
5987           required: false
5988           type: string
5989         - name: snapshot-name
5990           in: query
5991           description:
5992           required: false
5993           type: string
5994         - name: application
5995           in: query
5996           description:
5997           required: false
5998           type: string
5999         - name: application-vendor
6000           in: query
6001           description:
6002           required: false
6003           type: string
6004         - name: application-version
6005           in: query
6006           description:
6007           required: false
6008           type: string
6009         - name: prev-snapshot-id
6010           in: query
6011           description:
6012           required: false
6013           type: string
6014   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
6015     put:
6016       tags:
6017         - CloudInfrastructure
6018       summary: see node definition for valid relationships
6019       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6020       consumes:
6021         - application/json
6022         - application/xml
6023       produces:
6024         - application/json
6025         - application/xml
6026       responses:
6027         "default":
6028           description: Response codes found in [response codes](https://wiki.onap.org/).
6029       parameters:
6030         - name: cloud-owner
6031           in: path
6032           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6033           required: true
6034           type: string
6035           example: __CLOUD-OWNER__
6036         - name: cloud-region-id
6037           in: path
6038           description: Identifier used by the vendor for the region. Second part of composite key
6039           required: true
6040           type: string
6041           example: __CLOUD-REGION-ID__
6042         - name: image-id
6043           in: path
6044           description: Image id, expected to be unique across cloud region
6045           required: true
6046           type: string
6047           example: __IMAGE-ID__
6048         - name: body
6049           in: body
6050           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6051           required: true
6052           schema:
6053             $ref: "#/definitions/relationship"
6054     delete:
6055       tags:
6056         - CloudInfrastructure
6057       summary: delete an existing relationship
6058       description: delete an existing relationship
6059       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6060       consumes:
6061         - application/json
6062         - application/xml
6063       produces:
6064         - application/json
6065         - application/xml
6066       responses:
6067         "default":
6068           description: Response codes found in [response codes](https://wiki.onap.org/).
6069       parameters:
6070         - name: cloud-owner
6071           in: path
6072           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6073           required: true
6074           type: string
6075           example: __CLOUD-OWNER__
6076         - name: cloud-region-id
6077           in: path
6078           description: Identifier used by the vendor for the region. Second part of composite key
6079           required: true
6080           type: string
6081           example: __CLOUD-REGION-ID__
6082         - name: image-id
6083           in: path
6084           description: Image id, expected to be unique across cloud region
6085           required: true
6086           type: string
6087           example: __IMAGE-ID__
6088   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
6089     get:
6090       tags:
6091         - CloudInfrastructure
6092       summary: returns metadatum
6093       description: returns metadatum
6094       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6095       produces:
6096         - application/json
6097         - application/xml
6098       responses:
6099         "200":
6100           description: successful operation
6101           schema:
6102               $ref: "#/getDefinitions/metadatum"
6103         "default":
6104           description: Response codes found in [response codes](https://wiki.onap.org/).
6105       parameters:
6106         - name: cloud-owner
6107           in: path
6108           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6109           required: true
6110           type: string
6111           example: __CLOUD-OWNER__
6112         - name: cloud-region-id
6113           in: path
6114           description: Identifier used by the vendor for the region. Second part of composite key
6115           required: true
6116           type: string
6117           example: __CLOUD-REGION-ID__
6118         - name: image-id
6119           in: path
6120           description: Image id, expected to be unique across cloud region
6121           required: true
6122           type: string
6123           example: __IMAGE-ID__
6124         - name: metaname
6125           in: path
6126           required: true
6127           type: string
6128           example: __METANAME__
6129     put:
6130       tags:
6131         - CloudInfrastructure
6132       summary: create or update an existing metadatum
6133       description: |
6134         Create or update an existing metadatum.
6135         #
6136         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6137       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6138       consumes:
6139         - application/json
6140         - application/xml
6141       produces:
6142         - application/json
6143         - application/xml
6144       responses:
6145         "default":
6146           description: Response codes found in [response codes](https://wiki.onap.org/).
6147       parameters:
6148         - name: cloud-owner
6149           in: path
6150           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6151           required: true
6152           type: string
6153           example: __CLOUD-OWNER__
6154         - name: cloud-region-id
6155           in: path
6156           description: Identifier used by the vendor for the region. Second part of composite key
6157           required: true
6158           type: string
6159           example: __CLOUD-REGION-ID__
6160         - name: image-id
6161           in: path
6162           description: Image id, expected to be unique across cloud region
6163           required: true
6164           type: string
6165           example: __IMAGE-ID__
6166         - name: metaname
6167           in: path
6168           required: true
6169           type: string
6170           example: __METANAME__
6171         - name: body
6172           in: body
6173           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
6174           required: true
6175           schema:
6176             $ref: "#/definitions/metadatum"
6177     patch:
6178       tags:
6179         - CloudInfrastructure
6180       summary: update an existing metadatum
6181       description: |
6182         Update an existing metadatum
6183         #
6184         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6185         The PUT operation will entirely replace an existing object.
6186         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6187         #
6188         Other differences between PUT and PATCH are:
6189         #
6190         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6191         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6192         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6193       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6194       consumes:
6195         - application/json
6196         - application/xml
6197       produces:
6198         - application/json
6199         - application/xml
6200       responses:
6201         "default":
6202           description: Response codes found in [response codes](https://wiki.onap.org/).
6203       parameters:
6204         - name: cloud-owner
6205           in: path
6206           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6207           required: true
6208           type: string
6209           example: __CLOUD-OWNER__
6210         - name: cloud-region-id
6211           in: path
6212           description: Identifier used by the vendor for the region. Second part of composite key
6213           required: true
6214           type: string
6215           example: __CLOUD-REGION-ID__
6216         - name: image-id
6217           in: path
6218           description: Image id, expected to be unique across cloud region
6219           required: true
6220           type: string
6221           example: __IMAGE-ID__
6222         - name: metaname
6223           in: path
6224           required: true
6225           type: string
6226           example: __METANAME__
6227         - name: body
6228           in: body
6229           description: metadatum object that needs to be updated.
6230           required: true
6231           schema:
6232             $ref: "#/patchDefinitions/metadatum"
6233     delete:
6234       tags:
6235         - CloudInfrastructure
6236       summary: delete an existing metadatum
6237       description: delete an existing metadatum
6238       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6239       consumes:
6240         - application/json
6241         - application/xml
6242       produces:
6243         - application/json
6244         - application/xml
6245       responses:
6246         "default":
6247           description: Response codes found in [response codes](https://wiki.onap.org/).
6248       parameters:
6249         - name: cloud-owner
6250           in: path
6251           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6252           required: true
6253           type: string
6254           example: __CLOUD-OWNER__
6255         - name: cloud-region-id
6256           in: path
6257           description: Identifier used by the vendor for the region. Second part of composite key
6258           required: true
6259           type: string
6260           example: __CLOUD-REGION-ID__
6261         - name: image-id
6262           in: path
6263           description: Image id, expected to be unique across cloud region
6264           required: true
6265           type: string
6266           example: __IMAGE-ID__
6267         - name: metaname
6268           in: path
6269           required: true
6270           type: string
6271           example: __METANAME__
6272         - name: resource-version
6273           in: query
6274           description: resource-version for concurrency
6275           required: true
6276           type: string
6277   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
6278     get:
6279       tags:
6280         - CloudInfrastructure
6281       summary: returns metadata
6282       description: returns metadata
6283       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
6284       produces:
6285         - application/json
6286         - application/xml
6287       responses:
6288         "200":
6289           description: successful operation
6290           schema:
6291               $ref: "#/getDefinitions/metadata"
6292         "default":
6293           description: Response codes found in [response codes](https://wiki.onap.org/).
6294       parameters:
6295         - name: cloud-owner
6296           in: path
6297           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6298           required: true
6299           type: string
6300           example: __CLOUD-OWNER__
6301         - name: cloud-region-id
6302           in: path
6303           description: Identifier used by the vendor for the region. Second part of composite key
6304           required: true
6305           type: string
6306           example: __CLOUD-REGION-ID__
6307         - name: image-id
6308           in: path
6309           description: Image id, expected to be unique across cloud region
6310           required: true
6311           type: string
6312           example: __IMAGE-ID__
6313         - name: metaname
6314           in: query
6315           description:
6316           required: false
6317           type: string
6318   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
6319     get:
6320       tags:
6321         - CloudInfrastructure
6322       summary: returns image
6323       description: returns image
6324       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
6325       produces:
6326         - application/json
6327         - application/xml
6328       responses:
6329         "200":
6330           description: successful operation
6331           schema:
6332               $ref: "#/getDefinitions/image"
6333         "default":
6334           description: Response codes found in [response codes](https://wiki.onap.org/).
6335       parameters:
6336         - name: cloud-owner
6337           in: path
6338           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6339           required: true
6340           type: string
6341           example: __CLOUD-OWNER__
6342         - name: cloud-region-id
6343           in: path
6344           description: Identifier used by the vendor for the region. Second part of composite key
6345           required: true
6346           type: string
6347           example: __CLOUD-REGION-ID__
6348         - name: image-id
6349           in: path
6350           description: Image id, expected to be unique across cloud region
6351           required: true
6352           type: string
6353           example: __IMAGE-ID__
6354     put:
6355       tags:
6356         - CloudInfrastructure
6357       summary: create or update an existing image
6358       description: |
6359         Create or update an existing image.
6360         #
6361         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6362       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6363       consumes:
6364         - application/json
6365         - application/xml
6366       produces:
6367         - application/json
6368         - application/xml
6369       responses:
6370         "default":
6371           description: Response codes found in [response codes](https://wiki.onap.org/).
6372       parameters:
6373         - name: cloud-owner
6374           in: path
6375           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6376           required: true
6377           type: string
6378           example: __CLOUD-OWNER__
6379         - name: cloud-region-id
6380           in: path
6381           description: Identifier used by the vendor for the region. Second part of composite key
6382           required: true
6383           type: string
6384           example: __CLOUD-REGION-ID__
6385         - name: image-id
6386           in: path
6387           description: Image id, expected to be unique across cloud region
6388           required: true
6389           type: string
6390           example: __IMAGE-ID__
6391         - name: body
6392           in: body
6393           description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6394           required: true
6395           schema:
6396             $ref: "#/definitions/image"
6397     patch:
6398       tags:
6399         - CloudInfrastructure
6400       summary: update an existing image
6401       description: |
6402         Update an existing image
6403         #
6404         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6405         The PUT operation will entirely replace an existing object.
6406         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6407         #
6408         Other differences between PUT and PATCH are:
6409         #
6410         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6411         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6412         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6413       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6414       consumes:
6415         - application/json
6416         - application/xml
6417       produces:
6418         - application/json
6419         - application/xml
6420       responses:
6421         "default":
6422           description: Response codes found in [response codes](https://wiki.onap.org/).
6423       parameters:
6424         - name: cloud-owner
6425           in: path
6426           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6427           required: true
6428           type: string
6429           example: __CLOUD-OWNER__
6430         - name: cloud-region-id
6431           in: path
6432           description: Identifier used by the vendor for the region. Second part of composite key
6433           required: true
6434           type: string
6435           example: __CLOUD-REGION-ID__
6436         - name: image-id
6437           in: path
6438           description: Image id, expected to be unique across cloud region
6439           required: true
6440           type: string
6441           example: __IMAGE-ID__
6442         - name: body
6443           in: body
6444           description: image object that needs to be updated.
6445           required: true
6446           schema:
6447             $ref: "#/patchDefinitions/image"
6448     delete:
6449       tags:
6450         - CloudInfrastructure
6451       summary: delete an existing image
6452       description: delete an existing image
6453       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
6454       consumes:
6455         - application/json
6456         - application/xml
6457       produces:
6458         - application/json
6459         - application/xml
6460       responses:
6461         "default":
6462           description: Response codes found in [response codes](https://wiki.onap.org/).
6463       parameters:
6464         - name: cloud-owner
6465           in: path
6466           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6467           required: true
6468           type: string
6469           example: __CLOUD-OWNER__
6470         - name: cloud-region-id
6471           in: path
6472           description: Identifier used by the vendor for the region. Second part of composite key
6473           required: true
6474           type: string
6475           example: __CLOUD-REGION-ID__
6476         - name: image-id
6477           in: path
6478           description: Image id, expected to be unique across cloud region
6479           required: true
6480           type: string
6481           example: __IMAGE-ID__
6482         - name: resource-version
6483           in: query
6484           description: resource-version for concurrency
6485           required: true
6486           type: string
6487   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
6488     get:
6489       tags:
6490         - CloudInfrastructure
6491       summary: returns images
6492       description: returns images
6493       operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
6494       produces:
6495         - application/json
6496         - application/xml
6497       responses:
6498         "200":
6499           description: successful operation
6500           schema:
6501               $ref: "#/getDefinitions/images"
6502         "default":
6503           description: Response codes found in [response codes](https://wiki.onap.org/).
6504       parameters:
6505         - name: cloud-owner
6506           in: path
6507           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6508           required: true
6509           type: string
6510           example: __CLOUD-OWNER__
6511         - name: cloud-region-id
6512           in: path
6513           description: Identifier used by the vendor for the region. Second part of composite key
6514           required: true
6515           type: string
6516           example: __CLOUD-REGION-ID__
6517         - name: image-id
6518           in: query
6519           description:
6520           required: false
6521           type: string
6522         - name: image-name
6523           in: query
6524           description:
6525           required: false
6526           type: string
6527         - name: application
6528           in: query
6529           description:
6530           required: false
6531           type: string
6532         - name: application-vendor
6533           in: query
6534           description:
6535           required: false
6536           type: string
6537         - name: application-version
6538           in: query
6539           description:
6540           required: false
6541           type: string
6542   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
6543     put:
6544       tags:
6545         - CloudInfrastructure
6546       summary: see node definition for valid relationships
6547       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
6548       consumes:
6549         - application/json
6550         - application/xml
6551       produces:
6552         - application/json
6553         - application/xml
6554       responses:
6555         "default":
6556           description: Response codes found in [response codes](https://wiki.onap.org/).
6557       parameters:
6558         - name: cloud-owner
6559           in: path
6560           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6561           required: true
6562           type: string
6563           example: __CLOUD-OWNER__
6564         - name: cloud-region-id
6565           in: path
6566           description: Identifier used by the vendor for the region. Second part of composite key
6567           required: true
6568           type: string
6569           example: __CLOUD-REGION-ID__
6570         - name: switch-name
6571           in: path
6572           description: DVS switch name
6573           required: true
6574           type: string
6575           example: __SWITCH-NAME__
6576         - name: body
6577           in: body
6578           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6579           required: true
6580           schema:
6581             $ref: "#/definitions/relationship"
6582     delete:
6583       tags:
6584         - CloudInfrastructure
6585       summary: delete an existing relationship
6586       description: delete an existing relationship
6587       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
6588       consumes:
6589         - application/json
6590         - application/xml
6591       produces:
6592         - application/json
6593         - application/xml
6594       responses:
6595         "default":
6596           description: Response codes found in [response codes](https://wiki.onap.org/).
6597       parameters:
6598         - name: cloud-owner
6599           in: path
6600           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6601           required: true
6602           type: string
6603           example: __CLOUD-OWNER__
6604         - name: cloud-region-id
6605           in: path
6606           description: Identifier used by the vendor for the region. Second part of composite key
6607           required: true
6608           type: string
6609           example: __CLOUD-REGION-ID__
6610         - name: switch-name
6611           in: path
6612           description: DVS switch name
6613           required: true
6614           type: string
6615           example: __SWITCH-NAME__
6616   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
6617     get:
6618       tags:
6619         - CloudInfrastructure
6620       summary: returns dvs-switch
6621       description: returns dvs-switch
6622       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6623       produces:
6624         - application/json
6625         - application/xml
6626       responses:
6627         "200":
6628           description: successful operation
6629           schema:
6630               $ref: "#/getDefinitions/dvs-switch"
6631         "default":
6632           description: Response codes found in [response codes](https://wiki.onap.org/).
6633       parameters:
6634         - name: cloud-owner
6635           in: path
6636           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6637           required: true
6638           type: string
6639           example: __CLOUD-OWNER__
6640         - name: cloud-region-id
6641           in: path
6642           description: Identifier used by the vendor for the region. Second part of composite key
6643           required: true
6644           type: string
6645           example: __CLOUD-REGION-ID__
6646         - name: switch-name
6647           in: path
6648           description: DVS switch name
6649           required: true
6650           type: string
6651           example: __SWITCH-NAME__
6652     put:
6653       tags:
6654         - CloudInfrastructure
6655       summary: create or update an existing dvs-switch
6656       description: |
6657         Create or update an existing dvs-switch.
6658         #
6659         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6660       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6661       consumes:
6662         - application/json
6663         - application/xml
6664       produces:
6665         - application/json
6666         - application/xml
6667       responses:
6668         "default":
6669           description: Response codes found in [response codes](https://wiki.onap.org/).
6670       parameters:
6671         - name: cloud-owner
6672           in: path
6673           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6674           required: true
6675           type: string
6676           example: __CLOUD-OWNER__
6677         - name: cloud-region-id
6678           in: path
6679           description: Identifier used by the vendor for the region. Second part of composite key
6680           required: true
6681           type: string
6682           example: __CLOUD-REGION-ID__
6683         - name: switch-name
6684           in: path
6685           description: DVS switch name
6686           required: true
6687           type: string
6688           example: __SWITCH-NAME__
6689         - name: body
6690           in: body
6691           description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6692           required: true
6693           schema:
6694             $ref: "#/definitions/dvs-switch"
6695     patch:
6696       tags:
6697         - CloudInfrastructure
6698       summary: update an existing dvs-switch
6699       description: |
6700         Update an existing dvs-switch
6701         #
6702         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6703         The PUT operation will entirely replace an existing object.
6704         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6705         #
6706         Other differences between PUT and PATCH are:
6707         #
6708         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6709         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6710         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6711       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6712       consumes:
6713         - application/json
6714         - application/xml
6715       produces:
6716         - application/json
6717         - application/xml
6718       responses:
6719         "default":
6720           description: Response codes found in [response codes](https://wiki.onap.org/).
6721       parameters:
6722         - name: cloud-owner
6723           in: path
6724           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6725           required: true
6726           type: string
6727           example: __CLOUD-OWNER__
6728         - name: cloud-region-id
6729           in: path
6730           description: Identifier used by the vendor for the region. Second part of composite key
6731           required: true
6732           type: string
6733           example: __CLOUD-REGION-ID__
6734         - name: switch-name
6735           in: path
6736           description: DVS switch name
6737           required: true
6738           type: string
6739           example: __SWITCH-NAME__
6740         - name: body
6741           in: body
6742           description: dvs-switch object that needs to be updated.
6743           required: true
6744           schema:
6745             $ref: "#/patchDefinitions/dvs-switch"
6746     delete:
6747       tags:
6748         - CloudInfrastructure
6749       summary: delete an existing dvs-switch
6750       description: delete an existing dvs-switch
6751       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6752       consumes:
6753         - application/json
6754         - application/xml
6755       produces:
6756         - application/json
6757         - application/xml
6758       responses:
6759         "default":
6760           description: Response codes found in [response codes](https://wiki.onap.org/).
6761       parameters:
6762         - name: cloud-owner
6763           in: path
6764           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6765           required: true
6766           type: string
6767           example: __CLOUD-OWNER__
6768         - name: cloud-region-id
6769           in: path
6770           description: Identifier used by the vendor for the region. Second part of composite key
6771           required: true
6772           type: string
6773           example: __CLOUD-REGION-ID__
6774         - name: switch-name
6775           in: path
6776           description: DVS switch name
6777           required: true
6778           type: string
6779           example: __SWITCH-NAME__
6780         - name: resource-version
6781           in: query
6782           description: resource-version for concurrency
6783           required: true
6784           type: string
6785   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
6786     get:
6787       tags:
6788         - CloudInfrastructure
6789       summary: returns dvs-switches
6790       description: returns dvs-switches
6791       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
6792       produces:
6793         - application/json
6794         - application/xml
6795       responses:
6796         "200":
6797           description: successful operation
6798           schema:
6799               $ref: "#/getDefinitions/dvs-switches"
6800         "default":
6801           description: Response codes found in [response codes](https://wiki.onap.org/).
6802       parameters:
6803         - name: cloud-owner
6804           in: path
6805           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6806           required: true
6807           type: string
6808           example: __CLOUD-OWNER__
6809         - name: cloud-region-id
6810           in: path
6811           description: Identifier used by the vendor for the region. Second part of composite key
6812           required: true
6813           type: string
6814           example: __CLOUD-REGION-ID__
6815         - name: switch-name
6816           in: query
6817           description:
6818           required: false
6819           type: string
6820         - name: vcenter-url
6821           in: query
6822           description:
6823           required: false
6824           type: string
6825   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
6826     put:
6827       tags:
6828         - CloudInfrastructure
6829       summary: see node definition for valid relationships
6830       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6831       consumes:
6832         - application/json
6833         - application/xml
6834       produces:
6835         - application/json
6836         - application/xml
6837       responses:
6838         "default":
6839           description: Response codes found in [response codes](https://wiki.onap.org/).
6840       parameters:
6841         - name: cloud-owner
6842           in: path
6843           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6844           required: true
6845           type: string
6846           example: __CLOUD-OWNER__
6847         - name: cloud-region-id
6848           in: path
6849           description: Identifier used by the vendor for the region. Second part of composite key
6850           required: true
6851           type: string
6852           example: __CLOUD-REGION-ID__
6853         - name: network-uuid
6854           in: path
6855           description: UUID of the network. Unique across a cloud-region
6856           required: true
6857           type: string
6858           example: __NETWORK-UUID__
6859         - name: body
6860           in: body
6861           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6862           required: true
6863           schema:
6864             $ref: "#/definitions/relationship"
6865     delete:
6866       tags:
6867         - CloudInfrastructure
6868       summary: delete an existing relationship
6869       description: delete an existing relationship
6870       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6871       consumes:
6872         - application/json
6873         - application/xml
6874       produces:
6875         - application/json
6876         - application/xml
6877       responses:
6878         "default":
6879           description: Response codes found in [response codes](https://wiki.onap.org/).
6880       parameters:
6881         - name: cloud-owner
6882           in: path
6883           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6884           required: true
6885           type: string
6886           example: __CLOUD-OWNER__
6887         - name: cloud-region-id
6888           in: path
6889           description: Identifier used by the vendor for the region. Second part of composite key
6890           required: true
6891           type: string
6892           example: __CLOUD-REGION-ID__
6893         - name: network-uuid
6894           in: path
6895           description: UUID of the network. Unique across a cloud-region
6896           required: true
6897           type: string
6898           example: __NETWORK-UUID__
6899   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
6900     get:
6901       tags:
6902         - CloudInfrastructure
6903       summary: returns oam-network
6904       description: returns oam-network
6905       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6906       produces:
6907         - application/json
6908         - application/xml
6909       responses:
6910         "200":
6911           description: successful operation
6912           schema:
6913               $ref: "#/getDefinitions/oam-network"
6914         "default":
6915           description: Response codes found in [response codes](https://wiki.onap.org/).
6916       parameters:
6917         - name: cloud-owner
6918           in: path
6919           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6920           required: true
6921           type: string
6922           example: __CLOUD-OWNER__
6923         - name: cloud-region-id
6924           in: path
6925           description: Identifier used by the vendor for the region. Second part of composite key
6926           required: true
6927           type: string
6928           example: __CLOUD-REGION-ID__
6929         - name: network-uuid
6930           in: path
6931           description: UUID of the network. Unique across a cloud-region
6932           required: true
6933           type: string
6934           example: __NETWORK-UUID__
6935     put:
6936       tags:
6937         - CloudInfrastructure
6938       summary: create or update an existing oam-network
6939       description: |
6940         Create or update an existing oam-network.
6941         #
6942         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6943       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6944       consumes:
6945         - application/json
6946         - application/xml
6947       produces:
6948         - application/json
6949         - application/xml
6950       responses:
6951         "default":
6952           description: Response codes found in [response codes](https://wiki.onap.org/).
6953       parameters:
6954         - name: cloud-owner
6955           in: path
6956           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6957           required: true
6958           type: string
6959           example: __CLOUD-OWNER__
6960         - name: cloud-region-id
6961           in: path
6962           description: Identifier used by the vendor for the region. Second part of composite key
6963           required: true
6964           type: string
6965           example: __CLOUD-REGION-ID__
6966         - name: network-uuid
6967           in: path
6968           description: UUID of the network. Unique across a cloud-region
6969           required: true
6970           type: string
6971           example: __NETWORK-UUID__
6972         - name: body
6973           in: body
6974           description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6975           required: true
6976           schema:
6977             $ref: "#/definitions/oam-network"
6978     patch:
6979       tags:
6980         - CloudInfrastructure
6981       summary: update an existing oam-network
6982       description: |
6983         Update an existing oam-network
6984         #
6985         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6986         The PUT operation will entirely replace an existing object.
6987         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6988         #
6989         Other differences between PUT and PATCH are:
6990         #
6991         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6992         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6993         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6994       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6995       consumes:
6996         - application/json
6997         - application/xml
6998       produces:
6999         - application/json
7000         - application/xml
7001       responses:
7002         "default":
7003           description: Response codes found in [response codes](https://wiki.onap.org/).
7004       parameters:
7005         - name: cloud-owner
7006           in: path
7007           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7008           required: true
7009           type: string
7010           example: __CLOUD-OWNER__
7011         - name: cloud-region-id
7012           in: path
7013           description: Identifier used by the vendor for the region. Second part of composite key
7014           required: true
7015           type: string
7016           example: __CLOUD-REGION-ID__
7017         - name: network-uuid
7018           in: path
7019           description: UUID of the network. Unique across a cloud-region
7020           required: true
7021           type: string
7022           example: __NETWORK-UUID__
7023         - name: body
7024           in: body
7025           description: oam-network object that needs to be updated.
7026           required: true
7027           schema:
7028             $ref: "#/patchDefinitions/oam-network"
7029     delete:
7030       tags:
7031         - CloudInfrastructure
7032       summary: delete an existing oam-network
7033       description: delete an existing oam-network
7034       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7035       consumes:
7036         - application/json
7037         - application/xml
7038       produces:
7039         - application/json
7040         - application/xml
7041       responses:
7042         "default":
7043           description: Response codes found in [response codes](https://wiki.onap.org/).
7044       parameters:
7045         - name: cloud-owner
7046           in: path
7047           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7048           required: true
7049           type: string
7050           example: __CLOUD-OWNER__
7051         - name: cloud-region-id
7052           in: path
7053           description: Identifier used by the vendor for the region. Second part of composite key
7054           required: true
7055           type: string
7056           example: __CLOUD-REGION-ID__
7057         - name: network-uuid
7058           in: path
7059           description: UUID of the network. Unique across a cloud-region
7060           required: true
7061           type: string
7062           example: __NETWORK-UUID__
7063         - name: resource-version
7064           in: query
7065           description: resource-version for concurrency
7066           required: true
7067           type: string
7068   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
7069     get:
7070       tags:
7071         - CloudInfrastructure
7072       summary: returns oam-networks
7073       description: returns oam-networks
7074       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
7075       produces:
7076         - application/json
7077         - application/xml
7078       responses:
7079         "200":
7080           description: successful operation
7081           schema:
7082               $ref: "#/getDefinitions/oam-networks"
7083         "default":
7084           description: Response codes found in [response codes](https://wiki.onap.org/).
7085       parameters:
7086         - name: cloud-owner
7087           in: path
7088           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7089           required: true
7090           type: string
7091           example: __CLOUD-OWNER__
7092         - name: cloud-region-id
7093           in: path
7094           description: Identifier used by the vendor for the region. Second part of composite key
7095           required: true
7096           type: string
7097           example: __CLOUD-REGION-ID__
7098         - name: network-uuid
7099           in: query
7100           description:
7101           required: false
7102           type: string
7103         - name: network-name
7104           in: query
7105           description:
7106           required: false
7107           type: string
7108         - name: cvlan-tag
7109           in: query
7110           description:
7111           required: false
7112           type: integer
7113           format: int64
7114   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
7115     put:
7116       tags:
7117         - CloudInfrastructure
7118       summary: see node definition for valid relationships
7119       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7120       consumes:
7121         - application/json
7122         - application/xml
7123       produces:
7124         - application/json
7125         - application/xml
7126       responses:
7127         "default":
7128           description: Response codes found in [response codes](https://wiki.onap.org/).
7129       parameters:
7130         - name: cloud-owner
7131           in: path
7132           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7133           required: true
7134           type: string
7135           example: __CLOUD-OWNER__
7136         - name: cloud-region-id
7137           in: path
7138           description: Identifier used by the vendor for the region. Second part of composite key
7139           required: true
7140           type: string
7141           example: __CLOUD-REGION-ID__
7142         - name: availability-zone-name
7143           in: path
7144           description: Name of the availability zone.  Unique across a cloud region
7145           required: true
7146           type: string
7147           example: __AVAILABILITY-ZONE-NAME__
7148         - name: body
7149           in: body
7150           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7151           required: true
7152           schema:
7153             $ref: "#/definitions/relationship"
7154     delete:
7155       tags:
7156         - CloudInfrastructure
7157       summary: delete an existing relationship
7158       description: delete an existing relationship
7159       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7160       consumes:
7161         - application/json
7162         - application/xml
7163       produces:
7164         - application/json
7165         - application/xml
7166       responses:
7167         "default":
7168           description: Response codes found in [response codes](https://wiki.onap.org/).
7169       parameters:
7170         - name: cloud-owner
7171           in: path
7172           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7173           required: true
7174           type: string
7175           example: __CLOUD-OWNER__
7176         - name: cloud-region-id
7177           in: path
7178           description: Identifier used by the vendor for the region. Second part of composite key
7179           required: true
7180           type: string
7181           example: __CLOUD-REGION-ID__
7182         - name: availability-zone-name
7183           in: path
7184           description: Name of the availability zone.  Unique across a cloud region
7185           required: true
7186           type: string
7187           example: __AVAILABILITY-ZONE-NAME__
7188   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
7189     get:
7190       tags:
7191         - CloudInfrastructure
7192       summary: returns availability-zone
7193       description: returns availability-zone
7194       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7195       produces:
7196         - application/json
7197         - application/xml
7198       responses:
7199         "200":
7200           description: successful operation
7201           schema:
7202               $ref: "#/getDefinitions/availability-zone"
7203         "default":
7204           description: Response codes found in [response codes](https://wiki.onap.org/).
7205       parameters:
7206         - name: cloud-owner
7207           in: path
7208           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7209           required: true
7210           type: string
7211           example: __CLOUD-OWNER__
7212         - name: cloud-region-id
7213           in: path
7214           description: Identifier used by the vendor for the region. Second part of composite key
7215           required: true
7216           type: string
7217           example: __CLOUD-REGION-ID__
7218         - name: availability-zone-name
7219           in: path
7220           description: Name of the availability zone.  Unique across a cloud region
7221           required: true
7222           type: string
7223           example: __AVAILABILITY-ZONE-NAME__
7224     put:
7225       tags:
7226         - CloudInfrastructure
7227       summary: create or update an existing availability-zone
7228       description: |
7229         Create or update an existing availability-zone.
7230         #
7231         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7232       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7233       consumes:
7234         - application/json
7235         - application/xml
7236       produces:
7237         - application/json
7238         - application/xml
7239       responses:
7240         "default":
7241           description: Response codes found in [response codes](https://wiki.onap.org/).
7242       parameters:
7243         - name: cloud-owner
7244           in: path
7245           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7246           required: true
7247           type: string
7248           example: __CLOUD-OWNER__
7249         - name: cloud-region-id
7250           in: path
7251           description: Identifier used by the vendor for the region. Second part of composite key
7252           required: true
7253           type: string
7254           example: __CLOUD-REGION-ID__
7255         - name: availability-zone-name
7256           in: path
7257           description: Name of the availability zone.  Unique across a cloud region
7258           required: true
7259           type: string
7260           example: __AVAILABILITY-ZONE-NAME__
7261         - name: body
7262           in: body
7263           description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7264           required: true
7265           schema:
7266             $ref: "#/definitions/availability-zone"
7267     patch:
7268       tags:
7269         - CloudInfrastructure
7270       summary: update an existing availability-zone
7271       description: |
7272         Update an existing availability-zone
7273         #
7274         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7275         The PUT operation will entirely replace an existing object.
7276         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7277         #
7278         Other differences between PUT and PATCH are:
7279         #
7280         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7281         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7282         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7283       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7284       consumes:
7285         - application/json
7286         - application/xml
7287       produces:
7288         - application/json
7289         - application/xml
7290       responses:
7291         "default":
7292           description: Response codes found in [response codes](https://wiki.onap.org/).
7293       parameters:
7294         - name: cloud-owner
7295           in: path
7296           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7297           required: true
7298           type: string
7299           example: __CLOUD-OWNER__
7300         - name: cloud-region-id
7301           in: path
7302           description: Identifier used by the vendor for the region. Second part of composite key
7303           required: true
7304           type: string
7305           example: __CLOUD-REGION-ID__
7306         - name: availability-zone-name
7307           in: path
7308           description: Name of the availability zone.  Unique across a cloud region
7309           required: true
7310           type: string
7311           example: __AVAILABILITY-ZONE-NAME__
7312         - name: body
7313           in: body
7314           description: availability-zone object that needs to be updated.
7315           required: true
7316           schema:
7317             $ref: "#/patchDefinitions/availability-zone"
7318     delete:
7319       tags:
7320         - CloudInfrastructure
7321       summary: delete an existing availability-zone
7322       description: delete an existing availability-zone
7323       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7324       consumes:
7325         - application/json
7326         - application/xml
7327       produces:
7328         - application/json
7329         - application/xml
7330       responses:
7331         "default":
7332           description: Response codes found in [response codes](https://wiki.onap.org/).
7333       parameters:
7334         - name: cloud-owner
7335           in: path
7336           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7337           required: true
7338           type: string
7339           example: __CLOUD-OWNER__
7340         - name: cloud-region-id
7341           in: path
7342           description: Identifier used by the vendor for the region. Second part of composite key
7343           required: true
7344           type: string
7345           example: __CLOUD-REGION-ID__
7346         - name: availability-zone-name
7347           in: path
7348           description: Name of the availability zone.  Unique across a cloud region
7349           required: true
7350           type: string
7351           example: __AVAILABILITY-ZONE-NAME__
7352         - name: resource-version
7353           in: query
7354           description: resource-version for concurrency
7355           required: true
7356           type: string
7357   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
7358     get:
7359       tags:
7360         - CloudInfrastructure
7361       summary: returns availability-zones
7362       description: returns availability-zones
7363       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
7364       produces:
7365         - application/json
7366         - application/xml
7367       responses:
7368         "200":
7369           description: successful operation
7370           schema:
7371               $ref: "#/getDefinitions/availability-zones"
7372         "default":
7373           description: Response codes found in [response codes](https://wiki.onap.org/).
7374       parameters:
7375         - name: cloud-owner
7376           in: path
7377           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7378           required: true
7379           type: string
7380           example: __CLOUD-OWNER__
7381         - name: cloud-region-id
7382           in: path
7383           description: Identifier used by the vendor for the region. Second part of composite key
7384           required: true
7385           type: string
7386           example: __CLOUD-REGION-ID__
7387         - name: availability-zone-name
7388           in: query
7389           description:
7390           required: false
7391           type: string
7392   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
7393     put:
7394       tags:
7395         - CloudInfrastructure
7396       summary: see node definition for valid relationships
7397       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7398       consumes:
7399         - application/json
7400         - application/xml
7401       produces:
7402         - application/json
7403         - application/xml
7404       responses:
7405         "default":
7406           description: Response codes found in [response codes](https://wiki.onap.org/).
7407       parameters:
7408         - name: cloud-owner
7409           in: path
7410           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7411           required: true
7412           type: string
7413           example: __CLOUD-OWNER__
7414         - name: cloud-region-id
7415           in: path
7416           description: Identifier used by the vendor for the region. Second part of composite key
7417           required: true
7418           type: string
7419           example: __CLOUD-REGION-ID__
7420         - name: body
7421           in: body
7422           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json)
7423           required: true
7424           schema:
7425             $ref: "#/definitions/relationship"
7426     delete:
7427       tags:
7428         - CloudInfrastructure
7429       summary: delete an existing relationship
7430       description: delete an existing relationship
7431       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7432       consumes:
7433         - application/json
7434         - application/xml
7435       produces:
7436         - application/json
7437         - application/xml
7438       responses:
7439         "default":
7440           description: Response codes found in [response codes](https://wiki.onap.org/).
7441       parameters:
7442         - name: cloud-owner
7443           in: path
7444           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7445           required: true
7446           type: string
7447           example: __CLOUD-OWNER__
7448         - name: cloud-region-id
7449           in: path
7450           description: Identifier used by the vendor for the region. Second part of composite key
7451           required: true
7452           type: string
7453           example: __CLOUD-REGION-ID__
7454   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
7455     put:
7456       tags:
7457         - CloudInfrastructure
7458       summary: see node definition for valid relationships
7459       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
7460       consumes:
7461         - application/json
7462         - application/xml
7463       produces:
7464         - application/json
7465         - application/xml
7466       responses:
7467         "default":
7468           description: Response codes found in [response codes](https://wiki.onap.org/).
7469       parameters:
7470         - name: cloud-owner
7471           in: path
7472           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7473           required: true
7474           type: string
7475           example: __CLOUD-OWNER__
7476         - name: cloud-region-id
7477           in: path
7478           description: Identifier used by the vendor for the region. Second part of composite key
7479           required: true
7480           type: string
7481           example: __CLOUD-REGION-ID__
7482         - name: vip-ipv4-address
7483           in: path
7484           description: IP address
7485           required: true
7486           type: string
7487           example: __VIP-IPV4-ADDRESS__
7488         - name: body
7489           in: body
7490           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
7491           required: true
7492           schema:
7493             $ref: "#/definitions/relationship"
7494     delete:
7495       tags:
7496         - CloudInfrastructure
7497       summary: delete an existing relationship
7498       description: delete an existing relationship
7499       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
7500       consumes:
7501         - application/json
7502         - application/xml
7503       produces:
7504         - application/json
7505         - application/xml
7506       responses:
7507         "default":
7508           description: Response codes found in [response codes](https://wiki.onap.org/).
7509       parameters:
7510         - name: cloud-owner
7511           in: path
7512           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7513           required: true
7514           type: string
7515           example: __CLOUD-OWNER__
7516         - name: cloud-region-id
7517           in: path
7518           description: Identifier used by the vendor for the region. Second part of composite key
7519           required: true
7520           type: string
7521           example: __CLOUD-REGION-ID__
7522         - name: vip-ipv4-address
7523           in: path
7524           description: IP address
7525           required: true
7526           type: string
7527           example: __VIP-IPV4-ADDRESS__
7528   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}:
7529     get:
7530       tags:
7531         - CloudInfrastructure
7532       summary: returns vip-ipv4-address-list
7533       description: returns vip-ipv4-address-list
7534       operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7535       produces:
7536         - application/json
7537         - application/xml
7538       responses:
7539         "200":
7540           description: successful operation
7541           schema:
7542               $ref: "#/getDefinitions/vip-ipv4-address-list"
7543         "default":
7544           description: Response codes found in [response codes](https://wiki.onap.org/).
7545       parameters:
7546         - name: cloud-owner
7547           in: path
7548           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7549           required: true
7550           type: string
7551           example: __CLOUD-OWNER__
7552         - name: cloud-region-id
7553           in: path
7554           description: Identifier used by the vendor for the region. Second part of composite key
7555           required: true
7556           type: string
7557           example: __CLOUD-REGION-ID__
7558         - name: vip-ipv4-address
7559           in: path
7560           description: IP address
7561           required: true
7562           type: string
7563           example: __VIP-IPV4-ADDRESS__
7564     put:
7565       tags:
7566         - CloudInfrastructure
7567       summary: create or update an existing vip-ipv4-address-list
7568       description: |
7569         Create or update an existing vip-ipv4-address-list.
7570         #
7571         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7572       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7573       consumes:
7574         - application/json
7575         - application/xml
7576       produces:
7577         - application/json
7578         - application/xml
7579       responses:
7580         "default":
7581           description: Response codes found in [response codes](https://wiki.onap.org/).
7582       parameters:
7583         - name: cloud-owner
7584           in: path
7585           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7586           required: true
7587           type: string
7588           example: __CLOUD-OWNER__
7589         - name: cloud-region-id
7590           in: path
7591           description: Identifier used by the vendor for the region. Second part of composite key
7592           required: true
7593           type: string
7594           example: __CLOUD-REGION-ID__
7595         - name: vip-ipv4-address
7596           in: path
7597           description: IP address
7598           required: true
7599           type: string
7600           example: __VIP-IPV4-ADDRESS__
7601         - name: body
7602           in: body
7603           description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
7604           required: true
7605           schema:
7606             $ref: "#/definitions/vip-ipv4-address-list"
7607     patch:
7608       tags:
7609         - CloudInfrastructure
7610       summary: update an existing vip-ipv4-address-list
7611       description: |
7612         Update an existing vip-ipv4-address-list
7613         #
7614         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7615         The PUT operation will entirely replace an existing object.
7616         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7617         #
7618         Other differences between PUT and PATCH are:
7619         #
7620         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7621         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7622         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7623       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7624       consumes:
7625         - application/json
7626         - application/xml
7627       produces:
7628         - application/json
7629         - application/xml
7630       responses:
7631         "default":
7632           description: Response codes found in [response codes](https://wiki.onap.org/).
7633       parameters:
7634         - name: cloud-owner
7635           in: path
7636           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7637           required: true
7638           type: string
7639           example: __CLOUD-OWNER__
7640         - name: cloud-region-id
7641           in: path
7642           description: Identifier used by the vendor for the region. Second part of composite key
7643           required: true
7644           type: string
7645           example: __CLOUD-REGION-ID__
7646         - name: vip-ipv4-address
7647           in: path
7648           description: IP address
7649           required: true
7650           type: string
7651           example: __VIP-IPV4-ADDRESS__
7652         - name: body
7653           in: body
7654           description: vip-ipv4-address-list object that needs to be updated.
7655           required: true
7656           schema:
7657             $ref: "#/patchDefinitions/vip-ipv4-address-list"
7658     delete:
7659       tags:
7660         - CloudInfrastructure
7661       summary: delete an existing vip-ipv4-address-list
7662       description: delete an existing vip-ipv4-address-list
7663       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7664       consumes:
7665         - application/json
7666         - application/xml
7667       produces:
7668         - application/json
7669         - application/xml
7670       responses:
7671         "default":
7672           description: Response codes found in [response codes](https://wiki.onap.org/).
7673       parameters:
7674         - name: cloud-owner
7675           in: path
7676           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7677           required: true
7678           type: string
7679           example: __CLOUD-OWNER__
7680         - name: cloud-region-id
7681           in: path
7682           description: Identifier used by the vendor for the region. Second part of composite key
7683           required: true
7684           type: string
7685           example: __CLOUD-REGION-ID__
7686         - name: vip-ipv4-address
7687           in: path
7688           description: IP address
7689           required: true
7690           type: string
7691           example: __VIP-IPV4-ADDRESS__
7692         - name: resource-version
7693           in: query
7694           description: resource-version for concurrency
7695           required: true
7696           type: string
7697   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
7698     put:
7699       tags:
7700         - CloudInfrastructure
7701       summary: see node definition for valid relationships
7702       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
7703       consumes:
7704         - application/json
7705         - application/xml
7706       produces:
7707         - application/json
7708         - application/xml
7709       responses:
7710         "default":
7711           description: Response codes found in [response codes](https://wiki.onap.org/).
7712       parameters:
7713         - name: cloud-owner
7714           in: path
7715           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7716           required: true
7717           type: string
7718           example: __CLOUD-OWNER__
7719         - name: cloud-region-id
7720           in: path
7721           description: Identifier used by the vendor for the region. Second part of composite key
7722           required: true
7723           type: string
7724           example: __CLOUD-REGION-ID__
7725         - name: vip-ipv6-address
7726           in: path
7727           description: IP address
7728           required: true
7729           type: string
7730           example: __VIP-IPV6-ADDRESS__
7731         - name: body
7732           in: body
7733           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
7734           required: true
7735           schema:
7736             $ref: "#/definitions/relationship"
7737     delete:
7738       tags:
7739         - CloudInfrastructure
7740       summary: delete an existing relationship
7741       description: delete an existing relationship
7742       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
7743       consumes:
7744         - application/json
7745         - application/xml
7746       produces:
7747         - application/json
7748         - application/xml
7749       responses:
7750         "default":
7751           description: Response codes found in [response codes](https://wiki.onap.org/).
7752       parameters:
7753         - name: cloud-owner
7754           in: path
7755           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7756           required: true
7757           type: string
7758           example: __CLOUD-OWNER__
7759         - name: cloud-region-id
7760           in: path
7761           description: Identifier used by the vendor for the region. Second part of composite key
7762           required: true
7763           type: string
7764           example: __CLOUD-REGION-ID__
7765         - name: vip-ipv6-address
7766           in: path
7767           description: IP address
7768           required: true
7769           type: string
7770           example: __VIP-IPV6-ADDRESS__
7771   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
7772     get:
7773       tags:
7774         - CloudInfrastructure
7775       summary: returns vip-ipv6-address-list
7776       description: returns vip-ipv6-address-list
7777       operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7778       produces:
7779         - application/json
7780         - application/xml
7781       responses:
7782         "200":
7783           description: successful operation
7784           schema:
7785               $ref: "#/getDefinitions/vip-ipv6-address-list"
7786         "default":
7787           description: Response codes found in [response codes](https://wiki.onap.org/).
7788       parameters:
7789         - name: cloud-owner
7790           in: path
7791           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7792           required: true
7793           type: string
7794           example: __CLOUD-OWNER__
7795         - name: cloud-region-id
7796           in: path
7797           description: Identifier used by the vendor for the region. Second part of composite key
7798           required: true
7799           type: string
7800           example: __CLOUD-REGION-ID__
7801         - name: vip-ipv6-address
7802           in: path
7803           description: IP address
7804           required: true
7805           type: string
7806           example: __VIP-IPV6-ADDRESS__
7807     put:
7808       tags:
7809         - CloudInfrastructure
7810       summary: create or update an existing vip-ipv6-address-list
7811       description: |
7812         Create or update an existing vip-ipv6-address-list.
7813         #
7814         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7815       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7816       consumes:
7817         - application/json
7818         - application/xml
7819       produces:
7820         - application/json
7821         - application/xml
7822       responses:
7823         "default":
7824           description: Response codes found in [response codes](https://wiki.onap.org/).
7825       parameters:
7826         - name: cloud-owner
7827           in: path
7828           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7829           required: true
7830           type: string
7831           example: __CLOUD-OWNER__
7832         - name: cloud-region-id
7833           in: path
7834           description: Identifier used by the vendor for the region. Second part of composite key
7835           required: true
7836           type: string
7837           example: __CLOUD-REGION-ID__
7838         - name: vip-ipv6-address
7839           in: path
7840           description: IP address
7841           required: true
7842           type: string
7843           example: __VIP-IPV6-ADDRESS__
7844         - name: body
7845           in: body
7846           description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
7847           required: true
7848           schema:
7849             $ref: "#/definitions/vip-ipv6-address-list"
7850     patch:
7851       tags:
7852         - CloudInfrastructure
7853       summary: update an existing vip-ipv6-address-list
7854       description: |
7855         Update an existing vip-ipv6-address-list
7856         #
7857         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7858         The PUT operation will entirely replace an existing object.
7859         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7860         #
7861         Other differences between PUT and PATCH are:
7862         #
7863         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7864         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7865         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7866       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7867       consumes:
7868         - application/json
7869         - application/xml
7870       produces:
7871         - application/json
7872         - application/xml
7873       responses:
7874         "default":
7875           description: Response codes found in [response codes](https://wiki.onap.org/).
7876       parameters:
7877         - name: cloud-owner
7878           in: path
7879           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7880           required: true
7881           type: string
7882           example: __CLOUD-OWNER__
7883         - name: cloud-region-id
7884           in: path
7885           description: Identifier used by the vendor for the region. Second part of composite key
7886           required: true
7887           type: string
7888           example: __CLOUD-REGION-ID__
7889         - name: vip-ipv6-address
7890           in: path
7891           description: IP address
7892           required: true
7893           type: string
7894           example: __VIP-IPV6-ADDRESS__
7895         - name: body
7896           in: body
7897           description: vip-ipv6-address-list object that needs to be updated.
7898           required: true
7899           schema:
7900             $ref: "#/patchDefinitions/vip-ipv6-address-list"
7901     delete:
7902       tags:
7903         - CloudInfrastructure
7904       summary: delete an existing vip-ipv6-address-list
7905       description: delete an existing vip-ipv6-address-list
7906       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7907       consumes:
7908         - application/json
7909         - application/xml
7910       produces:
7911         - application/json
7912         - application/xml
7913       responses:
7914         "default":
7915           description: Response codes found in [response codes](https://wiki.onap.org/).
7916       parameters:
7917         - name: cloud-owner
7918           in: path
7919           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7920           required: true
7921           type: string
7922           example: __CLOUD-OWNER__
7923         - name: cloud-region-id
7924           in: path
7925           description: Identifier used by the vendor for the region. Second part of composite key
7926           required: true
7927           type: string
7928           example: __CLOUD-REGION-ID__
7929         - name: vip-ipv6-address
7930           in: path
7931           description: IP address
7932           required: true
7933           type: string
7934           example: __VIP-IPV6-ADDRESS__
7935         - name: resource-version
7936           in: query
7937           description: resource-version for concurrency
7938           required: true
7939           type: string
7940   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship:
7941     put:
7942       tags:
7943         - CloudInfrastructure
7944       summary: see node definition for valid relationships
7945       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship
7946       consumes:
7947         - application/json
7948         - application/xml
7949       produces:
7950         - application/json
7951         - application/xml
7952       responses:
7953         "default":
7954           description: Response codes found in [response codes](https://wiki.onap.org/).
7955       parameters:
7956         - name: cloud-owner
7957           in: path
7958           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7959           required: true
7960           type: string
7961           example: __CLOUD-OWNER__
7962         - name: cloud-region-id
7963           in: path
7964           description: Identifier used by the vendor for the region. Second part of composite key
7965           required: true
7966           type: string
7967           example: __CLOUD-REGION-ID__
7968         - name: hpa-capability-id
7969           in: path
7970           description: UUID to uniquely identify a HPA capability
7971           required: true
7972           type: string
7973           example: __HPA-CAPABILITY-ID__
7974         - name: body
7975           in: body
7976           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)
7977           required: true
7978           schema:
7979             $ref: "#/definitions/relationship"
7980     delete:
7981       tags:
7982         - CloudInfrastructure
7983       summary: delete an existing relationship
7984       description: delete an existing relationship
7985       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship
7986       consumes:
7987         - application/json
7988         - application/xml
7989       produces:
7990         - application/json
7991         - application/xml
7992       responses:
7993         "default":
7994           description: Response codes found in [response codes](https://wiki.onap.org/).
7995       parameters:
7996         - name: cloud-owner
7997           in: path
7998           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7999           required: true
8000           type: string
8001           example: __CLOUD-OWNER__
8002         - name: cloud-region-id
8003           in: path
8004           description: Identifier used by the vendor for the region. Second part of composite key
8005           required: true
8006           type: string
8007           example: __CLOUD-REGION-ID__
8008         - name: hpa-capability-id
8009           in: path
8010           description: UUID to uniquely identify a HPA capability
8011           required: true
8012           type: string
8013           example: __HPA-CAPABILITY-ID__
8014   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship:
8015     put:
8016       tags:
8017         - CloudInfrastructure
8018       summary: see node definition for valid relationships
8019       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
8020       consumes:
8021         - application/json
8022         - application/xml
8023       produces:
8024         - application/json
8025         - application/xml
8026       responses:
8027         "default":
8028           description: Response codes found in [response codes](https://wiki.onap.org/).
8029       parameters:
8030         - name: cloud-owner
8031           in: path
8032           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8033           required: true
8034           type: string
8035           example: __CLOUD-OWNER__
8036         - name: cloud-region-id
8037           in: path
8038           description: Identifier used by the vendor for the region. Second part of composite key
8039           required: true
8040           type: string
8041           example: __CLOUD-REGION-ID__
8042         - name: hpa-capability-id
8043           in: path
8044           description: UUID to uniquely identify a HPA capability
8045           required: true
8046           type: string
8047           example: __HPA-CAPABILITY-ID__
8048         - name: hpa-attribute-key
8049           in: path
8050           description: name of the specific HPA attribute
8051           required: true
8052           type: string
8053           example: __HPA-ATTRIBUTE-KEY__
8054         - name: body
8055           in: body
8056           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
8057           required: true
8058           schema:
8059             $ref: "#/definitions/relationship"
8060     delete:
8061       tags:
8062         - CloudInfrastructure
8063       summary: delete an existing relationship
8064       description: delete an existing relationship
8065       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
8066       consumes:
8067         - application/json
8068         - application/xml
8069       produces:
8070         - application/json
8071         - application/xml
8072       responses:
8073         "default":
8074           description: Response codes found in [response codes](https://wiki.onap.org/).
8075       parameters:
8076         - name: cloud-owner
8077           in: path
8078           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8079           required: true
8080           type: string
8081           example: __CLOUD-OWNER__
8082         - name: cloud-region-id
8083           in: path
8084           description: Identifier used by the vendor for the region. Second part of composite key
8085           required: true
8086           type: string
8087           example: __CLOUD-REGION-ID__
8088         - name: hpa-capability-id
8089           in: path
8090           description: UUID to uniquely identify a HPA capability
8091           required: true
8092           type: string
8093           example: __HPA-CAPABILITY-ID__
8094         - name: hpa-attribute-key
8095           in: path
8096           description: name of the specific HPA attribute
8097           required: true
8098           type: string
8099           example: __HPA-ATTRIBUTE-KEY__
8100   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}:
8101     get:
8102       tags:
8103         - CloudInfrastructure
8104       summary: returns hpa-feature-attributes
8105       description: returns hpa-feature-attributes
8106       operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8107       produces:
8108         - application/json
8109         - application/xml
8110       responses:
8111         "200":
8112           description: successful operation
8113           schema:
8114               $ref: "#/getDefinitions/hpa-feature-attributes"
8115         "default":
8116           description: Response codes found in [response codes](https://wiki.onap.org/).
8117       parameters:
8118         - name: cloud-owner
8119           in: path
8120           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8121           required: true
8122           type: string
8123           example: __CLOUD-OWNER__
8124         - name: cloud-region-id
8125           in: path
8126           description: Identifier used by the vendor for the region. Second part of composite key
8127           required: true
8128           type: string
8129           example: __CLOUD-REGION-ID__
8130         - name: hpa-capability-id
8131           in: path
8132           description: UUID to uniquely identify a HPA capability
8133           required: true
8134           type: string
8135           example: __HPA-CAPABILITY-ID__
8136         - name: hpa-attribute-key
8137           in: path
8138           description: name of the specific HPA attribute
8139           required: true
8140           type: string
8141           example: __HPA-ATTRIBUTE-KEY__
8142     put:
8143       tags:
8144         - CloudInfrastructure
8145       summary: create or update an existing hpa-feature-attributes
8146       description: |
8147         Create or update an existing hpa-feature-attributes.
8148         #
8149         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8150       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8151       consumes:
8152         - application/json
8153         - application/xml
8154       produces:
8155         - application/json
8156         - application/xml
8157       responses:
8158         "default":
8159           description: Response codes found in [response codes](https://wiki.onap.org/).
8160       parameters:
8161         - name: cloud-owner
8162           in: path
8163           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8164           required: true
8165           type: string
8166           example: __CLOUD-OWNER__
8167         - name: cloud-region-id
8168           in: path
8169           description: Identifier used by the vendor for the region. Second part of composite key
8170           required: true
8171           type: string
8172           example: __CLOUD-REGION-ID__
8173         - name: hpa-capability-id
8174           in: path
8175           description: UUID to uniquely identify a HPA capability
8176           required: true
8177           type: string
8178           example: __HPA-CAPABILITY-ID__
8179         - name: hpa-attribute-key
8180           in: path
8181           description: name of the specific HPA attribute
8182           required: true
8183           type: string
8184           example: __HPA-ATTRIBUTE-KEY__
8185         - name: body
8186           in: body
8187           description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
8188           required: true
8189           schema:
8190             $ref: "#/definitions/hpa-feature-attributes"
8191     patch:
8192       tags:
8193         - CloudInfrastructure
8194       summary: update an existing hpa-feature-attributes
8195       description: |
8196         Update an existing hpa-feature-attributes
8197         #
8198         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8199         The PUT operation will entirely replace an existing object.
8200         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8201         #
8202         Other differences between PUT and PATCH are:
8203         #
8204         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8205         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8206         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8207       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8208       consumes:
8209         - application/json
8210         - application/xml
8211       produces:
8212         - application/json
8213         - application/xml
8214       responses:
8215         "default":
8216           description: Response codes found in [response codes](https://wiki.onap.org/).
8217       parameters:
8218         - name: cloud-owner
8219           in: path
8220           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8221           required: true
8222           type: string
8223           example: __CLOUD-OWNER__
8224         - name: cloud-region-id
8225           in: path
8226           description: Identifier used by the vendor for the region. Second part of composite key
8227           required: true
8228           type: string
8229           example: __CLOUD-REGION-ID__
8230         - name: hpa-capability-id
8231           in: path
8232           description: UUID to uniquely identify a HPA capability
8233           required: true
8234           type: string
8235           example: __HPA-CAPABILITY-ID__
8236         - name: hpa-attribute-key
8237           in: path
8238           description: name of the specific HPA attribute
8239           required: true
8240           type: string
8241           example: __HPA-ATTRIBUTE-KEY__
8242         - name: body
8243           in: body
8244           description: hpa-feature-attributes object that needs to be updated.
8245           required: true
8246           schema:
8247             $ref: "#/patchDefinitions/hpa-feature-attributes"
8248     delete:
8249       tags:
8250         - CloudInfrastructure
8251       summary: delete an existing hpa-feature-attributes
8252       description: delete an existing hpa-feature-attributes
8253       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8254       consumes:
8255         - application/json
8256         - application/xml
8257       produces:
8258         - application/json
8259         - application/xml
8260       responses:
8261         "default":
8262           description: Response codes found in [response codes](https://wiki.onap.org/).
8263       parameters:
8264         - name: cloud-owner
8265           in: path
8266           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8267           required: true
8268           type: string
8269           example: __CLOUD-OWNER__
8270         - name: cloud-region-id
8271           in: path
8272           description: Identifier used by the vendor for the region. Second part of composite key
8273           required: true
8274           type: string
8275           example: __CLOUD-REGION-ID__
8276         - name: hpa-capability-id
8277           in: path
8278           description: UUID to uniquely identify a HPA capability
8279           required: true
8280           type: string
8281           example: __HPA-CAPABILITY-ID__
8282         - name: hpa-attribute-key
8283           in: path
8284           description: name of the specific HPA attribute
8285           required: true
8286           type: string
8287           example: __HPA-ATTRIBUTE-KEY__
8288         - name: resource-version
8289           in: query
8290           description: resource-version for concurrency
8291           required: true
8292           type: string
8293   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
8294     get:
8295       tags:
8296         - CloudInfrastructure
8297       summary: returns hpa-capability
8298       description: returns hpa-capability
8299       operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8300       produces:
8301         - application/json
8302         - application/xml
8303       responses:
8304         "200":
8305           description: successful operation
8306           schema:
8307               $ref: "#/getDefinitions/hpa-capability"
8308         "default":
8309           description: Response codes found in [response codes](https://wiki.onap.org/).
8310       parameters:
8311         - name: cloud-owner
8312           in: path
8313           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8314           required: true
8315           type: string
8316           example: __CLOUD-OWNER__
8317         - name: cloud-region-id
8318           in: path
8319           description: Identifier used by the vendor for the region. Second part of composite key
8320           required: true
8321           type: string
8322           example: __CLOUD-REGION-ID__
8323         - name: hpa-capability-id
8324           in: path
8325           description: UUID to uniquely identify a HPA capability
8326           required: true
8327           type: string
8328           example: __HPA-CAPABILITY-ID__
8329     put:
8330       tags:
8331         - CloudInfrastructure
8332       summary: create or update an existing hpa-capability
8333       description: |
8334         Create or update an existing hpa-capability.
8335         #
8336         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8337       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8338       consumes:
8339         - application/json
8340         - application/xml
8341       produces:
8342         - application/json
8343         - application/xml
8344       responses:
8345         "default":
8346           description: Response codes found in [response codes](https://wiki.onap.org/).
8347       parameters:
8348         - name: cloud-owner
8349           in: path
8350           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8351           required: true
8352           type: string
8353           example: __CLOUD-OWNER__
8354         - name: cloud-region-id
8355           in: path
8356           description: Identifier used by the vendor for the region. Second part of composite key
8357           required: true
8358           type: string
8359           example: __CLOUD-REGION-ID__
8360         - name: hpa-capability-id
8361           in: path
8362           description: UUID to uniquely identify a HPA capability
8363           required: true
8364           type: string
8365           example: __HPA-CAPABILITY-ID__
8366         - name: body
8367           in: body
8368           description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)
8369           required: true
8370           schema:
8371             $ref: "#/definitions/hpa-capability"
8372     patch:
8373       tags:
8374         - CloudInfrastructure
8375       summary: update an existing hpa-capability
8376       description: |
8377         Update an existing hpa-capability
8378         #
8379         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8380         The PUT operation will entirely replace an existing object.
8381         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8382         #
8383         Other differences between PUT and PATCH are:
8384         #
8385         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8386         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8387         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8388       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8389       consumes:
8390         - application/json
8391         - application/xml
8392       produces:
8393         - application/json
8394         - application/xml
8395       responses:
8396         "default":
8397           description: Response codes found in [response codes](https://wiki.onap.org/).
8398       parameters:
8399         - name: cloud-owner
8400           in: path
8401           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8402           required: true
8403           type: string
8404           example: __CLOUD-OWNER__
8405         - name: cloud-region-id
8406           in: path
8407           description: Identifier used by the vendor for the region. Second part of composite key
8408           required: true
8409           type: string
8410           example: __CLOUD-REGION-ID__
8411         - name: hpa-capability-id
8412           in: path
8413           description: UUID to uniquely identify a HPA capability
8414           required: true
8415           type: string
8416           example: __HPA-CAPABILITY-ID__
8417         - name: body
8418           in: body
8419           description: hpa-capability object that needs to be updated.
8420           required: true
8421           schema:
8422             $ref: "#/patchDefinitions/hpa-capability"
8423     delete:
8424       tags:
8425         - CloudInfrastructure
8426       summary: delete an existing hpa-capability
8427       description: delete an existing hpa-capability
8428       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8429       consumes:
8430         - application/json
8431         - application/xml
8432       produces:
8433         - application/json
8434         - application/xml
8435       responses:
8436         "default":
8437           description: Response codes found in [response codes](https://wiki.onap.org/).
8438       parameters:
8439         - name: cloud-owner
8440           in: path
8441           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8442           required: true
8443           type: string
8444           example: __CLOUD-OWNER__
8445         - name: cloud-region-id
8446           in: path
8447           description: Identifier used by the vendor for the region. Second part of composite key
8448           required: true
8449           type: string
8450           example: __CLOUD-REGION-ID__
8451         - name: hpa-capability-id
8452           in: path
8453           description: UUID to uniquely identify a HPA capability
8454           required: true
8455           type: string
8456           example: __HPA-CAPABILITY-ID__
8457         - name: resource-version
8458           in: query
8459           description: resource-version for concurrency
8460           required: true
8461           type: string
8462   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities:
8463     get:
8464       tags:
8465         - CloudInfrastructure
8466       summary: returns hpa-capabilities
8467       description: returns hpa-capabilities
8468       operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilities
8469       produces:
8470         - application/json
8471         - application/xml
8472       responses:
8473         "200":
8474           description: successful operation
8475           schema:
8476               $ref: "#/getDefinitions/hpa-capabilities"
8477         "default":
8478           description: Response codes found in [response codes](https://wiki.onap.org/).
8479       parameters:
8480         - name: cloud-owner
8481           in: path
8482           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8483           required: true
8484           type: string
8485           example: __CLOUD-OWNER__
8486         - name: cloud-region-id
8487           in: path
8488           description: Identifier used by the vendor for the region. Second part of composite key
8489           required: true
8490           type: string
8491           example: __CLOUD-REGION-ID__
8492         - name: hpa-capability-id
8493           in: query
8494           description:
8495           required: false
8496           type: string
8497         - name: hpa-feature
8498           in: query
8499           description:
8500           required: false
8501           type: string
8502         - name: architecture
8503           in: query
8504           description:
8505           required: false
8506           type: string
8507   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
8508     get:
8509       tags:
8510         - CloudInfrastructure
8511       summary: returns cloud-region
8512       description: returns cloud-region
8513       operationId: getCloudInfrastructureCloudRegionsCloudRegion
8514       produces:
8515         - application/json
8516         - application/xml
8517       responses:
8518         "200":
8519           description: successful operation
8520           schema:
8521               $ref: "#/getDefinitions/cloud-region"
8522         "default":
8523           description: Response codes found in [response codes](https://wiki.onap.org/).
8524       parameters:
8525         - name: cloud-owner
8526           in: path
8527           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8528           required: true
8529           type: string
8530           example: __CLOUD-OWNER__
8531         - name: cloud-region-id
8532           in: path
8533           description: Identifier used by the vendor for the region. Second part of composite key
8534           required: true
8535           type: string
8536           example: __CLOUD-REGION-ID__
8537     put:
8538       tags:
8539         - CloudInfrastructure
8540       summary: create or update an existing cloud-region
8541       description: |
8542         Create or update an existing cloud-region.
8543         #
8544         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8545       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
8546       consumes:
8547         - application/json
8548         - application/xml
8549       produces:
8550         - application/json
8551         - application/xml
8552       responses:
8553         "default":
8554           description: Response codes found in [response codes](https://wiki.onap.org/).
8555       parameters:
8556         - name: cloud-owner
8557           in: path
8558           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8559           required: true
8560           type: string
8561           example: __CLOUD-OWNER__
8562         - name: cloud-region-id
8563           in: path
8564           description: Identifier used by the vendor for the region. Second part of composite key
8565           required: true
8566           type: string
8567           example: __CLOUD-REGION-ID__
8568         - name: body
8569           in: body
8570           description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json)
8571           required: true
8572           schema:
8573             $ref: "#/definitions/cloud-region"
8574     patch:
8575       tags:
8576         - CloudInfrastructure
8577       summary: update an existing cloud-region
8578       description: |
8579         Update an existing cloud-region
8580         #
8581         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8582         The PUT operation will entirely replace an existing object.
8583         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8584         #
8585         Other differences between PUT and PATCH are:
8586         #
8587         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8588         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8589         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8590       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
8591       consumes:
8592         - application/json
8593         - application/xml
8594       produces:
8595         - application/json
8596         - application/xml
8597       responses:
8598         "default":
8599           description: Response codes found in [response codes](https://wiki.onap.org/).
8600       parameters:
8601         - name: cloud-owner
8602           in: path
8603           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8604           required: true
8605           type: string
8606           example: __CLOUD-OWNER__
8607         - name: cloud-region-id
8608           in: path
8609           description: Identifier used by the vendor for the region. Second part of composite key
8610           required: true
8611           type: string
8612           example: __CLOUD-REGION-ID__
8613         - name: body
8614           in: body
8615           description: cloud-region object that needs to be updated.
8616           required: true
8617           schema:
8618             $ref: "#/patchDefinitions/cloud-region"
8619     delete:
8620       tags:
8621         - CloudInfrastructure
8622       summary: delete an existing cloud-region
8623       description: delete an existing cloud-region
8624       operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
8625       consumes:
8626         - application/json
8627         - application/xml
8628       produces:
8629         - application/json
8630         - application/xml
8631       responses:
8632         "default":
8633           description: Response codes found in [response codes](https://wiki.onap.org/).
8634       parameters:
8635         - name: cloud-owner
8636           in: path
8637           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8638           required: true
8639           type: string
8640           example: __CLOUD-OWNER__
8641         - name: cloud-region-id
8642           in: path
8643           description: Identifier used by the vendor for the region. Second part of composite key
8644           required: true
8645           type: string
8646           example: __CLOUD-REGION-ID__
8647         - name: resource-version
8648           in: query
8649           description: resource-version for concurrency
8650           required: true
8651           type: string
8652   /cloud-infrastructure/cloud-regions:
8653     get:
8654       tags:
8655         - CloudInfrastructure
8656       summary: returns cloud-regions
8657       description: returns cloud-regions
8658       operationId: getCloudInfrastructureCloudRegions
8659       produces:
8660         - application/json
8661         - application/xml
8662       responses:
8663         "200":
8664           description: successful operation
8665           schema:
8666               $ref: "#/getDefinitions/cloud-regions"
8667         "default":
8668           description: Response codes found in [response codes](https://wiki.onap.org/).
8669       parameters:
8670         - name: cloud-owner
8671           in: query
8672           description:
8673           required: false
8674           type: string
8675         - name: cloud-region-id
8676           in: query
8677           description:
8678           required: false
8679           type: string
8680         - name: cloud-type
8681           in: query
8682           description:
8683           required: false
8684           type: string
8685         - name: owner-defined-type
8686           in: query
8687           description:
8688           required: false
8689           type: string
8690   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
8691     put:
8692       tags:
8693         - CloudInfrastructure
8694       summary: see node definition for valid relationships
8695       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
8696       consumes:
8697         - application/json
8698         - application/xml
8699       produces:
8700         - application/json
8701         - application/xml
8702       responses:
8703         "default":
8704           description: Response codes found in [response codes](https://wiki.onap.org/).
8705       parameters:
8706         - name: nm-profile-name
8707           in: path
8708           description: Unique name of network profile.
8709           required: true
8710           type: string
8711           example: __NM-PROFILE-NAME__
8712         - name: body
8713           in: body
8714           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json)
8715           required: true
8716           schema:
8717             $ref: "#/definitions/relationship"
8718     delete:
8719       tags:
8720         - CloudInfrastructure
8721       summary: delete an existing relationship
8722       description: delete an existing relationship
8723       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
8724       consumes:
8725         - application/json
8726         - application/xml
8727       produces:
8728         - application/json
8729         - application/xml
8730       responses:
8731         "default":
8732           description: Response codes found in [response codes](https://wiki.onap.org/).
8733       parameters:
8734         - name: nm-profile-name
8735           in: path
8736           description: Unique name of network profile.
8737           required: true
8738           type: string
8739           example: __NM-PROFILE-NAME__
8740   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
8741     get:
8742       tags:
8743         - CloudInfrastructure
8744       summary: returns network-profile
8745       description: returns network-profile
8746       operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
8747       produces:
8748         - application/json
8749         - application/xml
8750       responses:
8751         "200":
8752           description: successful operation
8753           schema:
8754               $ref: "#/getDefinitions/network-profile"
8755         "default":
8756           description: Response codes found in [response codes](https://wiki.onap.org/).
8757       parameters:
8758         - name: nm-profile-name
8759           in: path
8760           description: Unique name of network profile.
8761           required: true
8762           type: string
8763           example: __NM-PROFILE-NAME__
8764     put:
8765       tags:
8766         - CloudInfrastructure
8767       summary: create or update an existing network-profile
8768       description: |
8769         Create or update an existing network-profile.
8770         #
8771         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8772       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
8773       consumes:
8774         - application/json
8775         - application/xml
8776       produces:
8777         - application/json
8778         - application/xml
8779       responses:
8780         "default":
8781           description: Response codes found in [response codes](https://wiki.onap.org/).
8782       parameters:
8783         - name: nm-profile-name
8784           in: path
8785           description: Unique name of network profile.
8786           required: true
8787           type: string
8788           example: __NM-PROFILE-NAME__
8789         - name: body
8790           in: body
8791           description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json)
8792           required: true
8793           schema:
8794             $ref: "#/definitions/network-profile"
8795     patch:
8796       tags:
8797         - CloudInfrastructure
8798       summary: update an existing network-profile
8799       description: |
8800         Update an existing network-profile
8801         #
8802         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8803         The PUT operation will entirely replace an existing object.
8804         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8805         #
8806         Other differences between PUT and PATCH are:
8807         #
8808         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8809         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8810         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8811       operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
8812       consumes:
8813         - application/json
8814         - application/xml
8815       produces:
8816         - application/json
8817         - application/xml
8818       responses:
8819         "default":
8820           description: Response codes found in [response codes](https://wiki.onap.org/).
8821       parameters:
8822         - name: nm-profile-name
8823           in: path
8824           description: Unique name of network profile.
8825           required: true
8826           type: string
8827           example: __NM-PROFILE-NAME__
8828         - name: body
8829           in: body
8830           description: network-profile object that needs to be updated.
8831           required: true
8832           schema:
8833             $ref: "#/patchDefinitions/network-profile"
8834     delete:
8835       tags:
8836         - CloudInfrastructure
8837       summary: delete an existing network-profile
8838       description: delete an existing network-profile
8839       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
8840       consumes:
8841         - application/json
8842         - application/xml
8843       produces:
8844         - application/json
8845         - application/xml
8846       responses:
8847         "default":
8848           description: Response codes found in [response codes](https://wiki.onap.org/).
8849       parameters:
8850         - name: nm-profile-name
8851           in: path
8852           description: Unique name of network profile.
8853           required: true
8854           type: string
8855           example: __NM-PROFILE-NAME__
8856         - name: resource-version
8857           in: query
8858           description: resource-version for concurrency
8859           required: true
8860           type: string
8861   /cloud-infrastructure/network-profiles:
8862     get:
8863       tags:
8864         - CloudInfrastructure
8865       summary: returns network-profiles
8866       description: returns network-profiles
8867       operationId: getCloudInfrastructureNetworkProfiles
8868       produces:
8869         - application/json
8870         - application/xml
8871       responses:
8872         "200":
8873           description: successful operation
8874           schema:
8875               $ref: "#/getDefinitions/network-profiles"
8876         "default":
8877           description: Response codes found in [response codes](https://wiki.onap.org/).
8878       parameters:
8879         - name: nm-profile-name
8880           in: query
8881           description:
8882           required: false
8883           type: string
8884   /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
8885     put:
8886       tags:
8887         - CloudInfrastructure
8888       summary: see node definition for valid relationships
8889       operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
8890       consumes:
8891         - application/json
8892         - application/xml
8893       produces:
8894         - application/json
8895         - application/xml
8896       responses:
8897         "default":
8898           description: Response codes found in [response codes](https://wiki.onap.org/).
8899       parameters:
8900         - name: hostname
8901           in: path
8902           description: Value from executing hostname on the compute node.
8903           required: true
8904           type: string
8905           example: __HOSTNAME__
8906         - name: body
8907           in: body
8908           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json)
8909           required: true
8910           schema:
8911             $ref: "#/definitions/relationship"
8912     delete:
8913       tags:
8914         - CloudInfrastructure
8915       summary: delete an existing relationship
8916       description: delete an existing relationship
8917       operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
8918       consumes:
8919         - application/json
8920         - application/xml
8921       produces:
8922         - application/json
8923         - application/xml
8924       responses:
8925         "default":
8926           description: Response codes found in [response codes](https://wiki.onap.org/).
8927       parameters:
8928         - name: hostname
8929           in: path
8930           description: Value from executing hostname on the compute node.
8931           required: true
8932           type: string
8933           example: __HOSTNAME__
8934   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
8935     put:
8936       tags:
8937         - CloudInfrastructure
8938       summary: see node definition for valid relationships
8939       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
8940       consumes:
8941         - application/json
8942         - application/xml
8943       produces:
8944         - application/json
8945         - application/xml
8946       responses:
8947         "default":
8948           description: Response codes found in [response codes](https://wiki.onap.org/).
8949       parameters:
8950         - name: hostname
8951           in: path
8952           description: Value from executing hostname on the compute node.
8953           required: true
8954           type: string
8955           example: __HOSTNAME__
8956         - name: interface-name
8957           in: path
8958           description: Name that identifies the physical interface
8959           required: true
8960           type: string
8961           example: __INTERFACE-NAME__
8962         - name: body
8963           in: body
8964           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
8965           required: true
8966           schema:
8967             $ref: "#/definitions/relationship"
8968     delete:
8969       tags:
8970         - CloudInfrastructure
8971       summary: delete an existing relationship
8972       description: delete an existing relationship
8973       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
8974       consumes:
8975         - application/json
8976         - application/xml
8977       produces:
8978         - application/json
8979         - application/xml
8980       responses:
8981         "default":
8982           description: Response codes found in [response codes](https://wiki.onap.org/).
8983       parameters:
8984         - name: hostname
8985           in: path
8986           description: Value from executing hostname on the compute node.
8987           required: true
8988           type: string
8989           example: __HOSTNAME__
8990         - name: interface-name
8991           in: path
8992           description: Name that identifies the physical interface
8993           required: true
8994           type: string
8995           example: __INTERFACE-NAME__
8996   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
8997     put:
8998       tags:
8999         - CloudInfrastructure
9000       summary: see node definition for valid relationships
9001       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
9002       consumes:
9003         - application/json
9004         - application/xml
9005       produces:
9006         - application/json
9007         - application/xml
9008       responses:
9009         "default":
9010           description: Response codes found in [response codes](https://wiki.onap.org/).
9011       parameters:
9012         - name: hostname
9013           in: path
9014           description: Value from executing hostname on the compute node.
9015           required: true
9016           type: string
9017           example: __HOSTNAME__
9018         - name: interface-name
9019           in: path
9020           description: Name that identifies the physical interface
9021           required: true
9022           type: string
9023           example: __INTERFACE-NAME__
9024         - name: pf-pci-id
9025           in: path
9026           description: Identifier for the sriov-pf
9027           required: true
9028           type: string
9029           example: __PF-PCI-ID__
9030         - name: body
9031           in: body
9032           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
9033           required: true
9034           schema:
9035             $ref: "#/definitions/relationship"
9036     delete:
9037       tags:
9038         - CloudInfrastructure
9039       summary: delete an existing relationship
9040       description: delete an existing relationship
9041       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
9042       consumes:
9043         - application/json
9044         - application/xml
9045       produces:
9046         - application/json
9047         - application/xml
9048       responses:
9049         "default":
9050           description: Response codes found in [response codes](https://wiki.onap.org/).
9051       parameters:
9052         - name: hostname
9053           in: path
9054           description: Value from executing hostname on the compute node.
9055           required: true
9056           type: string
9057           example: __HOSTNAME__
9058         - name: interface-name
9059           in: path
9060           description: Name that identifies the physical interface
9061           required: true
9062           type: string
9063           example: __INTERFACE-NAME__
9064         - name: pf-pci-id
9065           in: path
9066           description: Identifier for the sriov-pf
9067           required: true
9068           type: string
9069           example: __PF-PCI-ID__
9070   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
9071     get:
9072       tags:
9073         - CloudInfrastructure
9074       summary: returns sriov-pf
9075       description: returns sriov-pf
9076       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9077       produces:
9078         - application/json
9079         - application/xml
9080       responses:
9081         "200":
9082           description: successful operation
9083           schema:
9084               $ref: "#/getDefinitions/sriov-pf"
9085         "default":
9086           description: Response codes found in [response codes](https://wiki.onap.org/).
9087       parameters:
9088         - name: hostname
9089           in: path
9090           description: Value from executing hostname on the compute node.
9091           required: true
9092           type: string
9093           example: __HOSTNAME__
9094         - name: interface-name
9095           in: path
9096           description: Name that identifies the physical interface
9097           required: true
9098           type: string
9099           example: __INTERFACE-NAME__
9100         - name: pf-pci-id
9101           in: path
9102           description: Identifier for the sriov-pf
9103           required: true
9104           type: string
9105           example: __PF-PCI-ID__
9106     put:
9107       tags:
9108         - CloudInfrastructure
9109       summary: create or update an existing sriov-pf
9110       description: |
9111         Create or update an existing sriov-pf.
9112         #
9113         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9114       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9115       consumes:
9116         - application/json
9117         - application/xml
9118       produces:
9119         - application/json
9120         - application/xml
9121       responses:
9122         "default":
9123           description: Response codes found in [response codes](https://wiki.onap.org/).
9124       parameters:
9125         - name: hostname
9126           in: path
9127           description: Value from executing hostname on the compute node.
9128           required: true
9129           type: string
9130           example: __HOSTNAME__
9131         - name: interface-name
9132           in: path
9133           description: Name that identifies the physical interface
9134           required: true
9135           type: string
9136           example: __INTERFACE-NAME__
9137         - name: pf-pci-id
9138           in: path
9139           description: Identifier for the sriov-pf
9140           required: true
9141           type: string
9142           example: __PF-PCI-ID__
9143         - name: body
9144           in: body
9145           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
9146           required: true
9147           schema:
9148             $ref: "#/definitions/sriov-pf"
9149     patch:
9150       tags:
9151         - CloudInfrastructure
9152       summary: update an existing sriov-pf
9153       description: |
9154         Update an existing sriov-pf
9155         #
9156         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9157         The PUT operation will entirely replace an existing object.
9158         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9159         #
9160         Other differences between PUT and PATCH are:
9161         #
9162         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9163         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9164         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9165       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9166       consumes:
9167         - application/json
9168         - application/xml
9169       produces:
9170         - application/json
9171         - application/xml
9172       responses:
9173         "default":
9174           description: Response codes found in [response codes](https://wiki.onap.org/).
9175       parameters:
9176         - name: hostname
9177           in: path
9178           description: Value from executing hostname on the compute node.
9179           required: true
9180           type: string
9181           example: __HOSTNAME__
9182         - name: interface-name
9183           in: path
9184           description: Name that identifies the physical interface
9185           required: true
9186           type: string
9187           example: __INTERFACE-NAME__
9188         - name: pf-pci-id
9189           in: path
9190           description: Identifier for the sriov-pf
9191           required: true
9192           type: string
9193           example: __PF-PCI-ID__
9194         - name: body
9195           in: body
9196           description: sriov-pf object that needs to be updated.
9197           required: true
9198           schema:
9199             $ref: "#/patchDefinitions/sriov-pf"
9200     delete:
9201       tags:
9202         - CloudInfrastructure
9203       summary: delete an existing sriov-pf
9204       description: delete an existing sriov-pf
9205       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9206       consumes:
9207         - application/json
9208         - application/xml
9209       produces:
9210         - application/json
9211         - application/xml
9212       responses:
9213         "default":
9214           description: Response codes found in [response codes](https://wiki.onap.org/).
9215       parameters:
9216         - name: hostname
9217           in: path
9218           description: Value from executing hostname on the compute node.
9219           required: true
9220           type: string
9221           example: __HOSTNAME__
9222         - name: interface-name
9223           in: path
9224           description: Name that identifies the physical interface
9225           required: true
9226           type: string
9227           example: __INTERFACE-NAME__
9228         - name: pf-pci-id
9229           in: path
9230           description: Identifier for the sriov-pf
9231           required: true
9232           type: string
9233           example: __PF-PCI-ID__
9234         - name: resource-version
9235           in: query
9236           description: resource-version for concurrency
9237           required: true
9238           type: string
9239   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
9240     get:
9241       tags:
9242         - CloudInfrastructure
9243       summary: returns sriov-pfs
9244       description: returns sriov-pfs
9245       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs
9246       produces:
9247         - application/json
9248         - application/xml
9249       responses:
9250         "200":
9251           description: successful operation
9252           schema:
9253               $ref: "#/getDefinitions/sriov-pfs"
9254         "default":
9255           description: Response codes found in [response codes](https://wiki.onap.org/).
9256       parameters:
9257         - name: hostname
9258           in: path
9259           description: Value from executing hostname on the compute node.
9260           required: true
9261           type: string
9262           example: __HOSTNAME__
9263         - name: interface-name
9264           in: path
9265           description: Name that identifies the physical interface
9266           required: true
9267           type: string
9268           example: __INTERFACE-NAME__
9269         - name: pf-pci-id
9270           in: query
9271           description:
9272           required: false
9273           type: string
9274   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
9275     put:
9276       tags:
9277         - CloudInfrastructure
9278       summary: see node definition for valid relationships
9279       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9280       consumes:
9281         - application/json
9282         - application/xml
9283       produces:
9284         - application/json
9285         - application/xml
9286       responses:
9287         "default":
9288           description: Response codes found in [response codes](https://wiki.onap.org/).
9289       parameters:
9290         - name: hostname
9291           in: path
9292           description: Value from executing hostname on the compute node.
9293           required: true
9294           type: string
9295           example: __HOSTNAME__
9296         - name: interface-name
9297           in: path
9298           description: Name that identifies the physical interface
9299           required: true
9300           type: string
9301           example: __INTERFACE-NAME__
9302         - name: interface-name
9303           in: path
9304           description: Name given to the interface
9305           required: true
9306           type: string
9307           example: __INTERFACE-NAME__
9308         - name: vlan-interface
9309           in: path
9310           description: String that identifies the interface
9311           required: true
9312           type: string
9313           example: __VLAN-INTERFACE__
9314         - name: body
9315           in: body
9316           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
9317           required: true
9318           schema:
9319             $ref: "#/definitions/relationship"
9320     delete:
9321       tags:
9322         - CloudInfrastructure
9323       summary: delete an existing relationship
9324       description: delete an existing relationship
9325       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9326       consumes:
9327         - application/json
9328         - application/xml
9329       produces:
9330         - application/json
9331         - application/xml
9332       responses:
9333         "default":
9334           description: Response codes found in [response codes](https://wiki.onap.org/).
9335       parameters:
9336         - name: hostname
9337           in: path
9338           description: Value from executing hostname on the compute node.
9339           required: true
9340           type: string
9341           example: __HOSTNAME__
9342         - name: interface-name
9343           in: path
9344           description: Name that identifies the physical interface
9345           required: true
9346           type: string
9347           example: __INTERFACE-NAME__
9348         - name: interface-name
9349           in: path
9350           description: Name given to the interface
9351           required: true
9352           type: string
9353           example: __INTERFACE-NAME__
9354         - name: vlan-interface
9355           in: path
9356           description: String that identifies the interface
9357           required: true
9358           type: string
9359           example: __VLAN-INTERFACE__
9360   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
9361     put:
9362       tags:
9363         - CloudInfrastructure
9364       summary: see node definition for valid relationships
9365       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9366       consumes:
9367         - application/json
9368         - application/xml
9369       produces:
9370         - application/json
9371         - application/xml
9372       responses:
9373         "default":
9374           description: Response codes found in [response codes](https://wiki.onap.org/).
9375       parameters:
9376         - name: hostname
9377           in: path
9378           description: Value from executing hostname on the compute node.
9379           required: true
9380           type: string
9381           example: __HOSTNAME__
9382         - name: interface-name
9383           in: path
9384           description: Name that identifies the physical interface
9385           required: true
9386           type: string
9387           example: __INTERFACE-NAME__
9388         - name: interface-name
9389           in: path
9390           description: Name given to the interface
9391           required: true
9392           type: string
9393           example: __INTERFACE-NAME__
9394         - name: vlan-interface
9395           in: path
9396           description: String that identifies the interface
9397           required: true
9398           type: string
9399           example: __VLAN-INTERFACE__
9400         - name: l3-interface-ipv4-address
9401           in: path
9402           description: IP address
9403           required: true
9404           type: string
9405           example: __L3-INTERFACE-IPV4-ADDRESS__
9406         - name: body
9407           in: body
9408           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9409           required: true
9410           schema:
9411             $ref: "#/definitions/relationship"
9412     delete:
9413       tags:
9414         - CloudInfrastructure
9415       summary: delete an existing relationship
9416       description: delete an existing relationship
9417       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9418       consumes:
9419         - application/json
9420         - application/xml
9421       produces:
9422         - application/json
9423         - application/xml
9424       responses:
9425         "default":
9426           description: Response codes found in [response codes](https://wiki.onap.org/).
9427       parameters:
9428         - name: hostname
9429           in: path
9430           description: Value from executing hostname on the compute node.
9431           required: true
9432           type: string
9433           example: __HOSTNAME__
9434         - name: interface-name
9435           in: path
9436           description: Name that identifies the physical interface
9437           required: true
9438           type: string
9439           example: __INTERFACE-NAME__
9440         - name: interface-name
9441           in: path
9442           description: Name given to the interface
9443           required: true
9444           type: string
9445           example: __INTERFACE-NAME__
9446         - name: vlan-interface
9447           in: path
9448           description: String that identifies the interface
9449           required: true
9450           type: string
9451           example: __VLAN-INTERFACE__
9452         - name: l3-interface-ipv4-address
9453           in: path
9454           description: IP address
9455           required: true
9456           type: string
9457           example: __L3-INTERFACE-IPV4-ADDRESS__
9458   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
9459     get:
9460       tags:
9461         - CloudInfrastructure
9462       summary: returns l3-interface-ipv4-address-list
9463       description: returns l3-interface-ipv4-address-list
9464       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9465       produces:
9466         - application/json
9467         - application/xml
9468       responses:
9469         "200":
9470           description: successful operation
9471           schema:
9472               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9473         "default":
9474           description: Response codes found in [response codes](https://wiki.onap.org/).
9475       parameters:
9476         - name: hostname
9477           in: path
9478           description: Value from executing hostname on the compute node.
9479           required: true
9480           type: string
9481           example: __HOSTNAME__
9482         - name: interface-name
9483           in: path
9484           description: Name that identifies the physical interface
9485           required: true
9486           type: string
9487           example: __INTERFACE-NAME__
9488         - name: interface-name
9489           in: path
9490           description: Name given to the interface
9491           required: true
9492           type: string
9493           example: __INTERFACE-NAME__
9494         - name: vlan-interface
9495           in: path
9496           description: String that identifies the interface
9497           required: true
9498           type: string
9499           example: __VLAN-INTERFACE__
9500         - name: l3-interface-ipv4-address
9501           in: path
9502           description: IP address
9503           required: true
9504           type: string
9505           example: __L3-INTERFACE-IPV4-ADDRESS__
9506     put:
9507       tags:
9508         - CloudInfrastructure
9509       summary: create or update an existing l3-interface-ipv4-address-list
9510       description: |
9511         Create or update an existing l3-interface-ipv4-address-list.
9512         #
9513         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9514       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9515       consumes:
9516         - application/json
9517         - application/xml
9518       produces:
9519         - application/json
9520         - application/xml
9521       responses:
9522         "default":
9523           description: Response codes found in [response codes](https://wiki.onap.org/).
9524       parameters:
9525         - name: hostname
9526           in: path
9527           description: Value from executing hostname on the compute node.
9528           required: true
9529           type: string
9530           example: __HOSTNAME__
9531         - name: interface-name
9532           in: path
9533           description: Name that identifies the physical interface
9534           required: true
9535           type: string
9536           example: __INTERFACE-NAME__
9537         - name: interface-name
9538           in: path
9539           description: Name given to the interface
9540           required: true
9541           type: string
9542           example: __INTERFACE-NAME__
9543         - name: vlan-interface
9544           in: path
9545           description: String that identifies the interface
9546           required: true
9547           type: string
9548           example: __VLAN-INTERFACE__
9549         - name: l3-interface-ipv4-address
9550           in: path
9551           description: IP address
9552           required: true
9553           type: string
9554           example: __L3-INTERFACE-IPV4-ADDRESS__
9555         - name: body
9556           in: body
9557           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9558           required: true
9559           schema:
9560             $ref: "#/definitions/l3-interface-ipv4-address-list"
9561     patch:
9562       tags:
9563         - CloudInfrastructure
9564       summary: update an existing l3-interface-ipv4-address-list
9565       description: |
9566         Update an existing l3-interface-ipv4-address-list
9567         #
9568         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9569         The PUT operation will entirely replace an existing object.
9570         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9571         #
9572         Other differences between PUT and PATCH are:
9573         #
9574         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9575         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9576         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9577       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9578       consumes:
9579         - application/json
9580         - application/xml
9581       produces:
9582         - application/json
9583         - application/xml
9584       responses:
9585         "default":
9586           description: Response codes found in [response codes](https://wiki.onap.org/).
9587       parameters:
9588         - name: hostname
9589           in: path
9590           description: Value from executing hostname on the compute node.
9591           required: true
9592           type: string
9593           example: __HOSTNAME__
9594         - name: interface-name
9595           in: path
9596           description: Name that identifies the physical interface
9597           required: true
9598           type: string
9599           example: __INTERFACE-NAME__
9600         - name: interface-name
9601           in: path
9602           description: Name given to the interface
9603           required: true
9604           type: string
9605           example: __INTERFACE-NAME__
9606         - name: vlan-interface
9607           in: path
9608           description: String that identifies the interface
9609           required: true
9610           type: string
9611           example: __VLAN-INTERFACE__
9612         - name: l3-interface-ipv4-address
9613           in: path
9614           description: IP address
9615           required: true
9616           type: string
9617           example: __L3-INTERFACE-IPV4-ADDRESS__
9618         - name: body
9619           in: body
9620           description: l3-interface-ipv4-address-list object that needs to be updated.
9621           required: true
9622           schema:
9623             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
9624     delete:
9625       tags:
9626         - CloudInfrastructure
9627       summary: delete an existing l3-interface-ipv4-address-list
9628       description: delete an existing l3-interface-ipv4-address-list
9629       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9630       consumes:
9631         - application/json
9632         - application/xml
9633       produces:
9634         - application/json
9635         - application/xml
9636       responses:
9637         "default":
9638           description: Response codes found in [response codes](https://wiki.onap.org/).
9639       parameters:
9640         - name: hostname
9641           in: path
9642           description: Value from executing hostname on the compute node.
9643           required: true
9644           type: string
9645           example: __HOSTNAME__
9646         - name: interface-name
9647           in: path
9648           description: Name that identifies the physical interface
9649           required: true
9650           type: string
9651           example: __INTERFACE-NAME__
9652         - name: interface-name
9653           in: path
9654           description: Name given to the interface
9655           required: true
9656           type: string
9657           example: __INTERFACE-NAME__
9658         - name: vlan-interface
9659           in: path
9660           description: String that identifies the interface
9661           required: true
9662           type: string
9663           example: __VLAN-INTERFACE__
9664         - name: l3-interface-ipv4-address
9665           in: path
9666           description: IP address
9667           required: true
9668           type: string
9669           example: __L3-INTERFACE-IPV4-ADDRESS__
9670         - name: resource-version
9671           in: query
9672           description: resource-version for concurrency
9673           required: true
9674           type: string
9675   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
9676     put:
9677       tags:
9678         - CloudInfrastructure
9679       summary: see node definition for valid relationships
9680       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
9681       consumes:
9682         - application/json
9683         - application/xml
9684       produces:
9685         - application/json
9686         - application/xml
9687       responses:
9688         "default":
9689           description: Response codes found in [response codes](https://wiki.onap.org/).
9690       parameters:
9691         - name: hostname
9692           in: path
9693           description: Value from executing hostname on the compute node.
9694           required: true
9695           type: string
9696           example: __HOSTNAME__
9697         - name: interface-name
9698           in: path
9699           description: Name that identifies the physical interface
9700           required: true
9701           type: string
9702           example: __INTERFACE-NAME__
9703         - name: interface-name
9704           in: path
9705           description: Name given to the interface
9706           required: true
9707           type: string
9708           example: __INTERFACE-NAME__
9709         - name: vlan-interface
9710           in: path
9711           description: String that identifies the interface
9712           required: true
9713           type: string
9714           example: __VLAN-INTERFACE__
9715         - name: l3-interface-ipv6-address
9716           in: path
9717           description: IP address
9718           required: true
9719           type: string
9720           example: __L3-INTERFACE-IPV6-ADDRESS__
9721         - name: body
9722           in: body
9723           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
9724           required: true
9725           schema:
9726             $ref: "#/definitions/relationship"
9727     delete:
9728       tags:
9729         - CloudInfrastructure
9730       summary: delete an existing relationship
9731       description: delete an existing relationship
9732       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
9733       consumes:
9734         - application/json
9735         - application/xml
9736       produces:
9737         - application/json
9738         - application/xml
9739       responses:
9740         "default":
9741           description: Response codes found in [response codes](https://wiki.onap.org/).
9742       parameters:
9743         - name: hostname
9744           in: path
9745           description: Value from executing hostname on the compute node.
9746           required: true
9747           type: string
9748           example: __HOSTNAME__
9749         - name: interface-name
9750           in: path
9751           description: Name that identifies the physical interface
9752           required: true
9753           type: string
9754           example: __INTERFACE-NAME__
9755         - name: interface-name
9756           in: path
9757           description: Name given to the interface
9758           required: true
9759           type: string
9760           example: __INTERFACE-NAME__
9761         - name: vlan-interface
9762           in: path
9763           description: String that identifies the interface
9764           required: true
9765           type: string
9766           example: __VLAN-INTERFACE__
9767         - name: l3-interface-ipv6-address
9768           in: path
9769           description: IP address
9770           required: true
9771           type: string
9772           example: __L3-INTERFACE-IPV6-ADDRESS__
9773   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
9774     get:
9775       tags:
9776         - CloudInfrastructure
9777       summary: returns l3-interface-ipv6-address-list
9778       description: returns l3-interface-ipv6-address-list
9779       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
9780       produces:
9781         - application/json
9782         - application/xml
9783       responses:
9784         "200":
9785           description: successful operation
9786           schema:
9787               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
9788         "default":
9789           description: Response codes found in [response codes](https://wiki.onap.org/).
9790       parameters:
9791         - name: hostname
9792           in: path
9793           description: Value from executing hostname on the compute node.
9794           required: true
9795           type: string
9796           example: __HOSTNAME__
9797         - name: interface-name
9798           in: path
9799           description: Name that identifies the physical interface
9800           required: true
9801           type: string
9802           example: __INTERFACE-NAME__
9803         - name: interface-name
9804           in: path
9805           description: Name given to the interface
9806           required: true
9807           type: string
9808           example: __INTERFACE-NAME__
9809         - name: vlan-interface
9810           in: path
9811           description: String that identifies the interface
9812           required: true
9813           type: string
9814           example: __VLAN-INTERFACE__
9815         - name: l3-interface-ipv6-address
9816           in: path
9817           description: IP address
9818           required: true
9819           type: string
9820           example: __L3-INTERFACE-IPV6-ADDRESS__
9821     put:
9822       tags:
9823         - CloudInfrastructure
9824       summary: create or update an existing l3-interface-ipv6-address-list
9825       description: |
9826         Create or update an existing l3-interface-ipv6-address-list.
9827         #
9828         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9829       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
9830       consumes:
9831         - application/json
9832         - application/xml
9833       produces:
9834         - application/json
9835         - application/xml
9836       responses:
9837         "default":
9838           description: Response codes found in [response codes](https://wiki.onap.org/).
9839       parameters:
9840         - name: hostname
9841           in: path
9842           description: Value from executing hostname on the compute node.
9843           required: true
9844           type: string
9845           example: __HOSTNAME__
9846         - name: interface-name
9847           in: path
9848           description: Name that identifies the physical interface
9849           required: true
9850           type: string
9851           example: __INTERFACE-NAME__
9852         - name: interface-name
9853           in: path
9854           description: Name given to the interface
9855           required: true
9856           type: string
9857           example: __INTERFACE-NAME__
9858         - name: vlan-interface
9859           in: path
9860           description: String that identifies the interface
9861           required: true
9862           type: string
9863           example: __VLAN-INTERFACE__
9864         - name: l3-interface-ipv6-address
9865           in: path
9866           description: IP address
9867           required: true
9868           type: string
9869           example: __L3-INTERFACE-IPV6-ADDRESS__
9870         - name: body
9871           in: body
9872           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
9873           required: true
9874           schema:
9875             $ref: "#/definitions/l3-interface-ipv6-address-list"
9876     patch:
9877       tags:
9878         - CloudInfrastructure
9879       summary: update an existing l3-interface-ipv6-address-list
9880       description: |
9881         Update an existing l3-interface-ipv6-address-list
9882         #
9883         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9884         The PUT operation will entirely replace an existing object.
9885         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9886         #
9887         Other differences between PUT and PATCH are:
9888         #
9889         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9890         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9891         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9892       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
9893       consumes:
9894         - application/json
9895         - application/xml
9896       produces:
9897         - application/json
9898         - application/xml
9899       responses:
9900         "default":
9901           description: Response codes found in [response codes](https://wiki.onap.org/).
9902       parameters:
9903         - name: hostname
9904           in: path
9905           description: Value from executing hostname on the compute node.
9906           required: true
9907           type: string
9908           example: __HOSTNAME__
9909         - name: interface-name
9910           in: path
9911           description: Name that identifies the physical interface
9912           required: true
9913           type: string
9914           example: __INTERFACE-NAME__
9915         - name: interface-name
9916           in: path
9917           description: Name given to the interface
9918           required: true
9919           type: string
9920           example: __INTERFACE-NAME__
9921         - name: vlan-interface
9922           in: path
9923           description: String that identifies the interface
9924           required: true
9925           type: string
9926           example: __VLAN-INTERFACE__
9927         - name: l3-interface-ipv6-address
9928           in: path
9929           description: IP address
9930           required: true
9931           type: string
9932           example: __L3-INTERFACE-IPV6-ADDRESS__
9933         - name: body
9934           in: body
9935           description: l3-interface-ipv6-address-list object that needs to be updated.
9936           required: true
9937           schema:
9938             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
9939     delete:
9940       tags:
9941         - CloudInfrastructure
9942       summary: delete an existing l3-interface-ipv6-address-list
9943       description: delete an existing l3-interface-ipv6-address-list
9944       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
9945       consumes:
9946         - application/json
9947         - application/xml
9948       produces:
9949         - application/json
9950         - application/xml
9951       responses:
9952         "default":
9953           description: Response codes found in [response codes](https://wiki.onap.org/).
9954       parameters:
9955         - name: hostname
9956           in: path
9957           description: Value from executing hostname on the compute node.
9958           required: true
9959           type: string
9960           example: __HOSTNAME__
9961         - name: interface-name
9962           in: path
9963           description: Name that identifies the physical interface
9964           required: true
9965           type: string
9966           example: __INTERFACE-NAME__
9967         - name: interface-name
9968           in: path
9969           description: Name given to the interface
9970           required: true
9971           type: string
9972           example: __INTERFACE-NAME__
9973         - name: vlan-interface
9974           in: path
9975           description: String that identifies the interface
9976           required: true
9977           type: string
9978           example: __VLAN-INTERFACE__
9979         - name: l3-interface-ipv6-address
9980           in: path
9981           description: IP address
9982           required: true
9983           type: string
9984           example: __L3-INTERFACE-IPV6-ADDRESS__
9985         - name: resource-version
9986           in: query
9987           description: resource-version for concurrency
9988           required: true
9989           type: string
9990   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
9991     get:
9992       tags:
9993         - CloudInfrastructure
9994       summary: returns vlan
9995       description: returns vlan
9996       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9997       produces:
9998         - application/json
9999         - application/xml
10000       responses:
10001         "200":
10002           description: successful operation
10003           schema:
10004               $ref: "#/getDefinitions/vlan"
10005         "default":
10006           description: Response codes found in [response codes](https://wiki.onap.org/).
10007       parameters:
10008         - name: hostname
10009           in: path
10010           description: Value from executing hostname on the compute node.
10011           required: true
10012           type: string
10013           example: __HOSTNAME__
10014         - name: interface-name
10015           in: path
10016           description: Name that identifies the physical interface
10017           required: true
10018           type: string
10019           example: __INTERFACE-NAME__
10020         - name: interface-name
10021           in: path
10022           description: Name given to the interface
10023           required: true
10024           type: string
10025           example: __INTERFACE-NAME__
10026         - name: vlan-interface
10027           in: path
10028           description: String that identifies the interface
10029           required: true
10030           type: string
10031           example: __VLAN-INTERFACE__
10032     put:
10033       tags:
10034         - CloudInfrastructure
10035       summary: create or update an existing vlan
10036       description: |
10037         Create or update an existing vlan.
10038         #
10039         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10040       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10041       consumes:
10042         - application/json
10043         - application/xml
10044       produces:
10045         - application/json
10046         - application/xml
10047       responses:
10048         "default":
10049           description: Response codes found in [response codes](https://wiki.onap.org/).
10050       parameters:
10051         - name: hostname
10052           in: path
10053           description: Value from executing hostname on the compute node.
10054           required: true
10055           type: string
10056           example: __HOSTNAME__
10057         - name: interface-name
10058           in: path
10059           description: Name that identifies the physical interface
10060           required: true
10061           type: string
10062           example: __INTERFACE-NAME__
10063         - name: interface-name
10064           in: path
10065           description: Name given to the interface
10066           required: true
10067           type: string
10068           example: __INTERFACE-NAME__
10069         - name: vlan-interface
10070           in: path
10071           description: String that identifies the interface
10072           required: true
10073           type: string
10074           example: __VLAN-INTERFACE__
10075         - name: body
10076           in: body
10077           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
10078           required: true
10079           schema:
10080             $ref: "#/definitions/vlan"
10081     patch:
10082       tags:
10083         - CloudInfrastructure
10084       summary: update an existing vlan
10085       description: |
10086         Update an existing vlan
10087         #
10088         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10089         The PUT operation will entirely replace an existing object.
10090         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10091         #
10092         Other differences between PUT and PATCH are:
10093         #
10094         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10095         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10096         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10097       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10098       consumes:
10099         - application/json
10100         - application/xml
10101       produces:
10102         - application/json
10103         - application/xml
10104       responses:
10105         "default":
10106           description: Response codes found in [response codes](https://wiki.onap.org/).
10107       parameters:
10108         - name: hostname
10109           in: path
10110           description: Value from executing hostname on the compute node.
10111           required: true
10112           type: string
10113           example: __HOSTNAME__
10114         - name: interface-name
10115           in: path
10116           description: Name that identifies the physical interface
10117           required: true
10118           type: string
10119           example: __INTERFACE-NAME__
10120         - name: interface-name
10121           in: path
10122           description: Name given to the interface
10123           required: true
10124           type: string
10125           example: __INTERFACE-NAME__
10126         - name: vlan-interface
10127           in: path
10128           description: String that identifies the interface
10129           required: true
10130           type: string
10131           example: __VLAN-INTERFACE__
10132         - name: body
10133           in: body
10134           description: vlan object that needs to be updated.
10135           required: true
10136           schema:
10137             $ref: "#/patchDefinitions/vlan"
10138     delete:
10139       tags:
10140         - CloudInfrastructure
10141       summary: delete an existing vlan
10142       description: delete an existing vlan
10143       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10144       consumes:
10145         - application/json
10146         - application/xml
10147       produces:
10148         - application/json
10149         - application/xml
10150       responses:
10151         "default":
10152           description: Response codes found in [response codes](https://wiki.onap.org/).
10153       parameters:
10154         - name: hostname
10155           in: path
10156           description: Value from executing hostname on the compute node.
10157           required: true
10158           type: string
10159           example: __HOSTNAME__
10160         - name: interface-name
10161           in: path
10162           description: Name that identifies the physical interface
10163           required: true
10164           type: string
10165           example: __INTERFACE-NAME__
10166         - name: interface-name
10167           in: path
10168           description: Name given to the interface
10169           required: true
10170           type: string
10171           example: __INTERFACE-NAME__
10172         - name: vlan-interface
10173           in: path
10174           description: String that identifies the interface
10175           required: true
10176           type: string
10177           example: __VLAN-INTERFACE__
10178         - name: resource-version
10179           in: query
10180           description: resource-version for concurrency
10181           required: true
10182           type: string
10183   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
10184     get:
10185       tags:
10186         - CloudInfrastructure
10187       summary: returns vlans
10188       description: returns vlans
10189       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
10190       produces:
10191         - application/json
10192         - application/xml
10193       responses:
10194         "200":
10195           description: successful operation
10196           schema:
10197               $ref: "#/getDefinitions/vlans"
10198         "default":
10199           description: Response codes found in [response codes](https://wiki.onap.org/).
10200       parameters:
10201         - name: hostname
10202           in: path
10203           description: Value from executing hostname on the compute node.
10204           required: true
10205           type: string
10206           example: __HOSTNAME__
10207         - name: interface-name
10208           in: path
10209           description: Name that identifies the physical interface
10210           required: true
10211           type: string
10212           example: __INTERFACE-NAME__
10213         - name: interface-name
10214           in: path
10215           description: Name given to the interface
10216           required: true
10217           type: string
10218           example: __INTERFACE-NAME__
10219         - name: vlan-interface
10220           in: query
10221           description:
10222           required: false
10223           type: string
10224         - name: vlan-id-inner
10225           in: query
10226           description:
10227           required: false
10228           type: integer
10229           format: int64
10230         - name: vpn-key
10231           in: query
10232           description:
10233           required: false
10234           type: string
10235   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
10236     put:
10237       tags:
10238         - CloudInfrastructure
10239       summary: see node definition for valid relationships
10240       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10241       consumes:
10242         - application/json
10243         - application/xml
10244       produces:
10245         - application/json
10246         - application/xml
10247       responses:
10248         "default":
10249           description: Response codes found in [response codes](https://wiki.onap.org/).
10250       parameters:
10251         - name: hostname
10252           in: path
10253           description: Value from executing hostname on the compute node.
10254           required: true
10255           type: string
10256           example: __HOSTNAME__
10257         - name: interface-name
10258           in: path
10259           description: Name that identifies the physical interface
10260           required: true
10261           type: string
10262           example: __INTERFACE-NAME__
10263         - name: interface-name
10264           in: path
10265           description: Name given to the interface
10266           required: true
10267           type: string
10268           example: __INTERFACE-NAME__
10269         - name: pci-id
10270           in: path
10271           description: PCI ID used to identify the sriov-vf
10272           required: true
10273           type: string
10274           example: __PCI-ID__
10275         - name: body
10276           in: body
10277           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10278           required: true
10279           schema:
10280             $ref: "#/definitions/relationship"
10281     delete:
10282       tags:
10283         - CloudInfrastructure
10284       summary: delete an existing relationship
10285       description: delete an existing relationship
10286       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10287       consumes:
10288         - application/json
10289         - application/xml
10290       produces:
10291         - application/json
10292         - application/xml
10293       responses:
10294         "default":
10295           description: Response codes found in [response codes](https://wiki.onap.org/).
10296       parameters:
10297         - name: hostname
10298           in: path
10299           description: Value from executing hostname on the compute node.
10300           required: true
10301           type: string
10302           example: __HOSTNAME__
10303         - name: interface-name
10304           in: path
10305           description: Name that identifies the physical interface
10306           required: true
10307           type: string
10308           example: __INTERFACE-NAME__
10309         - name: interface-name
10310           in: path
10311           description: Name given to the interface
10312           required: true
10313           type: string
10314           example: __INTERFACE-NAME__
10315         - name: pci-id
10316           in: path
10317           description: PCI ID used to identify the sriov-vf
10318           required: true
10319           type: string
10320           example: __PCI-ID__
10321   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
10322     get:
10323       tags:
10324         - CloudInfrastructure
10325       summary: returns sriov-vf
10326       description: returns sriov-vf
10327       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10328       produces:
10329         - application/json
10330         - application/xml
10331       responses:
10332         "200":
10333           description: successful operation
10334           schema:
10335               $ref: "#/getDefinitions/sriov-vf"
10336         "default":
10337           description: Response codes found in [response codes](https://wiki.onap.org/).
10338       parameters:
10339         - name: hostname
10340           in: path
10341           description: Value from executing hostname on the compute node.
10342           required: true
10343           type: string
10344           example: __HOSTNAME__
10345         - name: interface-name
10346           in: path
10347           description: Name that identifies the physical interface
10348           required: true
10349           type: string
10350           example: __INTERFACE-NAME__
10351         - name: interface-name
10352           in: path
10353           description: Name given to the interface
10354           required: true
10355           type: string
10356           example: __INTERFACE-NAME__
10357         - name: pci-id
10358           in: path
10359           description: PCI ID used to identify the sriov-vf
10360           required: true
10361           type: string
10362           example: __PCI-ID__
10363     put:
10364       tags:
10365         - CloudInfrastructure
10366       summary: create or update an existing sriov-vf
10367       description: |
10368         Create or update an existing sriov-vf.
10369         #
10370         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10371       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10372       consumes:
10373         - application/json
10374         - application/xml
10375       produces:
10376         - application/json
10377         - application/xml
10378       responses:
10379         "default":
10380           description: Response codes found in [response codes](https://wiki.onap.org/).
10381       parameters:
10382         - name: hostname
10383           in: path
10384           description: Value from executing hostname on the compute node.
10385           required: true
10386           type: string
10387           example: __HOSTNAME__
10388         - name: interface-name
10389           in: path
10390           description: Name that identifies the physical interface
10391           required: true
10392           type: string
10393           example: __INTERFACE-NAME__
10394         - name: interface-name
10395           in: path
10396           description: Name given to the interface
10397           required: true
10398           type: string
10399           example: __INTERFACE-NAME__
10400         - name: pci-id
10401           in: path
10402           description: PCI ID used to identify the sriov-vf
10403           required: true
10404           type: string
10405           example: __PCI-ID__
10406         - name: body
10407           in: body
10408           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10409           required: true
10410           schema:
10411             $ref: "#/definitions/sriov-vf"
10412     patch:
10413       tags:
10414         - CloudInfrastructure
10415       summary: update an existing sriov-vf
10416       description: |
10417         Update an existing sriov-vf
10418         #
10419         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10420         The PUT operation will entirely replace an existing object.
10421         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10422         #
10423         Other differences between PUT and PATCH are:
10424         #
10425         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10426         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10427         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10428       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10429       consumes:
10430         - application/json
10431         - application/xml
10432       produces:
10433         - application/json
10434         - application/xml
10435       responses:
10436         "default":
10437           description: Response codes found in [response codes](https://wiki.onap.org/).
10438       parameters:
10439         - name: hostname
10440           in: path
10441           description: Value from executing hostname on the compute node.
10442           required: true
10443           type: string
10444           example: __HOSTNAME__
10445         - name: interface-name
10446           in: path
10447           description: Name that identifies the physical interface
10448           required: true
10449           type: string
10450           example: __INTERFACE-NAME__
10451         - name: interface-name
10452           in: path
10453           description: Name given to the interface
10454           required: true
10455           type: string
10456           example: __INTERFACE-NAME__
10457         - name: pci-id
10458           in: path
10459           description: PCI ID used to identify the sriov-vf
10460           required: true
10461           type: string
10462           example: __PCI-ID__
10463         - name: body
10464           in: body
10465           description: sriov-vf object that needs to be updated.
10466           required: true
10467           schema:
10468             $ref: "#/patchDefinitions/sriov-vf"
10469     delete:
10470       tags:
10471         - CloudInfrastructure
10472       summary: delete an existing sriov-vf
10473       description: delete an existing sriov-vf
10474       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10475       consumes:
10476         - application/json
10477         - application/xml
10478       produces:
10479         - application/json
10480         - application/xml
10481       responses:
10482         "default":
10483           description: Response codes found in [response codes](https://wiki.onap.org/).
10484       parameters:
10485         - name: hostname
10486           in: path
10487           description: Value from executing hostname on the compute node.
10488           required: true
10489           type: string
10490           example: __HOSTNAME__
10491         - name: interface-name
10492           in: path
10493           description: Name that identifies the physical interface
10494           required: true
10495           type: string
10496           example: __INTERFACE-NAME__
10497         - name: interface-name
10498           in: path
10499           description: Name given to the interface
10500           required: true
10501           type: string
10502           example: __INTERFACE-NAME__
10503         - name: pci-id
10504           in: path
10505           description: PCI ID used to identify the sriov-vf
10506           required: true
10507           type: string
10508           example: __PCI-ID__
10509         - name: resource-version
10510           in: query
10511           description: resource-version for concurrency
10512           required: true
10513           type: string
10514   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
10515     get:
10516       tags:
10517         - CloudInfrastructure
10518       summary: returns sriov-vfs
10519       description: returns sriov-vfs
10520       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
10521       produces:
10522         - application/json
10523         - application/xml
10524       responses:
10525         "200":
10526           description: successful operation
10527           schema:
10528               $ref: "#/getDefinitions/sriov-vfs"
10529         "default":
10530           description: Response codes found in [response codes](https://wiki.onap.org/).
10531       parameters:
10532         - name: hostname
10533           in: path
10534           description: Value from executing hostname on the compute node.
10535           required: true
10536           type: string
10537           example: __HOSTNAME__
10538         - name: interface-name
10539           in: path
10540           description: Name that identifies the physical interface
10541           required: true
10542           type: string
10543           example: __INTERFACE-NAME__
10544         - name: interface-name
10545           in: path
10546           description: Name given to the interface
10547           required: true
10548           type: string
10549           example: __INTERFACE-NAME__
10550         - name: pci-id
10551           in: query
10552           description:
10553           required: false
10554           type: string
10555         - name: vf-vlan-filter
10556           in: query
10557           description:
10558           required: false
10559           type: string
10560         - name: vf-mac-filter
10561           in: query
10562           description:
10563           required: false
10564           type: string
10565         - name: vf-vlan-strip
10566           in: query
10567           description:
10568           required: false
10569           type: boolean
10570         - name: neutron-network-id
10571           in: query
10572           description:
10573           required: false
10574           type: string
10575   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
10576     put:
10577       tags:
10578         - CloudInfrastructure
10579       summary: see node definition for valid relationships
10580       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
10581       consumes:
10582         - application/json
10583         - application/xml
10584       produces:
10585         - application/json
10586         - application/xml
10587       responses:
10588         "default":
10589           description: Response codes found in [response codes](https://wiki.onap.org/).
10590       parameters:
10591         - name: hostname
10592           in: path
10593           description: Value from executing hostname on the compute node.
10594           required: true
10595           type: string
10596           example: __HOSTNAME__
10597         - name: interface-name
10598           in: path
10599           description: Name that identifies the physical interface
10600           required: true
10601           type: string
10602           example: __INTERFACE-NAME__
10603         - name: interface-name
10604           in: path
10605           description: Name given to the interface
10606           required: true
10607           type: string
10608           example: __INTERFACE-NAME__
10609         - name: body
10610           in: body
10611           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
10612           required: true
10613           schema:
10614             $ref: "#/definitions/relationship"
10615     delete:
10616       tags:
10617         - CloudInfrastructure
10618       summary: delete an existing relationship
10619       description: delete an existing relationship
10620       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
10621       consumes:
10622         - application/json
10623         - application/xml
10624       produces:
10625         - application/json
10626         - application/xml
10627       responses:
10628         "default":
10629           description: Response codes found in [response codes](https://wiki.onap.org/).
10630       parameters:
10631         - name: hostname
10632           in: path
10633           description: Value from executing hostname on the compute node.
10634           required: true
10635           type: string
10636           example: __HOSTNAME__
10637         - name: interface-name
10638           in: path
10639           description: Name that identifies the physical interface
10640           required: true
10641           type: string
10642           example: __INTERFACE-NAME__
10643         - name: interface-name
10644           in: path
10645           description: Name given to the interface
10646           required: true
10647           type: string
10648           example: __INTERFACE-NAME__
10649   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
10650     put:
10651       tags:
10652         - CloudInfrastructure
10653       summary: see node definition for valid relationships
10654       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
10655       consumes:
10656         - application/json
10657         - application/xml
10658       produces:
10659         - application/json
10660         - application/xml
10661       responses:
10662         "default":
10663           description: Response codes found in [response codes](https://wiki.onap.org/).
10664       parameters:
10665         - name: hostname
10666           in: path
10667           description: Value from executing hostname on the compute node.
10668           required: true
10669           type: string
10670           example: __HOSTNAME__
10671         - name: interface-name
10672           in: path
10673           description: Name that identifies the physical interface
10674           required: true
10675           type: string
10676           example: __INTERFACE-NAME__
10677         - name: interface-name
10678           in: path
10679           description: Name given to the interface
10680           required: true
10681           type: string
10682           example: __INTERFACE-NAME__
10683         - name: l3-interface-ipv4-address
10684           in: path
10685           description: IP address
10686           required: true
10687           type: string
10688           example: __L3-INTERFACE-IPV4-ADDRESS__
10689         - name: body
10690           in: body
10691           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
10692           required: true
10693           schema:
10694             $ref: "#/definitions/relationship"
10695     delete:
10696       tags:
10697         - CloudInfrastructure
10698       summary: delete an existing relationship
10699       description: delete an existing relationship
10700       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
10701       consumes:
10702         - application/json
10703         - application/xml
10704       produces:
10705         - application/json
10706         - application/xml
10707       responses:
10708         "default":
10709           description: Response codes found in [response codes](https://wiki.onap.org/).
10710       parameters:
10711         - name: hostname
10712           in: path
10713           description: Value from executing hostname on the compute node.
10714           required: true
10715           type: string
10716           example: __HOSTNAME__
10717         - name: interface-name
10718           in: path
10719           description: Name that identifies the physical interface
10720           required: true
10721           type: string
10722           example: __INTERFACE-NAME__
10723         - name: interface-name
10724           in: path
10725           description: Name given to the interface
10726           required: true
10727           type: string
10728           example: __INTERFACE-NAME__
10729         - name: l3-interface-ipv4-address
10730           in: path
10731           description: IP address
10732           required: true
10733           type: string
10734           example: __L3-INTERFACE-IPV4-ADDRESS__
10735   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
10736     get:
10737       tags:
10738         - CloudInfrastructure
10739       summary: returns l3-interface-ipv4-address-list
10740       description: returns l3-interface-ipv4-address-list
10741       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10742       produces:
10743         - application/json
10744         - application/xml
10745       responses:
10746         "200":
10747           description: successful operation
10748           schema:
10749               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
10750         "default":
10751           description: Response codes found in [response codes](https://wiki.onap.org/).
10752       parameters:
10753         - name: hostname
10754           in: path
10755           description: Value from executing hostname on the compute node.
10756           required: true
10757           type: string
10758           example: __HOSTNAME__
10759         - name: interface-name
10760           in: path
10761           description: Name that identifies the physical interface
10762           required: true
10763           type: string
10764           example: __INTERFACE-NAME__
10765         - name: interface-name
10766           in: path
10767           description: Name given to the interface
10768           required: true
10769           type: string
10770           example: __INTERFACE-NAME__
10771         - name: l3-interface-ipv4-address
10772           in: path
10773           description: IP address
10774           required: true
10775           type: string
10776           example: __L3-INTERFACE-IPV4-ADDRESS__
10777     put:
10778       tags:
10779         - CloudInfrastructure
10780       summary: create or update an existing l3-interface-ipv4-address-list
10781       description: |
10782         Create or update an existing l3-interface-ipv4-address-list.
10783         #
10784         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10785       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10786       consumes:
10787         - application/json
10788         - application/xml
10789       produces:
10790         - application/json
10791         - application/xml
10792       responses:
10793         "default":
10794           description: Response codes found in [response codes](https://wiki.onap.org/).
10795       parameters:
10796         - name: hostname
10797           in: path
10798           description: Value from executing hostname on the compute node.
10799           required: true
10800           type: string
10801           example: __HOSTNAME__
10802         - name: interface-name
10803           in: path
10804           description: Name that identifies the physical interface
10805           required: true
10806           type: string
10807           example: __INTERFACE-NAME__
10808         - name: interface-name
10809           in: path
10810           description: Name given to the interface
10811           required: true
10812           type: string
10813           example: __INTERFACE-NAME__
10814         - name: l3-interface-ipv4-address
10815           in: path
10816           description: IP address
10817           required: true
10818           type: string
10819           example: __L3-INTERFACE-IPV4-ADDRESS__
10820         - name: body
10821           in: body
10822           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
10823           required: true
10824           schema:
10825             $ref: "#/definitions/l3-interface-ipv4-address-list"
10826     patch:
10827       tags:
10828         - CloudInfrastructure
10829       summary: update an existing l3-interface-ipv4-address-list
10830       description: |
10831         Update an existing l3-interface-ipv4-address-list
10832         #
10833         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10834         The PUT operation will entirely replace an existing object.
10835         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10836         #
10837         Other differences between PUT and PATCH are:
10838         #
10839         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10840         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10841         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10842       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10843       consumes:
10844         - application/json
10845         - application/xml
10846       produces:
10847         - application/json
10848         - application/xml
10849       responses:
10850         "default":
10851           description: Response codes found in [response codes](https://wiki.onap.org/).
10852       parameters:
10853         - name: hostname
10854           in: path
10855           description: Value from executing hostname on the compute node.
10856           required: true
10857           type: string
10858           example: __HOSTNAME__
10859         - name: interface-name
10860           in: path
10861           description: Name that identifies the physical interface
10862           required: true
10863           type: string
10864           example: __INTERFACE-NAME__
10865         - name: interface-name
10866           in: path
10867           description: Name given to the interface
10868           required: true
10869           type: string
10870           example: __INTERFACE-NAME__
10871         - name: l3-interface-ipv4-address
10872           in: path
10873           description: IP address
10874           required: true
10875           type: string
10876           example: __L3-INTERFACE-IPV4-ADDRESS__
10877         - name: body
10878           in: body
10879           description: l3-interface-ipv4-address-list object that needs to be updated.
10880           required: true
10881           schema:
10882             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10883     delete:
10884       tags:
10885         - CloudInfrastructure
10886       summary: delete an existing l3-interface-ipv4-address-list
10887       description: delete an existing l3-interface-ipv4-address-list
10888       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10889       consumes:
10890         - application/json
10891         - application/xml
10892       produces:
10893         - application/json
10894         - application/xml
10895       responses:
10896         "default":
10897           description: Response codes found in [response codes](https://wiki.onap.org/).
10898       parameters:
10899         - name: hostname
10900           in: path
10901           description: Value from executing hostname on the compute node.
10902           required: true
10903           type: string
10904           example: __HOSTNAME__
10905         - name: interface-name
10906           in: path
10907           description: Name that identifies the physical interface
10908           required: true
10909           type: string
10910           example: __INTERFACE-NAME__
10911         - name: interface-name
10912           in: path
10913           description: Name given to the interface
10914           required: true
10915           type: string
10916           example: __INTERFACE-NAME__
10917         - name: l3-interface-ipv4-address
10918           in: path
10919           description: IP address
10920           required: true
10921           type: string
10922           example: __L3-INTERFACE-IPV4-ADDRESS__
10923         - name: resource-version
10924           in: query
10925           description: resource-version for concurrency
10926           required: true
10927           type: string
10928   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
10929     put:
10930       tags:
10931         - CloudInfrastructure
10932       summary: see node definition for valid relationships
10933       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10934       consumes:
10935         - application/json
10936         - application/xml
10937       produces:
10938         - application/json
10939         - application/xml
10940       responses:
10941         "default":
10942           description: Response codes found in [response codes](https://wiki.onap.org/).
10943       parameters:
10944         - name: hostname
10945           in: path
10946           description: Value from executing hostname on the compute node.
10947           required: true
10948           type: string
10949           example: __HOSTNAME__
10950         - name: interface-name
10951           in: path
10952           description: Name that identifies the physical interface
10953           required: true
10954           type: string
10955           example: __INTERFACE-NAME__
10956         - name: interface-name
10957           in: path
10958           description: Name given to the interface
10959           required: true
10960           type: string
10961           example: __INTERFACE-NAME__
10962         - name: l3-interface-ipv6-address
10963           in: path
10964           description: IP address
10965           required: true
10966           type: string
10967           example: __L3-INTERFACE-IPV6-ADDRESS__
10968         - name: body
10969           in: body
10970           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10971           required: true
10972           schema:
10973             $ref: "#/definitions/relationship"
10974     delete:
10975       tags:
10976         - CloudInfrastructure
10977       summary: delete an existing relationship
10978       description: delete an existing relationship
10979       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10980       consumes:
10981         - application/json
10982         - application/xml
10983       produces:
10984         - application/json
10985         - application/xml
10986       responses:
10987         "default":
10988           description: Response codes found in [response codes](https://wiki.onap.org/).
10989       parameters:
10990         - name: hostname
10991           in: path
10992           description: Value from executing hostname on the compute node.
10993           required: true
10994           type: string
10995           example: __HOSTNAME__
10996         - name: interface-name
10997           in: path
10998           description: Name that identifies the physical interface
10999           required: true
11000           type: string
11001           example: __INTERFACE-NAME__
11002         - name: interface-name
11003           in: path
11004           description: Name given to the interface
11005           required: true
11006           type: string
11007           example: __INTERFACE-NAME__
11008         - name: l3-interface-ipv6-address
11009           in: path
11010           description: IP address
11011           required: true
11012           type: string
11013           example: __L3-INTERFACE-IPV6-ADDRESS__
11014   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
11015     get:
11016       tags:
11017         - CloudInfrastructure
11018       summary: returns l3-interface-ipv6-address-list
11019       description: returns l3-interface-ipv6-address-list
11020       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11021       produces:
11022         - application/json
11023         - application/xml
11024       responses:
11025         "200":
11026           description: successful operation
11027           schema:
11028               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11029         "default":
11030           description: Response codes found in [response codes](https://wiki.onap.org/).
11031       parameters:
11032         - name: hostname
11033           in: path
11034           description: Value from executing hostname on the compute node.
11035           required: true
11036           type: string
11037           example: __HOSTNAME__
11038         - name: interface-name
11039           in: path
11040           description: Name that identifies the physical interface
11041           required: true
11042           type: string
11043           example: __INTERFACE-NAME__
11044         - name: interface-name
11045           in: path
11046           description: Name given to the interface
11047           required: true
11048           type: string
11049           example: __INTERFACE-NAME__
11050         - name: l3-interface-ipv6-address
11051           in: path
11052           description: IP address
11053           required: true
11054           type: string
11055           example: __L3-INTERFACE-IPV6-ADDRESS__
11056     put:
11057       tags:
11058         - CloudInfrastructure
11059       summary: create or update an existing l3-interface-ipv6-address-list
11060       description: |
11061         Create or update an existing l3-interface-ipv6-address-list.
11062         #
11063         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11064       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11065       consumes:
11066         - application/json
11067         - application/xml
11068       produces:
11069         - application/json
11070         - application/xml
11071       responses:
11072         "default":
11073           description: Response codes found in [response codes](https://wiki.onap.org/).
11074       parameters:
11075         - name: hostname
11076           in: path
11077           description: Value from executing hostname on the compute node.
11078           required: true
11079           type: string
11080           example: __HOSTNAME__
11081         - name: interface-name
11082           in: path
11083           description: Name that identifies the physical interface
11084           required: true
11085           type: string
11086           example: __INTERFACE-NAME__
11087         - name: interface-name
11088           in: path
11089           description: Name given to the interface
11090           required: true
11091           type: string
11092           example: __INTERFACE-NAME__
11093         - name: l3-interface-ipv6-address
11094           in: path
11095           description: IP address
11096           required: true
11097           type: string
11098           example: __L3-INTERFACE-IPV6-ADDRESS__
11099         - name: body
11100           in: body
11101           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11102           required: true
11103           schema:
11104             $ref: "#/definitions/l3-interface-ipv6-address-list"
11105     patch:
11106       tags:
11107         - CloudInfrastructure
11108       summary: update an existing l3-interface-ipv6-address-list
11109       description: |
11110         Update an existing l3-interface-ipv6-address-list
11111         #
11112         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11113         The PUT operation will entirely replace an existing object.
11114         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11115         #
11116         Other differences between PUT and PATCH are:
11117         #
11118         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11119         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11120         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11121       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11122       consumes:
11123         - application/json
11124         - application/xml
11125       produces:
11126         - application/json
11127         - application/xml
11128       responses:
11129         "default":
11130           description: Response codes found in [response codes](https://wiki.onap.org/).
11131       parameters:
11132         - name: hostname
11133           in: path
11134           description: Value from executing hostname on the compute node.
11135           required: true
11136           type: string
11137           example: __HOSTNAME__
11138         - name: interface-name
11139           in: path
11140           description: Name that identifies the physical interface
11141           required: true
11142           type: string
11143           example: __INTERFACE-NAME__
11144         - name: interface-name
11145           in: path
11146           description: Name given to the interface
11147           required: true
11148           type: string
11149           example: __INTERFACE-NAME__
11150         - name: l3-interface-ipv6-address
11151           in: path
11152           description: IP address
11153           required: true
11154           type: string
11155           example: __L3-INTERFACE-IPV6-ADDRESS__
11156         - name: body
11157           in: body
11158           description: l3-interface-ipv6-address-list object that needs to be updated.
11159           required: true
11160           schema:
11161             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11162     delete:
11163       tags:
11164         - CloudInfrastructure
11165       summary: delete an existing l3-interface-ipv6-address-list
11166       description: delete an existing l3-interface-ipv6-address-list
11167       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11168       consumes:
11169         - application/json
11170         - application/xml
11171       produces:
11172         - application/json
11173         - application/xml
11174       responses:
11175         "default":
11176           description: Response codes found in [response codes](https://wiki.onap.org/).
11177       parameters:
11178         - name: hostname
11179           in: path
11180           description: Value from executing hostname on the compute node.
11181           required: true
11182           type: string
11183           example: __HOSTNAME__
11184         - name: interface-name
11185           in: path
11186           description: Name that identifies the physical interface
11187           required: true
11188           type: string
11189           example: __INTERFACE-NAME__
11190         - name: interface-name
11191           in: path
11192           description: Name given to the interface
11193           required: true
11194           type: string
11195           example: __INTERFACE-NAME__
11196         - name: l3-interface-ipv6-address
11197           in: path
11198           description: IP address
11199           required: true
11200           type: string
11201           example: __L3-INTERFACE-IPV6-ADDRESS__
11202         - name: resource-version
11203           in: query
11204           description: resource-version for concurrency
11205           required: true
11206           type: string
11207   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
11208     get:
11209       tags:
11210         - CloudInfrastructure
11211       summary: returns l-interface
11212       description: returns l-interface
11213       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11214       produces:
11215         - application/json
11216         - application/xml
11217       responses:
11218         "200":
11219           description: successful operation
11220           schema:
11221               $ref: "#/getDefinitions/l-interface"
11222         "default":
11223           description: Response codes found in [response codes](https://wiki.onap.org/).
11224       parameters:
11225         - name: hostname
11226           in: path
11227           description: Value from executing hostname on the compute node.
11228           required: true
11229           type: string
11230           example: __HOSTNAME__
11231         - name: interface-name
11232           in: path
11233           description: Name that identifies the physical interface
11234           required: true
11235           type: string
11236           example: __INTERFACE-NAME__
11237         - name: interface-name
11238           in: path
11239           description: Name given to the interface
11240           required: true
11241           type: string
11242           example: __INTERFACE-NAME__
11243     put:
11244       tags:
11245         - CloudInfrastructure
11246       summary: create or update an existing l-interface
11247       description: |
11248         Create or update an existing l-interface.
11249         #
11250         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11251       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11252       consumes:
11253         - application/json
11254         - application/xml
11255       produces:
11256         - application/json
11257         - application/xml
11258       responses:
11259         "default":
11260           description: Response codes found in [response codes](https://wiki.onap.org/).
11261       parameters:
11262         - name: hostname
11263           in: path
11264           description: Value from executing hostname on the compute node.
11265           required: true
11266           type: string
11267           example: __HOSTNAME__
11268         - name: interface-name
11269           in: path
11270           description: Name that identifies the physical interface
11271           required: true
11272           type: string
11273           example: __INTERFACE-NAME__
11274         - name: interface-name
11275           in: path
11276           description: Name given to the interface
11277           required: true
11278           type: string
11279           example: __INTERFACE-NAME__
11280         - name: body
11281           in: body
11282           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
11283           required: true
11284           schema:
11285             $ref: "#/definitions/l-interface"
11286     patch:
11287       tags:
11288         - CloudInfrastructure
11289       summary: update an existing l-interface
11290       description: |
11291         Update an existing l-interface
11292         #
11293         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11294         The PUT operation will entirely replace an existing object.
11295         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11296         #
11297         Other differences between PUT and PATCH are:
11298         #
11299         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11300         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11301         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11302       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11303       consumes:
11304         - application/json
11305         - application/xml
11306       produces:
11307         - application/json
11308         - application/xml
11309       responses:
11310         "default":
11311           description: Response codes found in [response codes](https://wiki.onap.org/).
11312       parameters:
11313         - name: hostname
11314           in: path
11315           description: Value from executing hostname on the compute node.
11316           required: true
11317           type: string
11318           example: __HOSTNAME__
11319         - name: interface-name
11320           in: path
11321           description: Name that identifies the physical interface
11322           required: true
11323           type: string
11324           example: __INTERFACE-NAME__
11325         - name: interface-name
11326           in: path
11327           description: Name given to the interface
11328           required: true
11329           type: string
11330           example: __INTERFACE-NAME__
11331         - name: body
11332           in: body
11333           description: l-interface object that needs to be updated.
11334           required: true
11335           schema:
11336             $ref: "#/patchDefinitions/l-interface"
11337     delete:
11338       tags:
11339         - CloudInfrastructure
11340       summary: delete an existing l-interface
11341       description: delete an existing l-interface
11342       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11343       consumes:
11344         - application/json
11345         - application/xml
11346       produces:
11347         - application/json
11348         - application/xml
11349       responses:
11350         "default":
11351           description: Response codes found in [response codes](https://wiki.onap.org/).
11352       parameters:
11353         - name: hostname
11354           in: path
11355           description: Value from executing hostname on the compute node.
11356           required: true
11357           type: string
11358           example: __HOSTNAME__
11359         - name: interface-name
11360           in: path
11361           description: Name that identifies the physical interface
11362           required: true
11363           type: string
11364           example: __INTERFACE-NAME__
11365         - name: interface-name
11366           in: path
11367           description: Name given to the interface
11368           required: true
11369           type: string
11370           example: __INTERFACE-NAME__
11371         - name: resource-version
11372           in: query
11373           description: resource-version for concurrency
11374           required: true
11375           type: string
11376   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
11377     get:
11378       tags:
11379         - CloudInfrastructure
11380       summary: returns l-interfaces
11381       description: returns l-interfaces
11382       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
11383       produces:
11384         - application/json
11385         - application/xml
11386       responses:
11387         "200":
11388           description: successful operation
11389           schema:
11390               $ref: "#/getDefinitions/l-interfaces"
11391         "default":
11392           description: Response codes found in [response codes](https://wiki.onap.org/).
11393       parameters:
11394         - name: hostname
11395           in: path
11396           description: Value from executing hostname on the compute node.
11397           required: true
11398           type: string
11399           example: __HOSTNAME__
11400         - name: interface-name
11401           in: path
11402           description: Name that identifies the physical interface
11403           required: true
11404           type: string
11405           example: __INTERFACE-NAME__
11406         - name: interface-name
11407           in: query
11408           description:
11409           required: false
11410           type: string
11411         - name: interface-id
11412           in: query
11413           description:
11414           required: false
11415           type: string
11416         - name: macaddr
11417           in: query
11418           description:
11419           required: false
11420           type: string
11421         - name: network-name
11422           in: query
11423           description:
11424           required: false
11425           type: string
11426   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
11427     get:
11428       tags:
11429         - CloudInfrastructure
11430       summary: returns p-interface
11431       description: returns p-interface
11432       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
11433       produces:
11434         - application/json
11435         - application/xml
11436       responses:
11437         "200":
11438           description: successful operation
11439           schema:
11440               $ref: "#/getDefinitions/p-interface"
11441         "default":
11442           description: Response codes found in [response codes](https://wiki.onap.org/).
11443       parameters:
11444         - name: hostname
11445           in: path
11446           description: Value from executing hostname on the compute node.
11447           required: true
11448           type: string
11449           example: __HOSTNAME__
11450         - name: interface-name
11451           in: path
11452           description: Name that identifies the physical interface
11453           required: true
11454           type: string
11455           example: __INTERFACE-NAME__
11456     put:
11457       tags:
11458         - CloudInfrastructure
11459       summary: create or update an existing p-interface
11460       description: |
11461         Create or update an existing p-interface.
11462         #
11463         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11464       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
11465       consumes:
11466         - application/json
11467         - application/xml
11468       produces:
11469         - application/json
11470         - application/xml
11471       responses:
11472         "default":
11473           description: Response codes found in [response codes](https://wiki.onap.org/).
11474       parameters:
11475         - name: hostname
11476           in: path
11477           description: Value from executing hostname on the compute node.
11478           required: true
11479           type: string
11480           example: __HOSTNAME__
11481         - name: interface-name
11482           in: path
11483           description: Name that identifies the physical interface
11484           required: true
11485           type: string
11486           example: __INTERFACE-NAME__
11487         - name: body
11488           in: body
11489           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
11490           required: true
11491           schema:
11492             $ref: "#/definitions/p-interface"
11493     patch:
11494       tags:
11495         - CloudInfrastructure
11496       summary: update an existing p-interface
11497       description: |
11498         Update an existing p-interface
11499         #
11500         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11501         The PUT operation will entirely replace an existing object.
11502         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11503         #
11504         Other differences between PUT and PATCH are:
11505         #
11506         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11507         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11508         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11509       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
11510       consumes:
11511         - application/json
11512         - application/xml
11513       produces:
11514         - application/json
11515         - application/xml
11516       responses:
11517         "default":
11518           description: Response codes found in [response codes](https://wiki.onap.org/).
11519       parameters:
11520         - name: hostname
11521           in: path
11522           description: Value from executing hostname on the compute node.
11523           required: true
11524           type: string
11525           example: __HOSTNAME__
11526         - name: interface-name
11527           in: path
11528           description: Name that identifies the physical interface
11529           required: true
11530           type: string
11531           example: __INTERFACE-NAME__
11532         - name: body
11533           in: body
11534           description: p-interface object that needs to be updated.
11535           required: true
11536           schema:
11537             $ref: "#/patchDefinitions/p-interface"
11538     delete:
11539       tags:
11540         - CloudInfrastructure
11541       summary: delete an existing p-interface
11542       description: delete an existing p-interface
11543       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
11544       consumes:
11545         - application/json
11546         - application/xml
11547       produces:
11548         - application/json
11549         - application/xml
11550       responses:
11551         "default":
11552           description: Response codes found in [response codes](https://wiki.onap.org/).
11553       parameters:
11554         - name: hostname
11555           in: path
11556           description: Value from executing hostname on the compute node.
11557           required: true
11558           type: string
11559           example: __HOSTNAME__
11560         - name: interface-name
11561           in: path
11562           description: Name that identifies the physical interface
11563           required: true
11564           type: string
11565           example: __INTERFACE-NAME__
11566         - name: resource-version
11567           in: query
11568           description: resource-version for concurrency
11569           required: true
11570           type: string
11571   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
11572     get:
11573       tags:
11574         - CloudInfrastructure
11575       summary: returns p-interfaces
11576       description: returns p-interfaces
11577       operationId: getCloudInfrastructurePserversPserverPInterfaces
11578       produces:
11579         - application/json
11580         - application/xml
11581       responses:
11582         "200":
11583           description: successful operation
11584           schema:
11585               $ref: "#/getDefinitions/p-interfaces"
11586         "default":
11587           description: Response codes found in [response codes](https://wiki.onap.org/).
11588       parameters:
11589         - name: hostname
11590           in: path
11591           description: Value from executing hostname on the compute node.
11592           required: true
11593           type: string
11594           example: __HOSTNAME__
11595         - name: interface-name
11596           in: query
11597           description:
11598           required: false
11599           type: string
11600         - name: prov-status
11601           in: query
11602           description:
11603           required: false
11604           type: string
11605   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
11606     put:
11607       tags:
11608         - CloudInfrastructure
11609       summary: see node definition for valid relationships
11610       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
11611       consumes:
11612         - application/json
11613         - application/xml
11614       produces:
11615         - application/json
11616         - application/xml
11617       responses:
11618         "default":
11619           description: Response codes found in [response codes](https://wiki.onap.org/).
11620       parameters:
11621         - name: hostname
11622           in: path
11623           description: Value from executing hostname on the compute node.
11624           required: true
11625           type: string
11626           example: __HOSTNAME__
11627         - name: interface-name
11628           in: path
11629           description: Name that identifies the link aggregate interface
11630           required: true
11631           type: string
11632           example: __INTERFACE-NAME__
11633         - name: body
11634           in: body
11635           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
11636           required: true
11637           schema:
11638             $ref: "#/definitions/relationship"
11639     delete:
11640       tags:
11641         - CloudInfrastructure
11642       summary: delete an existing relationship
11643       description: delete an existing relationship
11644       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
11645       consumes:
11646         - application/json
11647         - application/xml
11648       produces:
11649         - application/json
11650         - application/xml
11651       responses:
11652         "default":
11653           description: Response codes found in [response codes](https://wiki.onap.org/).
11654       parameters:
11655         - name: hostname
11656           in: path
11657           description: Value from executing hostname on the compute node.
11658           required: true
11659           type: string
11660           example: __HOSTNAME__
11661         - name: interface-name
11662           in: path
11663           description: Name that identifies the link aggregate interface
11664           required: true
11665           type: string
11666           example: __INTERFACE-NAME__
11667   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
11668     put:
11669       tags:
11670         - CloudInfrastructure
11671       summary: see node definition for valid relationships
11672       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11673       consumes:
11674         - application/json
11675         - application/xml
11676       produces:
11677         - application/json
11678         - application/xml
11679       responses:
11680         "default":
11681           description: Response codes found in [response codes](https://wiki.onap.org/).
11682       parameters:
11683         - name: hostname
11684           in: path
11685           description: Value from executing hostname on the compute node.
11686           required: true
11687           type: string
11688           example: __HOSTNAME__
11689         - name: interface-name
11690           in: path
11691           description: Name that identifies the link aggregate interface
11692           required: true
11693           type: string
11694           example: __INTERFACE-NAME__
11695         - name: interface-name
11696           in: path
11697           description: Name given to the interface
11698           required: true
11699           type: string
11700           example: __INTERFACE-NAME__
11701         - name: vlan-interface
11702           in: path
11703           description: String that identifies the interface
11704           required: true
11705           type: string
11706           example: __VLAN-INTERFACE__
11707         - name: body
11708           in: body
11709           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
11710           required: true
11711           schema:
11712             $ref: "#/definitions/relationship"
11713     delete:
11714       tags:
11715         - CloudInfrastructure
11716       summary: delete an existing relationship
11717       description: delete an existing relationship
11718       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11719       consumes:
11720         - application/json
11721         - application/xml
11722       produces:
11723         - application/json
11724         - application/xml
11725       responses:
11726         "default":
11727           description: Response codes found in [response codes](https://wiki.onap.org/).
11728       parameters:
11729         - name: hostname
11730           in: path
11731           description: Value from executing hostname on the compute node.
11732           required: true
11733           type: string
11734           example: __HOSTNAME__
11735         - name: interface-name
11736           in: path
11737           description: Name that identifies the link aggregate interface
11738           required: true
11739           type: string
11740           example: __INTERFACE-NAME__
11741         - name: interface-name
11742           in: path
11743           description: Name given to the interface
11744           required: true
11745           type: string
11746           example: __INTERFACE-NAME__
11747         - name: vlan-interface
11748           in: path
11749           description: String that identifies the interface
11750           required: true
11751           type: string
11752           example: __VLAN-INTERFACE__
11753   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
11754     put:
11755       tags:
11756         - CloudInfrastructure
11757       summary: see node definition for valid relationships
11758       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
11759       consumes:
11760         - application/json
11761         - application/xml
11762       produces:
11763         - application/json
11764         - application/xml
11765       responses:
11766         "default":
11767           description: Response codes found in [response codes](https://wiki.onap.org/).
11768       parameters:
11769         - name: hostname
11770           in: path
11771           description: Value from executing hostname on the compute node.
11772           required: true
11773           type: string
11774           example: __HOSTNAME__
11775         - name: interface-name
11776           in: path
11777           description: Name that identifies the link aggregate interface
11778           required: true
11779           type: string
11780           example: __INTERFACE-NAME__
11781         - name: interface-name
11782           in: path
11783           description: Name given to the interface
11784           required: true
11785           type: string
11786           example: __INTERFACE-NAME__
11787         - name: vlan-interface
11788           in: path
11789           description: String that identifies the interface
11790           required: true
11791           type: string
11792           example: __VLAN-INTERFACE__
11793         - name: l3-interface-ipv4-address
11794           in: path
11795           description: IP address
11796           required: true
11797           type: string
11798           example: __L3-INTERFACE-IPV4-ADDRESS__
11799         - name: body
11800           in: body
11801           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11802           required: true
11803           schema:
11804             $ref: "#/definitions/relationship"
11805     delete:
11806       tags:
11807         - CloudInfrastructure
11808       summary: delete an existing relationship
11809       description: delete an existing relationship
11810       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
11811       consumes:
11812         - application/json
11813         - application/xml
11814       produces:
11815         - application/json
11816         - application/xml
11817       responses:
11818         "default":
11819           description: Response codes found in [response codes](https://wiki.onap.org/).
11820       parameters:
11821         - name: hostname
11822           in: path
11823           description: Value from executing hostname on the compute node.
11824           required: true
11825           type: string
11826           example: __HOSTNAME__
11827         - name: interface-name
11828           in: path
11829           description: Name that identifies the link aggregate interface
11830           required: true
11831           type: string
11832           example: __INTERFACE-NAME__
11833         - name: interface-name
11834           in: path
11835           description: Name given to the interface
11836           required: true
11837           type: string
11838           example: __INTERFACE-NAME__
11839         - name: vlan-interface
11840           in: path
11841           description: String that identifies the interface
11842           required: true
11843           type: string
11844           example: __VLAN-INTERFACE__
11845         - name: l3-interface-ipv4-address
11846           in: path
11847           description: IP address
11848           required: true
11849           type: string
11850           example: __L3-INTERFACE-IPV4-ADDRESS__
11851   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
11852     get:
11853       tags:
11854         - CloudInfrastructure
11855       summary: returns l3-interface-ipv4-address-list
11856       description: returns l3-interface-ipv4-address-list
11857       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11858       produces:
11859         - application/json
11860         - application/xml
11861       responses:
11862         "200":
11863           description: successful operation
11864           schema:
11865               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11866         "default":
11867           description: Response codes found in [response codes](https://wiki.onap.org/).
11868       parameters:
11869         - name: hostname
11870           in: path
11871           description: Value from executing hostname on the compute node.
11872           required: true
11873           type: string
11874           example: __HOSTNAME__
11875         - name: interface-name
11876           in: path
11877           description: Name that identifies the link aggregate interface
11878           required: true
11879           type: string
11880           example: __INTERFACE-NAME__
11881         - name: interface-name
11882           in: path
11883           description: Name given to the interface
11884           required: true
11885           type: string
11886           example: __INTERFACE-NAME__
11887         - name: vlan-interface
11888           in: path
11889           description: String that identifies the interface
11890           required: true
11891           type: string
11892           example: __VLAN-INTERFACE__
11893         - name: l3-interface-ipv4-address
11894           in: path
11895           description: IP address
11896           required: true
11897           type: string
11898           example: __L3-INTERFACE-IPV4-ADDRESS__
11899     put:
11900       tags:
11901         - CloudInfrastructure
11902       summary: create or update an existing l3-interface-ipv4-address-list
11903       description: |
11904         Create or update an existing l3-interface-ipv4-address-list.
11905         #
11906         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11907       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11908       consumes:
11909         - application/json
11910         - application/xml
11911       produces:
11912         - application/json
11913         - application/xml
11914       responses:
11915         "default":
11916           description: Response codes found in [response codes](https://wiki.onap.org/).
11917       parameters:
11918         - name: hostname
11919           in: path
11920           description: Value from executing hostname on the compute node.
11921           required: true
11922           type: string
11923           example: __HOSTNAME__
11924         - name: interface-name
11925           in: path
11926           description: Name that identifies the link aggregate interface
11927           required: true
11928           type: string
11929           example: __INTERFACE-NAME__
11930         - name: interface-name
11931           in: path
11932           description: Name given to the interface
11933           required: true
11934           type: string
11935           example: __INTERFACE-NAME__
11936         - name: vlan-interface
11937           in: path
11938           description: String that identifies the interface
11939           required: true
11940           type: string
11941           example: __VLAN-INTERFACE__
11942         - name: l3-interface-ipv4-address
11943           in: path
11944           description: IP address
11945           required: true
11946           type: string
11947           example: __L3-INTERFACE-IPV4-ADDRESS__
11948         - name: body
11949           in: body
11950           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11951           required: true
11952           schema:
11953             $ref: "#/definitions/l3-interface-ipv4-address-list"
11954     patch:
11955       tags:
11956         - CloudInfrastructure
11957       summary: update an existing l3-interface-ipv4-address-list
11958       description: |
11959         Update an existing l3-interface-ipv4-address-list
11960         #
11961         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11962         The PUT operation will entirely replace an existing object.
11963         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11964         #
11965         Other differences between PUT and PATCH are:
11966         #
11967         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11968         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11969         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11970       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11971       consumes:
11972         - application/json
11973         - application/xml
11974       produces:
11975         - application/json
11976         - application/xml
11977       responses:
11978         "default":
11979           description: Response codes found in [response codes](https://wiki.onap.org/).
11980       parameters:
11981         - name: hostname
11982           in: path
11983           description: Value from executing hostname on the compute node.
11984           required: true
11985           type: string
11986           example: __HOSTNAME__
11987         - name: interface-name
11988           in: path
11989           description: Name that identifies the link aggregate interface
11990           required: true
11991           type: string
11992           example: __INTERFACE-NAME__
11993         - name: interface-name
11994           in: path
11995           description: Name given to the interface
11996           required: true
11997           type: string
11998           example: __INTERFACE-NAME__
11999         - name: vlan-interface
12000           in: path
12001           description: String that identifies the interface
12002           required: true
12003           type: string
12004           example: __VLAN-INTERFACE__
12005         - name: l3-interface-ipv4-address
12006           in: path
12007           description: IP address
12008           required: true
12009           type: string
12010           example: __L3-INTERFACE-IPV4-ADDRESS__
12011         - name: body
12012           in: body
12013           description: l3-interface-ipv4-address-list object that needs to be updated.
12014           required: true
12015           schema:
12016             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12017     delete:
12018       tags:
12019         - CloudInfrastructure
12020       summary: delete an existing l3-interface-ipv4-address-list
12021       description: delete an existing l3-interface-ipv4-address-list
12022       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12023       consumes:
12024         - application/json
12025         - application/xml
12026       produces:
12027         - application/json
12028         - application/xml
12029       responses:
12030         "default":
12031           description: Response codes found in [response codes](https://wiki.onap.org/).
12032       parameters:
12033         - name: hostname
12034           in: path
12035           description: Value from executing hostname on the compute node.
12036           required: true
12037           type: string
12038           example: __HOSTNAME__
12039         - name: interface-name
12040           in: path
12041           description: Name that identifies the link aggregate interface
12042           required: true
12043           type: string
12044           example: __INTERFACE-NAME__
12045         - name: interface-name
12046           in: path
12047           description: Name given to the interface
12048           required: true
12049           type: string
12050           example: __INTERFACE-NAME__
12051         - name: vlan-interface
12052           in: path
12053           description: String that identifies the interface
12054           required: true
12055           type: string
12056           example: __VLAN-INTERFACE__
12057         - name: l3-interface-ipv4-address
12058           in: path
12059           description: IP address
12060           required: true
12061           type: string
12062           example: __L3-INTERFACE-IPV4-ADDRESS__
12063         - name: resource-version
12064           in: query
12065           description: resource-version for concurrency
12066           required: true
12067           type: string
12068   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
12069     put:
12070       tags:
12071         - CloudInfrastructure
12072       summary: see node definition for valid relationships
12073       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
12074       consumes:
12075         - application/json
12076         - application/xml
12077       produces:
12078         - application/json
12079         - application/xml
12080       responses:
12081         "default":
12082           description: Response codes found in [response codes](https://wiki.onap.org/).
12083       parameters:
12084         - name: hostname
12085           in: path
12086           description: Value from executing hostname on the compute node.
12087           required: true
12088           type: string
12089           example: __HOSTNAME__
12090         - name: interface-name
12091           in: path
12092           description: Name that identifies the link aggregate interface
12093           required: true
12094           type: string
12095           example: __INTERFACE-NAME__
12096         - name: interface-name
12097           in: path
12098           description: Name given to the interface
12099           required: true
12100           type: string
12101           example: __INTERFACE-NAME__
12102         - name: vlan-interface
12103           in: path
12104           description: String that identifies the interface
12105           required: true
12106           type: string
12107           example: __VLAN-INTERFACE__
12108         - name: l3-interface-ipv6-address
12109           in: path
12110           description: IP address
12111           required: true
12112           type: string
12113           example: __L3-INTERFACE-IPV6-ADDRESS__
12114         - name: body
12115           in: body
12116           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
12117           required: true
12118           schema:
12119             $ref: "#/definitions/relationship"
12120     delete:
12121       tags:
12122         - CloudInfrastructure
12123       summary: delete an existing relationship
12124       description: delete an existing relationship
12125       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
12126       consumes:
12127         - application/json
12128         - application/xml
12129       produces:
12130         - application/json
12131         - application/xml
12132       responses:
12133         "default":
12134           description: Response codes found in [response codes](https://wiki.onap.org/).
12135       parameters:
12136         - name: hostname
12137           in: path
12138           description: Value from executing hostname on the compute node.
12139           required: true
12140           type: string
12141           example: __HOSTNAME__
12142         - name: interface-name
12143           in: path
12144           description: Name that identifies the link aggregate interface
12145           required: true
12146           type: string
12147           example: __INTERFACE-NAME__
12148         - name: interface-name
12149           in: path
12150           description: Name given to the interface
12151           required: true
12152           type: string
12153           example: __INTERFACE-NAME__
12154         - name: vlan-interface
12155           in: path
12156           description: String that identifies the interface
12157           required: true
12158           type: string
12159           example: __VLAN-INTERFACE__
12160         - name: l3-interface-ipv6-address
12161           in: path
12162           description: IP address
12163           required: true
12164           type: string
12165           example: __L3-INTERFACE-IPV6-ADDRESS__
12166   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
12167     get:
12168       tags:
12169         - CloudInfrastructure
12170       summary: returns l3-interface-ipv6-address-list
12171       description: returns l3-interface-ipv6-address-list
12172       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12173       produces:
12174         - application/json
12175         - application/xml
12176       responses:
12177         "200":
12178           description: successful operation
12179           schema:
12180               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
12181         "default":
12182           description: Response codes found in [response codes](https://wiki.onap.org/).
12183       parameters:
12184         - name: hostname
12185           in: path
12186           description: Value from executing hostname on the compute node.
12187           required: true
12188           type: string
12189           example: __HOSTNAME__
12190         - name: interface-name
12191           in: path
12192           description: Name that identifies the link aggregate interface
12193           required: true
12194           type: string
12195           example: __INTERFACE-NAME__
12196         - name: interface-name
12197           in: path
12198           description: Name given to the interface
12199           required: true
12200           type: string
12201           example: __INTERFACE-NAME__
12202         - name: vlan-interface
12203           in: path
12204           description: String that identifies the interface
12205           required: true
12206           type: string
12207           example: __VLAN-INTERFACE__
12208         - name: l3-interface-ipv6-address
12209           in: path
12210           description: IP address
12211           required: true
12212           type: string
12213           example: __L3-INTERFACE-IPV6-ADDRESS__
12214     put:
12215       tags:
12216         - CloudInfrastructure
12217       summary: create or update an existing l3-interface-ipv6-address-list
12218       description: |
12219         Create or update an existing l3-interface-ipv6-address-list.
12220         #
12221         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12222       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12223       consumes:
12224         - application/json
12225         - application/xml
12226       produces:
12227         - application/json
12228         - application/xml
12229       responses:
12230         "default":
12231           description: Response codes found in [response codes](https://wiki.onap.org/).
12232       parameters:
12233         - name: hostname
12234           in: path
12235           description: Value from executing hostname on the compute node.
12236           required: true
12237           type: string
12238           example: __HOSTNAME__
12239         - name: interface-name
12240           in: path
12241           description: Name that identifies the link aggregate interface
12242           required: true
12243           type: string
12244           example: __INTERFACE-NAME__
12245         - name: interface-name
12246           in: path
12247           description: Name given to the interface
12248           required: true
12249           type: string
12250           example: __INTERFACE-NAME__
12251         - name: vlan-interface
12252           in: path
12253           description: String that identifies the interface
12254           required: true
12255           type: string
12256           example: __VLAN-INTERFACE__
12257         - name: l3-interface-ipv6-address
12258           in: path
12259           description: IP address
12260           required: true
12261           type: string
12262           example: __L3-INTERFACE-IPV6-ADDRESS__
12263         - name: body
12264           in: body
12265           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
12266           required: true
12267           schema:
12268             $ref: "#/definitions/l3-interface-ipv6-address-list"
12269     patch:
12270       tags:
12271         - CloudInfrastructure
12272       summary: update an existing l3-interface-ipv6-address-list
12273       description: |
12274         Update an existing l3-interface-ipv6-address-list
12275         #
12276         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12277         The PUT operation will entirely replace an existing object.
12278         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12279         #
12280         Other differences between PUT and PATCH are:
12281         #
12282         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12283         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12284         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12285       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12286       consumes:
12287         - application/json
12288         - application/xml
12289       produces:
12290         - application/json
12291         - application/xml
12292       responses:
12293         "default":
12294           description: Response codes found in [response codes](https://wiki.onap.org/).
12295       parameters:
12296         - name: hostname
12297           in: path
12298           description: Value from executing hostname on the compute node.
12299           required: true
12300           type: string
12301           example: __HOSTNAME__
12302         - name: interface-name
12303           in: path
12304           description: Name that identifies the link aggregate interface
12305           required: true
12306           type: string
12307           example: __INTERFACE-NAME__
12308         - name: interface-name
12309           in: path
12310           description: Name given to the interface
12311           required: true
12312           type: string
12313           example: __INTERFACE-NAME__
12314         - name: vlan-interface
12315           in: path
12316           description: String that identifies the interface
12317           required: true
12318           type: string
12319           example: __VLAN-INTERFACE__
12320         - name: l3-interface-ipv6-address
12321           in: path
12322           description: IP address
12323           required: true
12324           type: string
12325           example: __L3-INTERFACE-IPV6-ADDRESS__
12326         - name: body
12327           in: body
12328           description: l3-interface-ipv6-address-list object that needs to be updated.
12329           required: true
12330           schema:
12331             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
12332     delete:
12333       tags:
12334         - CloudInfrastructure
12335       summary: delete an existing l3-interface-ipv6-address-list
12336       description: delete an existing l3-interface-ipv6-address-list
12337       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12338       consumes:
12339         - application/json
12340         - application/xml
12341       produces:
12342         - application/json
12343         - application/xml
12344       responses:
12345         "default":
12346           description: Response codes found in [response codes](https://wiki.onap.org/).
12347       parameters:
12348         - name: hostname
12349           in: path
12350           description: Value from executing hostname on the compute node.
12351           required: true
12352           type: string
12353           example: __HOSTNAME__
12354         - name: interface-name
12355           in: path
12356           description: Name that identifies the link aggregate interface
12357           required: true
12358           type: string
12359           example: __INTERFACE-NAME__
12360         - name: interface-name
12361           in: path
12362           description: Name given to the interface
12363           required: true
12364           type: string
12365           example: __INTERFACE-NAME__
12366         - name: vlan-interface
12367           in: path
12368           description: String that identifies the interface
12369           required: true
12370           type: string
12371           example: __VLAN-INTERFACE__
12372         - name: l3-interface-ipv6-address
12373           in: path
12374           description: IP address
12375           required: true
12376           type: string
12377           example: __L3-INTERFACE-IPV6-ADDRESS__
12378         - name: resource-version
12379           in: query
12380           description: resource-version for concurrency
12381           required: true
12382           type: string
12383   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
12384     get:
12385       tags:
12386         - CloudInfrastructure
12387       summary: returns vlan
12388       description: returns vlan
12389       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12390       produces:
12391         - application/json
12392         - application/xml
12393       responses:
12394         "200":
12395           description: successful operation
12396           schema:
12397               $ref: "#/getDefinitions/vlan"
12398         "default":
12399           description: Response codes found in [response codes](https://wiki.onap.org/).
12400       parameters:
12401         - name: hostname
12402           in: path
12403           description: Value from executing hostname on the compute node.
12404           required: true
12405           type: string
12406           example: __HOSTNAME__
12407         - name: interface-name
12408           in: path
12409           description: Name that identifies the link aggregate interface
12410           required: true
12411           type: string
12412           example: __INTERFACE-NAME__
12413         - name: interface-name
12414           in: path
12415           description: Name given to the interface
12416           required: true
12417           type: string
12418           example: __INTERFACE-NAME__
12419         - name: vlan-interface
12420           in: path
12421           description: String that identifies the interface
12422           required: true
12423           type: string
12424           example: __VLAN-INTERFACE__
12425     put:
12426       tags:
12427         - CloudInfrastructure
12428       summary: create or update an existing vlan
12429       description: |
12430         Create or update an existing vlan.
12431         #
12432         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12433       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12434       consumes:
12435         - application/json
12436         - application/xml
12437       produces:
12438         - application/json
12439         - application/xml
12440       responses:
12441         "default":
12442           description: Response codes found in [response codes](https://wiki.onap.org/).
12443       parameters:
12444         - name: hostname
12445           in: path
12446           description: Value from executing hostname on the compute node.
12447           required: true
12448           type: string
12449           example: __HOSTNAME__
12450         - name: interface-name
12451           in: path
12452           description: Name that identifies the link aggregate interface
12453           required: true
12454           type: string
12455           example: __INTERFACE-NAME__
12456         - name: interface-name
12457           in: path
12458           description: Name given to the interface
12459           required: true
12460           type: string
12461           example: __INTERFACE-NAME__
12462         - name: vlan-interface
12463           in: path
12464           description: String that identifies the interface
12465           required: true
12466           type: string
12467           example: __VLAN-INTERFACE__
12468         - name: body
12469           in: body
12470           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
12471           required: true
12472           schema:
12473             $ref: "#/definitions/vlan"
12474     patch:
12475       tags:
12476         - CloudInfrastructure
12477       summary: update an existing vlan
12478       description: |
12479         Update an existing vlan
12480         #
12481         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12482         The PUT operation will entirely replace an existing object.
12483         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12484         #
12485         Other differences between PUT and PATCH are:
12486         #
12487         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12488         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12489         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12490       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12491       consumes:
12492         - application/json
12493         - application/xml
12494       produces:
12495         - application/json
12496         - application/xml
12497       responses:
12498         "default":
12499           description: Response codes found in [response codes](https://wiki.onap.org/).
12500       parameters:
12501         - name: hostname
12502           in: path
12503           description: Value from executing hostname on the compute node.
12504           required: true
12505           type: string
12506           example: __HOSTNAME__
12507         - name: interface-name
12508           in: path
12509           description: Name that identifies the link aggregate interface
12510           required: true
12511           type: string
12512           example: __INTERFACE-NAME__
12513         - name: interface-name
12514           in: path
12515           description: Name given to the interface
12516           required: true
12517           type: string
12518           example: __INTERFACE-NAME__
12519         - name: vlan-interface
12520           in: path
12521           description: String that identifies the interface
12522           required: true
12523           type: string
12524           example: __VLAN-INTERFACE__
12525         - name: body
12526           in: body
12527           description: vlan object that needs to be updated.
12528           required: true
12529           schema:
12530             $ref: "#/patchDefinitions/vlan"
12531     delete:
12532       tags:
12533         - CloudInfrastructure
12534       summary: delete an existing vlan
12535       description: delete an existing vlan
12536       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12537       consumes:
12538         - application/json
12539         - application/xml
12540       produces:
12541         - application/json
12542         - application/xml
12543       responses:
12544         "default":
12545           description: Response codes found in [response codes](https://wiki.onap.org/).
12546       parameters:
12547         - name: hostname
12548           in: path
12549           description: Value from executing hostname on the compute node.
12550           required: true
12551           type: string
12552           example: __HOSTNAME__
12553         - name: interface-name
12554           in: path
12555           description: Name that identifies the link aggregate interface
12556           required: true
12557           type: string
12558           example: __INTERFACE-NAME__
12559         - name: interface-name
12560           in: path
12561           description: Name given to the interface
12562           required: true
12563           type: string
12564           example: __INTERFACE-NAME__
12565         - name: vlan-interface
12566           in: path
12567           description: String that identifies the interface
12568           required: true
12569           type: string
12570           example: __VLAN-INTERFACE__
12571         - name: resource-version
12572           in: query
12573           description: resource-version for concurrency
12574           required: true
12575           type: string
12576   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
12577     get:
12578       tags:
12579         - CloudInfrastructure
12580       summary: returns vlans
12581       description: returns vlans
12582       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
12583       produces:
12584         - application/json
12585         - application/xml
12586       responses:
12587         "200":
12588           description: successful operation
12589           schema:
12590               $ref: "#/getDefinitions/vlans"
12591         "default":
12592           description: Response codes found in [response codes](https://wiki.onap.org/).
12593       parameters:
12594         - name: hostname
12595           in: path
12596           description: Value from executing hostname on the compute node.
12597           required: true
12598           type: string
12599           example: __HOSTNAME__
12600         - name: interface-name
12601           in: path
12602           description: Name that identifies the link aggregate interface
12603           required: true
12604           type: string
12605           example: __INTERFACE-NAME__
12606         - name: interface-name
12607           in: path
12608           description: Name given to the interface
12609           required: true
12610           type: string
12611           example: __INTERFACE-NAME__
12612         - name: vlan-interface
12613           in: query
12614           description:
12615           required: false
12616           type: string
12617         - name: vlan-id-inner
12618           in: query
12619           description:
12620           required: false
12621           type: integer
12622           format: int64
12623         - name: vpn-key
12624           in: query
12625           description:
12626           required: false
12627           type: string
12628   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
12629     put:
12630       tags:
12631         - CloudInfrastructure
12632       summary: see node definition for valid relationships
12633       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12634       consumes:
12635         - application/json
12636         - application/xml
12637       produces:
12638         - application/json
12639         - application/xml
12640       responses:
12641         "default":
12642           description: Response codes found in [response codes](https://wiki.onap.org/).
12643       parameters:
12644         - name: hostname
12645           in: path
12646           description: Value from executing hostname on the compute node.
12647           required: true
12648           type: string
12649           example: __HOSTNAME__
12650         - name: interface-name
12651           in: path
12652           description: Name that identifies the link aggregate interface
12653           required: true
12654           type: string
12655           example: __INTERFACE-NAME__
12656         - name: interface-name
12657           in: path
12658           description: Name given to the interface
12659           required: true
12660           type: string
12661           example: __INTERFACE-NAME__
12662         - name: pci-id
12663           in: path
12664           description: PCI ID used to identify the sriov-vf
12665           required: true
12666           type: string
12667           example: __PCI-ID__
12668         - name: body
12669           in: body
12670           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12671           required: true
12672           schema:
12673             $ref: "#/definitions/relationship"
12674     delete:
12675       tags:
12676         - CloudInfrastructure
12677       summary: delete an existing relationship
12678       description: delete an existing relationship
12679       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12680       consumes:
12681         - application/json
12682         - application/xml
12683       produces:
12684         - application/json
12685         - application/xml
12686       responses:
12687         "default":
12688           description: Response codes found in [response codes](https://wiki.onap.org/).
12689       parameters:
12690         - name: hostname
12691           in: path
12692           description: Value from executing hostname on the compute node.
12693           required: true
12694           type: string
12695           example: __HOSTNAME__
12696         - name: interface-name
12697           in: path
12698           description: Name that identifies the link aggregate interface
12699           required: true
12700           type: string
12701           example: __INTERFACE-NAME__
12702         - name: interface-name
12703           in: path
12704           description: Name given to the interface
12705           required: true
12706           type: string
12707           example: __INTERFACE-NAME__
12708         - name: pci-id
12709           in: path
12710           description: PCI ID used to identify the sriov-vf
12711           required: true
12712           type: string
12713           example: __PCI-ID__
12714   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
12715     get:
12716       tags:
12717         - CloudInfrastructure
12718       summary: returns sriov-vf
12719       description: returns sriov-vf
12720       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12721       produces:
12722         - application/json
12723         - application/xml
12724       responses:
12725         "200":
12726           description: successful operation
12727           schema:
12728               $ref: "#/getDefinitions/sriov-vf"
12729         "default":
12730           description: Response codes found in [response codes](https://wiki.onap.org/).
12731       parameters:
12732         - name: hostname
12733           in: path
12734           description: Value from executing hostname on the compute node.
12735           required: true
12736           type: string
12737           example: __HOSTNAME__
12738         - name: interface-name
12739           in: path
12740           description: Name that identifies the link aggregate interface
12741           required: true
12742           type: string
12743           example: __INTERFACE-NAME__
12744         - name: interface-name
12745           in: path
12746           description: Name given to the interface
12747           required: true
12748           type: string
12749           example: __INTERFACE-NAME__
12750         - name: pci-id
12751           in: path
12752           description: PCI ID used to identify the sriov-vf
12753           required: true
12754           type: string
12755           example: __PCI-ID__
12756     put:
12757       tags:
12758         - CloudInfrastructure
12759       summary: create or update an existing sriov-vf
12760       description: |
12761         Create or update an existing sriov-vf.
12762         #
12763         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12764       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12765       consumes:
12766         - application/json
12767         - application/xml
12768       produces:
12769         - application/json
12770         - application/xml
12771       responses:
12772         "default":
12773           description: Response codes found in [response codes](https://wiki.onap.org/).
12774       parameters:
12775         - name: hostname
12776           in: path
12777           description: Value from executing hostname on the compute node.
12778           required: true
12779           type: string
12780           example: __HOSTNAME__
12781         - name: interface-name
12782           in: path
12783           description: Name that identifies the link aggregate interface
12784           required: true
12785           type: string
12786           example: __INTERFACE-NAME__
12787         - name: interface-name
12788           in: path
12789           description: Name given to the interface
12790           required: true
12791           type: string
12792           example: __INTERFACE-NAME__
12793         - name: pci-id
12794           in: path
12795           description: PCI ID used to identify the sriov-vf
12796           required: true
12797           type: string
12798           example: __PCI-ID__
12799         - name: body
12800           in: body
12801           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12802           required: true
12803           schema:
12804             $ref: "#/definitions/sriov-vf"
12805     patch:
12806       tags:
12807         - CloudInfrastructure
12808       summary: update an existing sriov-vf
12809       description: |
12810         Update an existing sriov-vf
12811         #
12812         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12813         The PUT operation will entirely replace an existing object.
12814         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12815         #
12816         Other differences between PUT and PATCH are:
12817         #
12818         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12819         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12820         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12821       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12822       consumes:
12823         - application/json
12824         - application/xml
12825       produces:
12826         - application/json
12827         - application/xml
12828       responses:
12829         "default":
12830           description: Response codes found in [response codes](https://wiki.onap.org/).
12831       parameters:
12832         - name: hostname
12833           in: path
12834           description: Value from executing hostname on the compute node.
12835           required: true
12836           type: string
12837           example: __HOSTNAME__
12838         - name: interface-name
12839           in: path
12840           description: Name that identifies the link aggregate interface
12841           required: true
12842           type: string
12843           example: __INTERFACE-NAME__
12844         - name: interface-name
12845           in: path
12846           description: Name given to the interface
12847           required: true
12848           type: string
12849           example: __INTERFACE-NAME__
12850         - name: pci-id
12851           in: path
12852           description: PCI ID used to identify the sriov-vf
12853           required: true
12854           type: string
12855           example: __PCI-ID__
12856         - name: body
12857           in: body
12858           description: sriov-vf object that needs to be updated.
12859           required: true
12860           schema:
12861             $ref: "#/patchDefinitions/sriov-vf"
12862     delete:
12863       tags:
12864         - CloudInfrastructure
12865       summary: delete an existing sriov-vf
12866       description: delete an existing sriov-vf
12867       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12868       consumes:
12869         - application/json
12870         - application/xml
12871       produces:
12872         - application/json
12873         - application/xml
12874       responses:
12875         "default":
12876           description: Response codes found in [response codes](https://wiki.onap.org/).
12877       parameters:
12878         - name: hostname
12879           in: path
12880           description: Value from executing hostname on the compute node.
12881           required: true
12882           type: string
12883           example: __HOSTNAME__
12884         - name: interface-name
12885           in: path
12886           description: Name that identifies the link aggregate interface
12887           required: true
12888           type: string
12889           example: __INTERFACE-NAME__
12890         - name: interface-name
12891           in: path
12892           description: Name given to the interface
12893           required: true
12894           type: string
12895           example: __INTERFACE-NAME__
12896         - name: pci-id
12897           in: path
12898           description: PCI ID used to identify the sriov-vf
12899           required: true
12900           type: string
12901           example: __PCI-ID__
12902         - name: resource-version
12903           in: query
12904           description: resource-version for concurrency
12905           required: true
12906           type: string
12907   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
12908     get:
12909       tags:
12910         - CloudInfrastructure
12911       summary: returns sriov-vfs
12912       description: returns sriov-vfs
12913       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
12914       produces:
12915         - application/json
12916         - application/xml
12917       responses:
12918         "200":
12919           description: successful operation
12920           schema:
12921               $ref: "#/getDefinitions/sriov-vfs"
12922         "default":
12923           description: Response codes found in [response codes](https://wiki.onap.org/).
12924       parameters:
12925         - name: hostname
12926           in: path
12927           description: Value from executing hostname on the compute node.
12928           required: true
12929           type: string
12930           example: __HOSTNAME__
12931         - name: interface-name
12932           in: path
12933           description: Name that identifies the link aggregate interface
12934           required: true
12935           type: string
12936           example: __INTERFACE-NAME__
12937         - name: interface-name
12938           in: path
12939           description: Name given to the interface
12940           required: true
12941           type: string
12942           example: __INTERFACE-NAME__
12943         - name: pci-id
12944           in: query
12945           description:
12946           required: false
12947           type: string
12948         - name: vf-vlan-filter
12949           in: query
12950           description:
12951           required: false
12952           type: string
12953         - name: vf-mac-filter
12954           in: query
12955           description:
12956           required: false
12957           type: string
12958         - name: vf-vlan-strip
12959           in: query
12960           description:
12961           required: false
12962           type: boolean
12963         - name: neutron-network-id
12964           in: query
12965           description:
12966           required: false
12967           type: string
12968   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
12969     put:
12970       tags:
12971         - CloudInfrastructure
12972       summary: see node definition for valid relationships
12973       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12974       consumes:
12975         - application/json
12976         - application/xml
12977       produces:
12978         - application/json
12979         - application/xml
12980       responses:
12981         "default":
12982           description: Response codes found in [response codes](https://wiki.onap.org/).
12983       parameters:
12984         - name: hostname
12985           in: path
12986           description: Value from executing hostname on the compute node.
12987           required: true
12988           type: string
12989           example: __HOSTNAME__
12990         - name: interface-name
12991           in: path
12992           description: Name that identifies the link aggregate interface
12993           required: true
12994           type: string
12995           example: __INTERFACE-NAME__
12996         - name: interface-name
12997           in: path
12998           description: Name given to the interface
12999           required: true
13000           type: string
13001           example: __INTERFACE-NAME__
13002         - name: body
13003           in: body
13004           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13005           required: true
13006           schema:
13007             $ref: "#/definitions/relationship"
13008     delete:
13009       tags:
13010         - CloudInfrastructure
13011       summary: delete an existing relationship
13012       description: delete an existing relationship
13013       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
13014       consumes:
13015         - application/json
13016         - application/xml
13017       produces:
13018         - application/json
13019         - application/xml
13020       responses:
13021         "default":
13022           description: Response codes found in [response codes](https://wiki.onap.org/).
13023       parameters:
13024         - name: hostname
13025           in: path
13026           description: Value from executing hostname on the compute node.
13027           required: true
13028           type: string
13029           example: __HOSTNAME__
13030         - name: interface-name
13031           in: path
13032           description: Name that identifies the link aggregate interface
13033           required: true
13034           type: string
13035           example: __INTERFACE-NAME__
13036         - name: interface-name
13037           in: path
13038           description: Name given to the interface
13039           required: true
13040           type: string
13041           example: __INTERFACE-NAME__
13042   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
13043     put:
13044       tags:
13045         - CloudInfrastructure
13046       summary: see node definition for valid relationships
13047       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
13048       consumes:
13049         - application/json
13050         - application/xml
13051       produces:
13052         - application/json
13053         - application/xml
13054       responses:
13055         "default":
13056           description: Response codes found in [response codes](https://wiki.onap.org/).
13057       parameters:
13058         - name: hostname
13059           in: path
13060           description: Value from executing hostname on the compute node.
13061           required: true
13062           type: string
13063           example: __HOSTNAME__
13064         - name: interface-name
13065           in: path
13066           description: Name that identifies the link aggregate interface
13067           required: true
13068           type: string
13069           example: __INTERFACE-NAME__
13070         - name: interface-name
13071           in: path
13072           description: Name given to the interface
13073           required: true
13074           type: string
13075           example: __INTERFACE-NAME__
13076         - name: l3-interface-ipv4-address
13077           in: path
13078           description: IP address
13079           required: true
13080           type: string
13081           example: __L3-INTERFACE-IPV4-ADDRESS__
13082         - name: body
13083           in: body
13084           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
13085           required: true
13086           schema:
13087             $ref: "#/definitions/relationship"
13088     delete:
13089       tags:
13090         - CloudInfrastructure
13091       summary: delete an existing relationship
13092       description: delete an existing relationship
13093       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
13094       consumes:
13095         - application/json
13096         - application/xml
13097       produces:
13098         - application/json
13099         - application/xml
13100       responses:
13101         "default":
13102           description: Response codes found in [response codes](https://wiki.onap.org/).
13103       parameters:
13104         - name: hostname
13105           in: path
13106           description: Value from executing hostname on the compute node.
13107           required: true
13108           type: string
13109           example: __HOSTNAME__
13110         - name: interface-name
13111           in: path
13112           description: Name that identifies the link aggregate interface
13113           required: true
13114           type: string
13115           example: __INTERFACE-NAME__
13116         - name: interface-name
13117           in: path
13118           description: Name given to the interface
13119           required: true
13120           type: string
13121           example: __INTERFACE-NAME__
13122         - name: l3-interface-ipv4-address
13123           in: path
13124           description: IP address
13125           required: true
13126           type: string
13127           example: __L3-INTERFACE-IPV4-ADDRESS__
13128   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
13129     get:
13130       tags:
13131         - CloudInfrastructure
13132       summary: returns l3-interface-ipv4-address-list
13133       description: returns l3-interface-ipv4-address-list
13134       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13135       produces:
13136         - application/json
13137         - application/xml
13138       responses:
13139         "200":
13140           description: successful operation
13141           schema:
13142               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
13143         "default":
13144           description: Response codes found in [response codes](https://wiki.onap.org/).
13145       parameters:
13146         - name: hostname
13147           in: path
13148           description: Value from executing hostname on the compute node.
13149           required: true
13150           type: string
13151           example: __HOSTNAME__
13152         - name: interface-name
13153           in: path
13154           description: Name that identifies the link aggregate interface
13155           required: true
13156           type: string
13157           example: __INTERFACE-NAME__
13158         - name: interface-name
13159           in: path
13160           description: Name given to the interface
13161           required: true
13162           type: string
13163           example: __INTERFACE-NAME__
13164         - name: l3-interface-ipv4-address
13165           in: path
13166           description: IP address
13167           required: true
13168           type: string
13169           example: __L3-INTERFACE-IPV4-ADDRESS__
13170     put:
13171       tags:
13172         - CloudInfrastructure
13173       summary: create or update an existing l3-interface-ipv4-address-list
13174       description: |
13175         Create or update an existing l3-interface-ipv4-address-list.
13176         #
13177         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13178       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13179       consumes:
13180         - application/json
13181         - application/xml
13182       produces:
13183         - application/json
13184         - application/xml
13185       responses:
13186         "default":
13187           description: Response codes found in [response codes](https://wiki.onap.org/).
13188       parameters:
13189         - name: hostname
13190           in: path
13191           description: Value from executing hostname on the compute node.
13192           required: true
13193           type: string
13194           example: __HOSTNAME__
13195         - name: interface-name
13196           in: path
13197           description: Name that identifies the link aggregate interface
13198           required: true
13199           type: string
13200           example: __INTERFACE-NAME__
13201         - name: interface-name
13202           in: path
13203           description: Name given to the interface
13204           required: true
13205           type: string
13206           example: __INTERFACE-NAME__
13207         - name: l3-interface-ipv4-address
13208           in: path
13209           description: IP address
13210           required: true
13211           type: string
13212           example: __L3-INTERFACE-IPV4-ADDRESS__
13213         - name: body
13214           in: body
13215           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
13216           required: true
13217           schema:
13218             $ref: "#/definitions/l3-interface-ipv4-address-list"
13219     patch:
13220       tags:
13221         - CloudInfrastructure
13222       summary: update an existing l3-interface-ipv4-address-list
13223       description: |
13224         Update an existing l3-interface-ipv4-address-list
13225         #
13226         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13227         The PUT operation will entirely replace an existing object.
13228         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13229         #
13230         Other differences between PUT and PATCH are:
13231         #
13232         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13233         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13234         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13235       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13236       consumes:
13237         - application/json
13238         - application/xml
13239       produces:
13240         - application/json
13241         - application/xml
13242       responses:
13243         "default":
13244           description: Response codes found in [response codes](https://wiki.onap.org/).
13245       parameters:
13246         - name: hostname
13247           in: path
13248           description: Value from executing hostname on the compute node.
13249           required: true
13250           type: string
13251           example: __HOSTNAME__
13252         - name: interface-name
13253           in: path
13254           description: Name that identifies the link aggregate interface
13255           required: true
13256           type: string
13257           example: __INTERFACE-NAME__
13258         - name: interface-name
13259           in: path
13260           description: Name given to the interface
13261           required: true
13262           type: string
13263           example: __INTERFACE-NAME__
13264         - name: l3-interface-ipv4-address
13265           in: path
13266           description: IP address
13267           required: true
13268           type: string
13269           example: __L3-INTERFACE-IPV4-ADDRESS__
13270         - name: body
13271           in: body
13272           description: l3-interface-ipv4-address-list object that needs to be updated.
13273           required: true
13274           schema:
13275             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
13276     delete:
13277       tags:
13278         - CloudInfrastructure
13279       summary: delete an existing l3-interface-ipv4-address-list
13280       description: delete an existing l3-interface-ipv4-address-list
13281       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13282       consumes:
13283         - application/json
13284         - application/xml
13285       produces:
13286         - application/json
13287         - application/xml
13288       responses:
13289         "default":
13290           description: Response codes found in [response codes](https://wiki.onap.org/).
13291       parameters:
13292         - name: hostname
13293           in: path
13294           description: Value from executing hostname on the compute node.
13295           required: true
13296           type: string
13297           example: __HOSTNAME__
13298         - name: interface-name
13299           in: path
13300           description: Name that identifies the link aggregate interface
13301           required: true
13302           type: string
13303           example: __INTERFACE-NAME__
13304         - name: interface-name
13305           in: path
13306           description: Name given to the interface
13307           required: true
13308           type: string
13309           example: __INTERFACE-NAME__
13310         - name: l3-interface-ipv4-address
13311           in: path
13312           description: IP address
13313           required: true
13314           type: string
13315           example: __L3-INTERFACE-IPV4-ADDRESS__
13316         - name: resource-version
13317           in: query
13318           description: resource-version for concurrency
13319           required: true
13320           type: string
13321   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
13322     put:
13323       tags:
13324         - CloudInfrastructure
13325       summary: see node definition for valid relationships
13326       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13327       consumes:
13328         - application/json
13329         - application/xml
13330       produces:
13331         - application/json
13332         - application/xml
13333       responses:
13334         "default":
13335           description: Response codes found in [response codes](https://wiki.onap.org/).
13336       parameters:
13337         - name: hostname
13338           in: path
13339           description: Value from executing hostname on the compute node.
13340           required: true
13341           type: string
13342           example: __HOSTNAME__
13343         - name: interface-name
13344           in: path
13345           description: Name that identifies the link aggregate interface
13346           required: true
13347           type: string
13348           example: __INTERFACE-NAME__
13349         - name: interface-name
13350           in: path
13351           description: Name given to the interface
13352           required: true
13353           type: string
13354           example: __INTERFACE-NAME__
13355         - name: l3-interface-ipv6-address
13356           in: path
13357           description: IP address
13358           required: true
13359           type: string
13360           example: __L3-INTERFACE-IPV6-ADDRESS__
13361         - name: body
13362           in: body
13363           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13364           required: true
13365           schema:
13366             $ref: "#/definitions/relationship"
13367     delete:
13368       tags:
13369         - CloudInfrastructure
13370       summary: delete an existing relationship
13371       description: delete an existing relationship
13372       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13373       consumes:
13374         - application/json
13375         - application/xml
13376       produces:
13377         - application/json
13378         - application/xml
13379       responses:
13380         "default":
13381           description: Response codes found in [response codes](https://wiki.onap.org/).
13382       parameters:
13383         - name: hostname
13384           in: path
13385           description: Value from executing hostname on the compute node.
13386           required: true
13387           type: string
13388           example: __HOSTNAME__
13389         - name: interface-name
13390           in: path
13391           description: Name that identifies the link aggregate interface
13392           required: true
13393           type: string
13394           example: __INTERFACE-NAME__
13395         - name: interface-name
13396           in: path
13397           description: Name given to the interface
13398           required: true
13399           type: string
13400           example: __INTERFACE-NAME__
13401         - name: l3-interface-ipv6-address
13402           in: path
13403           description: IP address
13404           required: true
13405           type: string
13406           example: __L3-INTERFACE-IPV6-ADDRESS__
13407   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
13408     get:
13409       tags:
13410         - CloudInfrastructure
13411       summary: returns l3-interface-ipv6-address-list
13412       description: returns l3-interface-ipv6-address-list
13413       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13414       produces:
13415         - application/json
13416         - application/xml
13417       responses:
13418         "200":
13419           description: successful operation
13420           schema:
13421               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
13422         "default":
13423           description: Response codes found in [response codes](https://wiki.onap.org/).
13424       parameters:
13425         - name: hostname
13426           in: path
13427           description: Value from executing hostname on the compute node.
13428           required: true
13429           type: string
13430           example: __HOSTNAME__
13431         - name: interface-name
13432           in: path
13433           description: Name that identifies the link aggregate interface
13434           required: true
13435           type: string
13436           example: __INTERFACE-NAME__
13437         - name: interface-name
13438           in: path
13439           description: Name given to the interface
13440           required: true
13441           type: string
13442           example: __INTERFACE-NAME__
13443         - name: l3-interface-ipv6-address
13444           in: path
13445           description: IP address
13446           required: true
13447           type: string
13448           example: __L3-INTERFACE-IPV6-ADDRESS__
13449     put:
13450       tags:
13451         - CloudInfrastructure
13452       summary: create or update an existing l3-interface-ipv6-address-list
13453       description: |
13454         Create or update an existing l3-interface-ipv6-address-list.
13455         #
13456         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13457       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13458       consumes:
13459         - application/json
13460         - application/xml
13461       produces:
13462         - application/json
13463         - application/xml
13464       responses:
13465         "default":
13466           description: Response codes found in [response codes](https://wiki.onap.org/).
13467       parameters:
13468         - name: hostname
13469           in: path
13470           description: Value from executing hostname on the compute node.
13471           required: true
13472           type: string
13473           example: __HOSTNAME__
13474         - name: interface-name
13475           in: path
13476           description: Name that identifies the link aggregate interface
13477           required: true
13478           type: string
13479           example: __INTERFACE-NAME__
13480         - name: interface-name
13481           in: path
13482           description: Name given to the interface
13483           required: true
13484           type: string
13485           example: __INTERFACE-NAME__
13486         - name: l3-interface-ipv6-address
13487           in: path
13488           description: IP address
13489           required: true
13490           type: string
13491           example: __L3-INTERFACE-IPV6-ADDRESS__
13492         - name: body
13493           in: body
13494           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13495           required: true
13496           schema:
13497             $ref: "#/definitions/l3-interface-ipv6-address-list"
13498     patch:
13499       tags:
13500         - CloudInfrastructure
13501       summary: update an existing l3-interface-ipv6-address-list
13502       description: |
13503         Update an existing l3-interface-ipv6-address-list
13504         #
13505         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13506         The PUT operation will entirely replace an existing object.
13507         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13508         #
13509         Other differences between PUT and PATCH are:
13510         #
13511         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13512         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13513         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13514       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13515       consumes:
13516         - application/json
13517         - application/xml
13518       produces:
13519         - application/json
13520         - application/xml
13521       responses:
13522         "default":
13523           description: Response codes found in [response codes](https://wiki.onap.org/).
13524       parameters:
13525         - name: hostname
13526           in: path
13527           description: Value from executing hostname on the compute node.
13528           required: true
13529           type: string
13530           example: __HOSTNAME__
13531         - name: interface-name
13532           in: path
13533           description: Name that identifies the link aggregate interface
13534           required: true
13535           type: string
13536           example: __INTERFACE-NAME__
13537         - name: interface-name
13538           in: path
13539           description: Name given to the interface
13540           required: true
13541           type: string
13542           example: __INTERFACE-NAME__
13543         - name: l3-interface-ipv6-address
13544           in: path
13545           description: IP address
13546           required: true
13547           type: string
13548           example: __L3-INTERFACE-IPV6-ADDRESS__
13549         - name: body
13550           in: body
13551           description: l3-interface-ipv6-address-list object that needs to be updated.
13552           required: true
13553           schema:
13554             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
13555     delete:
13556       tags:
13557         - CloudInfrastructure
13558       summary: delete an existing l3-interface-ipv6-address-list
13559       description: delete an existing l3-interface-ipv6-address-list
13560       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13561       consumes:
13562         - application/json
13563         - application/xml
13564       produces:
13565         - application/json
13566         - application/xml
13567       responses:
13568         "default":
13569           description: Response codes found in [response codes](https://wiki.onap.org/).
13570       parameters:
13571         - name: hostname
13572           in: path
13573           description: Value from executing hostname on the compute node.
13574           required: true
13575           type: string
13576           example: __HOSTNAME__
13577         - name: interface-name
13578           in: path
13579           description: Name that identifies the link aggregate interface
13580           required: true
13581           type: string
13582           example: __INTERFACE-NAME__
13583         - name: interface-name
13584           in: path
13585           description: Name given to the interface
13586           required: true
13587           type: string
13588           example: __INTERFACE-NAME__
13589         - name: l3-interface-ipv6-address
13590           in: path
13591           description: IP address
13592           required: true
13593           type: string
13594           example: __L3-INTERFACE-IPV6-ADDRESS__
13595         - name: resource-version
13596           in: query
13597           description: resource-version for concurrency
13598           required: true
13599           type: string
13600   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
13601     get:
13602       tags:
13603         - CloudInfrastructure
13604       summary: returns l-interface
13605       description: returns l-interface
13606       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13607       produces:
13608         - application/json
13609         - application/xml
13610       responses:
13611         "200":
13612           description: successful operation
13613           schema:
13614               $ref: "#/getDefinitions/l-interface"
13615         "default":
13616           description: Response codes found in [response codes](https://wiki.onap.org/).
13617       parameters:
13618         - name: hostname
13619           in: path
13620           description: Value from executing hostname on the compute node.
13621           required: true
13622           type: string
13623           example: __HOSTNAME__
13624         - name: interface-name
13625           in: path
13626           description: Name that identifies the link aggregate interface
13627           required: true
13628           type: string
13629           example: __INTERFACE-NAME__
13630         - name: interface-name
13631           in: path
13632           description: Name given to the interface
13633           required: true
13634           type: string
13635           example: __INTERFACE-NAME__
13636     put:
13637       tags:
13638         - CloudInfrastructure
13639       summary: create or update an existing l-interface
13640       description: |
13641         Create or update an existing l-interface.
13642         #
13643         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13644       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13645       consumes:
13646         - application/json
13647         - application/xml
13648       produces:
13649         - application/json
13650         - application/xml
13651       responses:
13652         "default":
13653           description: Response codes found in [response codes](https://wiki.onap.org/).
13654       parameters:
13655         - name: hostname
13656           in: path
13657           description: Value from executing hostname on the compute node.
13658           required: true
13659           type: string
13660           example: __HOSTNAME__
13661         - name: interface-name
13662           in: path
13663           description: Name that identifies the link aggregate interface
13664           required: true
13665           type: string
13666           example: __INTERFACE-NAME__
13667         - name: interface-name
13668           in: path
13669           description: Name given to the interface
13670           required: true
13671           type: string
13672           example: __INTERFACE-NAME__
13673         - name: body
13674           in: body
13675           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13676           required: true
13677           schema:
13678             $ref: "#/definitions/l-interface"
13679     patch:
13680       tags:
13681         - CloudInfrastructure
13682       summary: update an existing l-interface
13683       description: |
13684         Update an existing l-interface
13685         #
13686         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13687         The PUT operation will entirely replace an existing object.
13688         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13689         #
13690         Other differences between PUT and PATCH are:
13691         #
13692         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13693         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13694         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13695       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13696       consumes:
13697         - application/json
13698         - application/xml
13699       produces:
13700         - application/json
13701         - application/xml
13702       responses:
13703         "default":
13704           description: Response codes found in [response codes](https://wiki.onap.org/).
13705       parameters:
13706         - name: hostname
13707           in: path
13708           description: Value from executing hostname on the compute node.
13709           required: true
13710           type: string
13711           example: __HOSTNAME__
13712         - name: interface-name
13713           in: path
13714           description: Name that identifies the link aggregate interface
13715           required: true
13716           type: string
13717           example: __INTERFACE-NAME__
13718         - name: interface-name
13719           in: path
13720           description: Name given to the interface
13721           required: true
13722           type: string
13723           example: __INTERFACE-NAME__
13724         - name: body
13725           in: body
13726           description: l-interface object that needs to be updated.
13727           required: true
13728           schema:
13729             $ref: "#/patchDefinitions/l-interface"
13730     delete:
13731       tags:
13732         - CloudInfrastructure
13733       summary: delete an existing l-interface
13734       description: delete an existing l-interface
13735       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13736       consumes:
13737         - application/json
13738         - application/xml
13739       produces:
13740         - application/json
13741         - application/xml
13742       responses:
13743         "default":
13744           description: Response codes found in [response codes](https://wiki.onap.org/).
13745       parameters:
13746         - name: hostname
13747           in: path
13748           description: Value from executing hostname on the compute node.
13749           required: true
13750           type: string
13751           example: __HOSTNAME__
13752         - name: interface-name
13753           in: path
13754           description: Name that identifies the link aggregate interface
13755           required: true
13756           type: string
13757           example: __INTERFACE-NAME__
13758         - name: interface-name
13759           in: path
13760           description: Name given to the interface
13761           required: true
13762           type: string
13763           example: __INTERFACE-NAME__
13764         - name: resource-version
13765           in: query
13766           description: resource-version for concurrency
13767           required: true
13768           type: string
13769   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
13770     get:
13771       tags:
13772         - CloudInfrastructure
13773       summary: returns l-interfaces
13774       description: returns l-interfaces
13775       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
13776       produces:
13777         - application/json
13778         - application/xml
13779       responses:
13780         "200":
13781           description: successful operation
13782           schema:
13783               $ref: "#/getDefinitions/l-interfaces"
13784         "default":
13785           description: Response codes found in [response codes](https://wiki.onap.org/).
13786       parameters:
13787         - name: hostname
13788           in: path
13789           description: Value from executing hostname on the compute node.
13790           required: true
13791           type: string
13792           example: __HOSTNAME__
13793         - name: interface-name
13794           in: path
13795           description: Name that identifies the link aggregate interface
13796           required: true
13797           type: string
13798           example: __INTERFACE-NAME__
13799         - name: interface-name
13800           in: query
13801           description:
13802           required: false
13803           type: string
13804         - name: interface-id
13805           in: query
13806           description:
13807           required: false
13808           type: string
13809         - name: macaddr
13810           in: query
13811           description:
13812           required: false
13813           type: string
13814         - name: network-name
13815           in: query
13816           description:
13817           required: false
13818           type: string
13819   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
13820     get:
13821       tags:
13822         - CloudInfrastructure
13823       summary: returns lag-interface
13824       description: returns lag-interface
13825       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
13826       produces:
13827         - application/json
13828         - application/xml
13829       responses:
13830         "200":
13831           description: successful operation
13832           schema:
13833               $ref: "#/getDefinitions/lag-interface"
13834         "default":
13835           description: Response codes found in [response codes](https://wiki.onap.org/).
13836       parameters:
13837         - name: hostname
13838           in: path
13839           description: Value from executing hostname on the compute node.
13840           required: true
13841           type: string
13842           example: __HOSTNAME__
13843         - name: interface-name
13844           in: path
13845           description: Name that identifies the link aggregate interface
13846           required: true
13847           type: string
13848           example: __INTERFACE-NAME__
13849     put:
13850       tags:
13851         - CloudInfrastructure
13852       summary: create or update an existing lag-interface
13853       description: |
13854         Create or update an existing lag-interface.
13855         #
13856         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13857       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13858       consumes:
13859         - application/json
13860         - application/xml
13861       produces:
13862         - application/json
13863         - application/xml
13864       responses:
13865         "default":
13866           description: Response codes found in [response codes](https://wiki.onap.org/).
13867       parameters:
13868         - name: hostname
13869           in: path
13870           description: Value from executing hostname on the compute node.
13871           required: true
13872           type: string
13873           example: __HOSTNAME__
13874         - name: interface-name
13875           in: path
13876           description: Name that identifies the link aggregate interface
13877           required: true
13878           type: string
13879           example: __INTERFACE-NAME__
13880         - name: body
13881           in: body
13882           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
13883           required: true
13884           schema:
13885             $ref: "#/definitions/lag-interface"
13886     patch:
13887       tags:
13888         - CloudInfrastructure
13889       summary: update an existing lag-interface
13890       description: |
13891         Update an existing lag-interface
13892         #
13893         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13894         The PUT operation will entirely replace an existing object.
13895         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13896         #
13897         Other differences between PUT and PATCH are:
13898         #
13899         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13900         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13901         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13902       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13903       consumes:
13904         - application/json
13905         - application/xml
13906       produces:
13907         - application/json
13908         - application/xml
13909       responses:
13910         "default":
13911           description: Response codes found in [response codes](https://wiki.onap.org/).
13912       parameters:
13913         - name: hostname
13914           in: path
13915           description: Value from executing hostname on the compute node.
13916           required: true
13917           type: string
13918           example: __HOSTNAME__
13919         - name: interface-name
13920           in: path
13921           description: Name that identifies the link aggregate interface
13922           required: true
13923           type: string
13924           example: __INTERFACE-NAME__
13925         - name: body
13926           in: body
13927           description: lag-interface object that needs to be updated.
13928           required: true
13929           schema:
13930             $ref: "#/patchDefinitions/lag-interface"
13931     delete:
13932       tags:
13933         - CloudInfrastructure
13934       summary: delete an existing lag-interface
13935       description: delete an existing lag-interface
13936       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
13937       consumes:
13938         - application/json
13939         - application/xml
13940       produces:
13941         - application/json
13942         - application/xml
13943       responses:
13944         "default":
13945           description: Response codes found in [response codes](https://wiki.onap.org/).
13946       parameters:
13947         - name: hostname
13948           in: path
13949           description: Value from executing hostname on the compute node.
13950           required: true
13951           type: string
13952           example: __HOSTNAME__
13953         - name: interface-name
13954           in: path
13955           description: Name that identifies the link aggregate interface
13956           required: true
13957           type: string
13958           example: __INTERFACE-NAME__
13959         - name: resource-version
13960           in: query
13961           description: resource-version for concurrency
13962           required: true
13963           type: string
13964   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
13965     get:
13966       tags:
13967         - CloudInfrastructure
13968       summary: returns lag-interfaces
13969       description: returns lag-interfaces
13970       operationId: getCloudInfrastructurePserversPserverLagInterfaces
13971       produces:
13972         - application/json
13973         - application/xml
13974       responses:
13975         "200":
13976           description: successful operation
13977           schema:
13978               $ref: "#/getDefinitions/lag-interfaces"
13979         "default":
13980           description: Response codes found in [response codes](https://wiki.onap.org/).
13981       parameters:
13982         - name: hostname
13983           in: path
13984           description: Value from executing hostname on the compute node.
13985           required: true
13986           type: string
13987           example: __HOSTNAME__
13988         - name: interface-name
13989           in: query
13990           description:
13991           required: false
13992           type: string
13993         - name: interface-id
13994           in: query
13995           description:
13996           required: false
13997           type: string
13998         - name: interface-role
13999           in: query
14000           description:
14001           required: false
14002           type: string
14003   /cloud-infrastructure/pservers/pserver/{hostname}:
14004     get:
14005       tags:
14006         - CloudInfrastructure
14007       summary: returns pserver
14008       description: returns pserver
14009       operationId: getCloudInfrastructurePserversPserver
14010       produces:
14011         - application/json
14012         - application/xml
14013       responses:
14014         "200":
14015           description: successful operation
14016           schema:
14017               $ref: "#/getDefinitions/pserver"
14018         "default":
14019           description: Response codes found in [response codes](https://wiki.onap.org/).
14020       parameters:
14021         - name: hostname
14022           in: path
14023           description: Value from executing hostname on the compute node.
14024           required: true
14025           type: string
14026           example: __HOSTNAME__
14027     put:
14028       tags:
14029         - CloudInfrastructure
14030       summary: create or update an existing pserver
14031       description: |
14032         Create or update an existing pserver.
14033         #
14034         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14035       operationId: createOrUpdateCloudInfrastructurePserversPserver
14036       consumes:
14037         - application/json
14038         - application/xml
14039       produces:
14040         - application/json
14041         - application/xml
14042       responses:
14043         "default":
14044           description: Response codes found in [response codes](https://wiki.onap.org/).
14045       parameters:
14046         - name: hostname
14047           in: path
14048           description: Value from executing hostname on the compute node.
14049           required: true
14050           type: string
14051           example: __HOSTNAME__
14052         - name: body
14053           in: body
14054           description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json)
14055           required: true
14056           schema:
14057             $ref: "#/definitions/pserver"
14058     patch:
14059       tags:
14060         - CloudInfrastructure
14061       summary: update an existing pserver
14062       description: |
14063         Update an existing pserver
14064         #
14065         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14066         The PUT operation will entirely replace an existing object.
14067         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14068         #
14069         Other differences between PUT and PATCH are:
14070         #
14071         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14072         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14073         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14074       operationId: UpdateCloudInfrastructurePserversPserver
14075       consumes:
14076         - application/json
14077         - application/xml
14078       produces:
14079         - application/json
14080         - application/xml
14081       responses:
14082         "default":
14083           description: Response codes found in [response codes](https://wiki.onap.org/).
14084       parameters:
14085         - name: hostname
14086           in: path
14087           description: Value from executing hostname on the compute node.
14088           required: true
14089           type: string
14090           example: __HOSTNAME__
14091         - name: body
14092           in: body
14093           description: pserver object that needs to be updated.
14094           required: true
14095           schema:
14096             $ref: "#/patchDefinitions/pserver"
14097     delete:
14098       tags:
14099         - CloudInfrastructure
14100       summary: delete an existing pserver
14101       description: delete an existing pserver
14102       operationId: deleteCloudInfrastructurePserversPserver
14103       consumes:
14104         - application/json
14105         - application/xml
14106       produces:
14107         - application/json
14108         - application/xml
14109       responses:
14110         "default":
14111           description: Response codes found in [response codes](https://wiki.onap.org/).
14112       parameters:
14113         - name: hostname
14114           in: path
14115           description: Value from executing hostname on the compute node.
14116           required: true
14117           type: string
14118           example: __HOSTNAME__
14119         - name: resource-version
14120           in: query
14121           description: resource-version for concurrency
14122           required: true
14123           type: string
14124   /cloud-infrastructure/pservers:
14125     get:
14126       tags:
14127         - CloudInfrastructure
14128       summary: returns pservers
14129       description: returns pservers
14130       operationId: getCloudInfrastructurePservers
14131       produces:
14132         - application/json
14133         - application/xml
14134       responses:
14135         "200":
14136           description: successful operation
14137           schema:
14138               $ref: "#/getDefinitions/pservers"
14139         "default":
14140           description: Response codes found in [response codes](https://wiki.onap.org/).
14141       parameters:
14142         - name: hostname
14143           in: query
14144           description:
14145           required: false
14146           type: string
14147         - name: inv-status
14148           in: query
14149           description:
14150           required: false
14151           type: string
14152         - name: pserver-id
14153           in: query
14154           description:
14155           required: false
14156           type: string
14157         - name: in-maint
14158           in: query
14159           description:
14160           required: false
14161           type: boolean
14162         - name: pserver-name2
14163           in: query
14164           description:
14165           required: false
14166           type: string
14167   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
14168     put:
14169       tags:
14170         - CloudInfrastructure
14171       summary: see node definition for valid relationships
14172       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14173       consumes:
14174         - application/json
14175         - application/xml
14176       produces:
14177         - application/json
14178         - application/xml
14179       responses:
14180         "default":
14181           description: Response codes found in [response codes](https://wiki.onap.org/).
14182       parameters:
14183         - name: vdc-id
14184           in: path
14185           description: Unique ID of the vdc
14186           required: true
14187           type: string
14188           example: __VDC-ID__
14189         - name: body
14190           in: body
14191           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14192           required: true
14193           schema:
14194             $ref: "#/definitions/relationship"
14195     delete:
14196       tags:
14197         - CloudInfrastructure
14198       summary: delete an existing relationship
14199       description: delete an existing relationship
14200       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14201       consumes:
14202         - application/json
14203         - application/xml
14204       produces:
14205         - application/json
14206         - application/xml
14207       responses:
14208         "default":
14209           description: Response codes found in [response codes](https://wiki.onap.org/).
14210       parameters:
14211         - name: vdc-id
14212           in: path
14213           description: Unique ID of the vdc
14214           required: true
14215           type: string
14216           example: __VDC-ID__
14217   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
14218     get:
14219       tags:
14220         - CloudInfrastructure
14221       summary: returns virtual-data-center
14222       description: returns virtual-data-center
14223       operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
14224       produces:
14225         - application/json
14226         - application/xml
14227       responses:
14228         "200":
14229           description: successful operation
14230           schema:
14231               $ref: "#/getDefinitions/virtual-data-center"
14232         "default":
14233           description: Response codes found in [response codes](https://wiki.onap.org/).
14234       parameters:
14235         - name: vdc-id
14236           in: path
14237           description: Unique ID of the vdc
14238           required: true
14239           type: string
14240           example: __VDC-ID__
14241     put:
14242       tags:
14243         - CloudInfrastructure
14244       summary: create or update an existing virtual-data-center
14245       description: |
14246         Create or update an existing virtual-data-center.
14247         #
14248         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14249       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14250       consumes:
14251         - application/json
14252         - application/xml
14253       produces:
14254         - application/json
14255         - application/xml
14256       responses:
14257         "default":
14258           description: Response codes found in [response codes](https://wiki.onap.org/).
14259       parameters:
14260         - name: vdc-id
14261           in: path
14262           description: Unique ID of the vdc
14263           required: true
14264           type: string
14265           example: __VDC-ID__
14266         - name: body
14267           in: body
14268           description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14269           required: true
14270           schema:
14271             $ref: "#/definitions/virtual-data-center"
14272     patch:
14273       tags:
14274         - CloudInfrastructure
14275       summary: update an existing virtual-data-center
14276       description: |
14277         Update an existing virtual-data-center
14278         #
14279         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14280         The PUT operation will entirely replace an existing object.
14281         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14282         #
14283         Other differences between PUT and PATCH are:
14284         #
14285         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14286         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14287         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14288       operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14289       consumes:
14290         - application/json
14291         - application/xml
14292       produces:
14293         - application/json
14294         - application/xml
14295       responses:
14296         "default":
14297           description: Response codes found in [response codes](https://wiki.onap.org/).
14298       parameters:
14299         - name: vdc-id
14300           in: path
14301           description: Unique ID of the vdc
14302           required: true
14303           type: string
14304           example: __VDC-ID__
14305         - name: body
14306           in: body
14307           description: virtual-data-center object that needs to be updated.
14308           required: true
14309           schema:
14310             $ref: "#/patchDefinitions/virtual-data-center"
14311     delete:
14312       tags:
14313         - CloudInfrastructure
14314       summary: delete an existing virtual-data-center
14315       description: delete an existing virtual-data-center
14316       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
14317       consumes:
14318         - application/json
14319         - application/xml
14320       produces:
14321         - application/json
14322         - application/xml
14323       responses:
14324         "default":
14325           description: Response codes found in [response codes](https://wiki.onap.org/).
14326       parameters:
14327         - name: vdc-id
14328           in: path
14329           description: Unique ID of the vdc
14330           required: true
14331           type: string
14332           example: __VDC-ID__
14333         - name: resource-version
14334           in: query
14335           description: resource-version for concurrency
14336           required: true
14337           type: string
14338   /cloud-infrastructure/virtual-data-centers:
14339     get:
14340       tags:
14341         - CloudInfrastructure
14342       summary: returns virtual-data-centers
14343       description: returns virtual-data-centers
14344       operationId: getCloudInfrastructureVirtualDataCenters
14345       produces:
14346         - application/json
14347         - application/xml
14348       responses:
14349         "200":
14350           description: successful operation
14351           schema:
14352               $ref: "#/getDefinitions/virtual-data-centers"
14353         "default":
14354           description: Response codes found in [response codes](https://wiki.onap.org/).
14355       parameters:
14356         - name: vdc-id
14357           in: query
14358           description:
14359           required: false
14360           type: string
14361         - name: vdc-name
14362           in: query
14363           description:
14364           required: false
14365           type: string
14366   /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship:
14367     put:
14368       tags:
14369         - CloudInfrastructure
14370       summary: see node definition for valid relationships
14371       operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
14372       consumes:
14373         - application/json
14374         - application/xml
14375       produces:
14376         - application/json
14377         - application/xml
14378       responses:
14379         "default":
14380           description: Response codes found in [response codes](https://wiki.onap.org/).
14381       parameters:
14382         - name: operational-environment-id
14383           in: path
14384           description: UUID of an operational environment
14385           required: true
14386           type: string
14387           example: __OPERATIONAL-ENVIRONMENT-ID__
14388         - name: body
14389           in: body
14390           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
14391           required: true
14392           schema:
14393             $ref: "#/definitions/relationship"
14394     delete:
14395       tags:
14396         - CloudInfrastructure
14397       summary: delete an existing relationship
14398       description: delete an existing relationship
14399       operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
14400       consumes:
14401         - application/json
14402         - application/xml
14403       produces:
14404         - application/json
14405         - application/xml
14406       responses:
14407         "default":
14408           description: Response codes found in [response codes](https://wiki.onap.org/).
14409       parameters:
14410         - name: operational-environment-id
14411           in: path
14412           description: UUID of an operational environment
14413           required: true
14414           type: string
14415           example: __OPERATIONAL-ENVIRONMENT-ID__
14416   /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}:
14417     get:
14418       tags:
14419         - CloudInfrastructure
14420       summary: returns operational-environment
14421       description: returns operational-environment
14422       operationId: getCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14423       produces:
14424         - application/json
14425         - application/xml
14426       responses:
14427         "200":
14428           description: successful operation
14429           schema:
14430               $ref: "#/getDefinitions/operational-environment"
14431         "default":
14432           description: Response codes found in [response codes](https://wiki.onap.org/).
14433       parameters:
14434         - name: operational-environment-id
14435           in: path
14436           description: UUID of an operational environment
14437           required: true
14438           type: string
14439           example: __OPERATIONAL-ENVIRONMENT-ID__
14440     put:
14441       tags:
14442         - CloudInfrastructure
14443       summary: create or update an existing operational-environment
14444       description: |
14445         Create or update an existing operational-environment.
14446         #
14447         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14448       operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14449       consumes:
14450         - application/json
14451         - application/xml
14452       produces:
14453         - application/json
14454         - application/xml
14455       responses:
14456         "default":
14457           description: Response codes found in [response codes](https://wiki.onap.org/).
14458       parameters:
14459         - name: operational-environment-id
14460           in: path
14461           description: UUID of an operational environment
14462           required: true
14463           type: string
14464           example: __OPERATIONAL-ENVIRONMENT-ID__
14465         - name: body
14466           in: body
14467           description: operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
14468           required: true
14469           schema:
14470             $ref: "#/definitions/operational-environment"
14471     patch:
14472       tags:
14473         - CloudInfrastructure
14474       summary: update an existing operational-environment
14475       description: |
14476         Update an existing operational-environment
14477         #
14478         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14479         The PUT operation will entirely replace an existing object.
14480         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14481         #
14482         Other differences between PUT and PATCH are:
14483         #
14484         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14485         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14486         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14487       operationId: UpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14488       consumes:
14489         - application/json
14490         - application/xml
14491       produces:
14492         - application/json
14493         - application/xml
14494       responses:
14495         "default":
14496           description: Response codes found in [response codes](https://wiki.onap.org/).
14497       parameters:
14498         - name: operational-environment-id
14499           in: path
14500           description: UUID of an operational environment
14501           required: true
14502           type: string
14503           example: __OPERATIONAL-ENVIRONMENT-ID__
14504         - name: body
14505           in: body
14506           description: operational-environment object that needs to be updated.
14507           required: true
14508           schema:
14509             $ref: "#/patchDefinitions/operational-environment"
14510     delete:
14511       tags:
14512         - CloudInfrastructure
14513       summary: delete an existing operational-environment
14514       description: delete an existing operational-environment
14515       operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14516       consumes:
14517         - application/json
14518         - application/xml
14519       produces:
14520         - application/json
14521         - application/xml
14522       responses:
14523         "default":
14524           description: Response codes found in [response codes](https://wiki.onap.org/).
14525       parameters:
14526         - name: operational-environment-id
14527           in: path
14528           description: UUID of an operational environment
14529           required: true
14530           type: string
14531           example: __OPERATIONAL-ENVIRONMENT-ID__
14532         - name: resource-version
14533           in: query
14534           description: resource-version for concurrency
14535           required: true
14536           type: string
14537   /cloud-infrastructure/operational-environments:
14538     get:
14539       tags:
14540         - CloudInfrastructure
14541       summary: returns operational-environments
14542       description: returns operational-environments
14543       operationId: getCloudInfrastructureOperationalEnvironments
14544       produces:
14545         - application/json
14546         - application/xml
14547       responses:
14548         "200":
14549           description: successful operation
14550           schema:
14551               $ref: "#/getDefinitions/operational-environments"
14552         "default":
14553           description: Response codes found in [response codes](https://wiki.onap.org/).
14554       parameters:
14555         - name: operational-environment-id
14556           in: query
14557           description:
14558           required: false
14559           type: string
14560   /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
14561     put:
14562       tags:
14563         - Business
14564       summary: see node definition for valid relationships
14565       operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
14566       consumes:
14567         - application/json
14568         - application/xml
14569       produces:
14570         - application/json
14571         - application/xml
14572       responses:
14573         "default":
14574           description: Response codes found in [response codes](https://wiki.onap.org/).
14575       parameters:
14576         - name: resource-instance-id
14577           in: path
14578           description: Unique id of resource instance.
14579           required: true
14580           type: string
14581           example: __RESOURCE-INSTANCE-ID__
14582         - name: body
14583           in: body
14584           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json)
14585           required: true
14586           schema:
14587             $ref: "#/definitions/relationship"
14588     delete:
14589       tags:
14590         - Business
14591       summary: delete an existing relationship
14592       description: delete an existing relationship
14593       operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
14594       consumes:
14595         - application/json
14596         - application/xml
14597       produces:
14598         - application/json
14599         - application/xml
14600       responses:
14601         "default":
14602           description: Response codes found in [response codes](https://wiki.onap.org/).
14603       parameters:
14604         - name: resource-instance-id
14605           in: path
14606           description: Unique id of resource instance.
14607           required: true
14608           type: string
14609           example: __RESOURCE-INSTANCE-ID__
14610   /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
14611     get:
14612       tags:
14613         - Business
14614       summary: returns metadatum
14615       description: returns metadatum
14616       operationId: getBusinessConnectorsConnectorMetadataMetadatum
14617       produces:
14618         - application/json
14619         - application/xml
14620       responses:
14621         "200":
14622           description: successful operation
14623           schema:
14624               $ref: "#/getDefinitions/metadatum"
14625         "default":
14626           description: Response codes found in [response codes](https://wiki.onap.org/).
14627       parameters:
14628         - name: resource-instance-id
14629           in: path
14630           description: Unique id of resource instance.
14631           required: true
14632           type: string
14633           example: __RESOURCE-INSTANCE-ID__
14634         - name: metaname
14635           in: path
14636           required: true
14637           type: string
14638           example: __METANAME__
14639     put:
14640       tags:
14641         - Business
14642       summary: create or update an existing metadatum
14643       description: |
14644         Create or update an existing metadatum.
14645         #
14646         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14647       operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
14648       consumes:
14649         - application/json
14650         - application/xml
14651       produces:
14652         - application/json
14653         - application/xml
14654       responses:
14655         "default":
14656           description: Response codes found in [response codes](https://wiki.onap.org/).
14657       parameters:
14658         - name: resource-instance-id
14659           in: path
14660           description: Unique id of resource instance.
14661           required: true
14662           type: string
14663           example: __RESOURCE-INSTANCE-ID__
14664         - name: metaname
14665           in: path
14666           required: true
14667           type: string
14668           example: __METANAME__
14669         - name: body
14670           in: body
14671           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnectorMetadataMetadatum.json)
14672           required: true
14673           schema:
14674             $ref: "#/definitions/metadatum"
14675     patch:
14676       tags:
14677         - Business
14678       summary: update an existing metadatum
14679       description: |
14680         Update an existing metadatum
14681         #
14682         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14683         The PUT operation will entirely replace an existing object.
14684         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14685         #
14686         Other differences between PUT and PATCH are:
14687         #
14688         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14689         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14690         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14691       operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
14692       consumes:
14693         - application/json
14694         - application/xml
14695       produces:
14696         - application/json
14697         - application/xml
14698       responses:
14699         "default":
14700           description: Response codes found in [response codes](https://wiki.onap.org/).
14701       parameters:
14702         - name: resource-instance-id
14703           in: path
14704           description: Unique id of resource instance.
14705           required: true
14706           type: string
14707           example: __RESOURCE-INSTANCE-ID__
14708         - name: metaname
14709           in: path
14710           required: true
14711           type: string
14712           example: __METANAME__
14713         - name: body
14714           in: body
14715           description: metadatum object that needs to be updated.
14716           required: true
14717           schema:
14718             $ref: "#/patchDefinitions/metadatum"
14719     delete:
14720       tags:
14721         - Business
14722       summary: delete an existing metadatum
14723       description: delete an existing metadatum
14724       operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
14725       consumes:
14726         - application/json
14727         - application/xml
14728       produces:
14729         - application/json
14730         - application/xml
14731       responses:
14732         "default":
14733           description: Response codes found in [response codes](https://wiki.onap.org/).
14734       parameters:
14735         - name: resource-instance-id
14736           in: path
14737           description: Unique id of resource instance.
14738           required: true
14739           type: string
14740           example: __RESOURCE-INSTANCE-ID__
14741         - name: metaname
14742           in: path
14743           required: true
14744           type: string
14745           example: __METANAME__
14746         - name: resource-version
14747           in: query
14748           description: resource-version for concurrency
14749           required: true
14750           type: string
14751   /business/connectors/connector/{resource-instance-id}/metadata:
14752     get:
14753       tags:
14754         - Business
14755       summary: returns metadata
14756       description: returns metadata
14757       operationId: getBusinessConnectorsConnectorMetadata
14758       produces:
14759         - application/json
14760         - application/xml
14761       responses:
14762         "200":
14763           description: successful operation
14764           schema:
14765               $ref: "#/getDefinitions/metadata"
14766         "default":
14767           description: Response codes found in [response codes](https://wiki.onap.org/).
14768       parameters:
14769         - name: resource-instance-id
14770           in: path
14771           description: Unique id of resource instance.
14772           required: true
14773           type: string
14774           example: __RESOURCE-INSTANCE-ID__
14775         - name: metaname
14776           in: query
14777           description:
14778           required: false
14779           type: string
14780   /business/connectors/connector/{resource-instance-id}:
14781     get:
14782       tags:
14783         - Business
14784       summary: returns connector
14785       description: returns connector
14786       operationId: getBusinessConnectorsConnector
14787       produces:
14788         - application/json
14789         - application/xml
14790       responses:
14791         "200":
14792           description: successful operation
14793           schema:
14794               $ref: "#/getDefinitions/connector"
14795         "default":
14796           description: Response codes found in [response codes](https://wiki.onap.org/).
14797       parameters:
14798         - name: resource-instance-id
14799           in: path
14800           description: Unique id of resource instance.
14801           required: true
14802           type: string
14803           example: __RESOURCE-INSTANCE-ID__
14804     put:
14805       tags:
14806         - Business
14807       summary: create or update an existing connector
14808       description: |
14809         Create or update an existing connector.
14810         #
14811         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14812       operationId: createOrUpdateBusinessConnectorsConnector
14813       consumes:
14814         - application/json
14815         - application/xml
14816       produces:
14817         - application/json
14818         - application/xml
14819       responses:
14820         "default":
14821           description: Response codes found in [response codes](https://wiki.onap.org/).
14822       parameters:
14823         - name: resource-instance-id
14824           in: path
14825           description: Unique id of resource instance.
14826           required: true
14827           type: string
14828           example: __RESOURCE-INSTANCE-ID__
14829         - name: body
14830           in: body
14831           description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json)
14832           required: true
14833           schema:
14834             $ref: "#/definitions/connector"
14835     patch:
14836       tags:
14837         - Business
14838       summary: update an existing connector
14839       description: |
14840         Update an existing connector
14841         #
14842         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14843         The PUT operation will entirely replace an existing object.
14844         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14845         #
14846         Other differences between PUT and PATCH are:
14847         #
14848         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14849         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14850         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14851       operationId: UpdateBusinessConnectorsConnector
14852       consumes:
14853         - application/json
14854         - application/xml
14855       produces:
14856         - application/json
14857         - application/xml
14858       responses:
14859         "default":
14860           description: Response codes found in [response codes](https://wiki.onap.org/).
14861       parameters:
14862         - name: resource-instance-id
14863           in: path
14864           description: Unique id of resource instance.
14865           required: true
14866           type: string
14867           example: __RESOURCE-INSTANCE-ID__
14868         - name: body
14869           in: body
14870           description: connector object that needs to be updated.
14871           required: true
14872           schema:
14873             $ref: "#/patchDefinitions/connector"
14874     delete:
14875       tags:
14876         - Business
14877       summary: delete an existing connector
14878       description: delete an existing connector
14879       operationId: deleteBusinessConnectorsConnector
14880       consumes:
14881         - application/json
14882         - application/xml
14883       produces:
14884         - application/json
14885         - application/xml
14886       responses:
14887         "default":
14888           description: Response codes found in [response codes](https://wiki.onap.org/).
14889       parameters:
14890         - name: resource-instance-id
14891           in: path
14892           description: Unique id of resource instance.
14893           required: true
14894           type: string
14895           example: __RESOURCE-INSTANCE-ID__
14896         - name: resource-version
14897           in: query
14898           description: resource-version for concurrency
14899           required: true
14900           type: string
14901   /business/connectors:
14902     get:
14903       tags:
14904         - Business
14905       summary: returns connectors
14906       description: returns connectors
14907       operationId: getBusinessConnectors
14908       produces:
14909         - application/json
14910         - application/xml
14911       responses:
14912         "200":
14913           description: successful operation
14914           schema:
14915               $ref: "#/getDefinitions/connectors"
14916         "default":
14917           description: Response codes found in [response codes](https://wiki.onap.org/).
14918       parameters:
14919         - name: resource-instance-id
14920           in: query
14921           description:
14922           required: false
14923           type: string
14924         - name: model-invariant-id
14925           in: query
14926           description:
14927           required: false
14928           type: string
14929         - name: model-version-id
14930           in: query
14931           description:
14932           required: false
14933           type: string
14934         - name: widget-model-id
14935           in: query
14936           description:
14937           required: false
14938           type: string
14939         - name: widget-model-version
14940           in: query
14941           description:
14942           required: false
14943           type: string
14944   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
14945     put:
14946       tags:
14947         - Business
14948       summary: see node definition for valid relationships
14949       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14950       consumes:
14951         - application/json
14952         - application/xml
14953       produces:
14954         - application/json
14955         - application/xml
14956       responses:
14957         "default":
14958           description: Response codes found in [response codes](https://wiki.onap.org/).
14959       parameters:
14960         - name: global-customer-id
14961           in: path
14962           description: Global customer id used across ECOMP to uniquely identify customer.
14963           required: true
14964           type: string
14965           example: __GLOBAL-CUSTOMER-ID__
14966         - name: service-type
14967           in: path
14968           description: Value defined by orchestration to identify this service across ECOMP.
14969           required: true
14970           type: string
14971           example: __SERVICE-TYPE__
14972         - name: service-instance-id
14973           in: path
14974           description: Uniquely identifies this instance of a service
14975           required: true
14976           type: string
14977           example: __SERVICE-INSTANCE-ID__
14978         - name: body
14979           in: body
14980           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
14981           required: true
14982           schema:
14983             $ref: "#/definitions/relationship"
14984     delete:
14985       tags:
14986         - Business
14987       summary: delete an existing relationship
14988       description: delete an existing relationship
14989       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14990       consumes:
14991         - application/json
14992         - application/xml
14993       produces:
14994         - application/json
14995         - application/xml
14996       responses:
14997         "default":
14998           description: Response codes found in [response codes](https://wiki.onap.org/).
14999       parameters:
15000         - name: global-customer-id
15001           in: path
15002           description: Global customer id used across ECOMP to uniquely identify customer.
15003           required: true
15004           type: string
15005           example: __GLOBAL-CUSTOMER-ID__
15006         - name: service-type
15007           in: path
15008           description: Value defined by orchestration to identify this service across ECOMP.
15009           required: true
15010           type: string
15011           example: __SERVICE-TYPE__
15012         - name: service-instance-id
15013           in: path
15014           description: Uniquely identifies this instance of a service
15015           required: true
15016           type: string
15017           example: __SERVICE-INSTANCE-ID__
15018   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
15019     get:
15020       tags:
15021         - Business
15022       summary: returns metadatum
15023       description: returns metadatum
15024       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15025       produces:
15026         - application/json
15027         - application/xml
15028       responses:
15029         "200":
15030           description: successful operation
15031           schema:
15032               $ref: "#/getDefinitions/metadatum"
15033         "default":
15034           description: Response codes found in [response codes](https://wiki.onap.org/).
15035       parameters:
15036         - name: global-customer-id
15037           in: path
15038           description: Global customer id used across ECOMP to uniquely identify customer.
15039           required: true
15040           type: string
15041           example: __GLOBAL-CUSTOMER-ID__
15042         - name: service-type
15043           in: path
15044           description: Value defined by orchestration to identify this service across ECOMP.
15045           required: true
15046           type: string
15047           example: __SERVICE-TYPE__
15048         - name: service-instance-id
15049           in: path
15050           description: Uniquely identifies this instance of a service
15051           required: true
15052           type: string
15053           example: __SERVICE-INSTANCE-ID__
15054         - name: metaname
15055           in: path
15056           required: true
15057           type: string
15058           example: __METANAME__
15059     put:
15060       tags:
15061         - Business
15062       summary: create or update an existing metadatum
15063       description: |
15064         Create or update an existing metadatum.
15065         #
15066         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15067       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15068       consumes:
15069         - application/json
15070         - application/xml
15071       produces:
15072         - application/json
15073         - application/xml
15074       responses:
15075         "default":
15076           description: Response codes found in [response codes](https://wiki.onap.org/).
15077       parameters:
15078         - name: global-customer-id
15079           in: path
15080           description: Global customer id used across ECOMP to uniquely identify customer.
15081           required: true
15082           type: string
15083           example: __GLOBAL-CUSTOMER-ID__
15084         - name: service-type
15085           in: path
15086           description: Value defined by orchestration to identify this service across ECOMP.
15087           required: true
15088           type: string
15089           example: __SERVICE-TYPE__
15090         - name: service-instance-id
15091           in: path
15092           description: Uniquely identifies this instance of a service
15093           required: true
15094           type: string
15095           example: __SERVICE-INSTANCE-ID__
15096         - name: metaname
15097           in: path
15098           required: true
15099           type: string
15100           example: __METANAME__
15101         - name: body
15102           in: body
15103           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
15104           required: true
15105           schema:
15106             $ref: "#/definitions/metadatum"
15107     patch:
15108       tags:
15109         - Business
15110       summary: update an existing metadatum
15111       description: |
15112         Update an existing metadatum
15113         #
15114         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15115         The PUT operation will entirely replace an existing object.
15116         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15117         #
15118         Other differences between PUT and PATCH are:
15119         #
15120         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15121         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15122         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15123       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15124       consumes:
15125         - application/json
15126         - application/xml
15127       produces:
15128         - application/json
15129         - application/xml
15130       responses:
15131         "default":
15132           description: Response codes found in [response codes](https://wiki.onap.org/).
15133       parameters:
15134         - name: global-customer-id
15135           in: path
15136           description: Global customer id used across ECOMP to uniquely identify customer.
15137           required: true
15138           type: string
15139           example: __GLOBAL-CUSTOMER-ID__
15140         - name: service-type
15141           in: path
15142           description: Value defined by orchestration to identify this service across ECOMP.
15143           required: true
15144           type: string
15145           example: __SERVICE-TYPE__
15146         - name: service-instance-id
15147           in: path
15148           description: Uniquely identifies this instance of a service
15149           required: true
15150           type: string
15151           example: __SERVICE-INSTANCE-ID__
15152         - name: metaname
15153           in: path
15154           required: true
15155           type: string
15156           example: __METANAME__
15157         - name: body
15158           in: body
15159           description: metadatum object that needs to be updated.
15160           required: true
15161           schema:
15162             $ref: "#/patchDefinitions/metadatum"
15163     delete:
15164       tags:
15165         - Business
15166       summary: delete an existing metadatum
15167       description: delete an existing metadatum
15168       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15169       consumes:
15170         - application/json
15171         - application/xml
15172       produces:
15173         - application/json
15174         - application/xml
15175       responses:
15176         "default":
15177           description: Response codes found in [response codes](https://wiki.onap.org/).
15178       parameters:
15179         - name: global-customer-id
15180           in: path
15181           description: Global customer id used across ECOMP to uniquely identify customer.
15182           required: true
15183           type: string
15184           example: __GLOBAL-CUSTOMER-ID__
15185         - name: service-type
15186           in: path
15187           description: Value defined by orchestration to identify this service across ECOMP.
15188           required: true
15189           type: string
15190           example: __SERVICE-TYPE__
15191         - name: service-instance-id
15192           in: path
15193           description: Uniquely identifies this instance of a service
15194           required: true
15195           type: string
15196           example: __SERVICE-INSTANCE-ID__
15197         - name: metaname
15198           in: path
15199           required: true
15200           type: string
15201           example: __METANAME__
15202         - name: resource-version
15203           in: query
15204           description: resource-version for concurrency
15205           required: true
15206           type: string
15207   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
15208     get:
15209       tags:
15210         - Business
15211       summary: returns metadata
15212       description: returns metadata
15213       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
15214       produces:
15215         - application/json
15216         - application/xml
15217       responses:
15218         "200":
15219           description: successful operation
15220           schema:
15221               $ref: "#/getDefinitions/metadata"
15222         "default":
15223           description: Response codes found in [response codes](https://wiki.onap.org/).
15224       parameters:
15225         - name: global-customer-id
15226           in: path
15227           description: Global customer id used across ECOMP to uniquely identify customer.
15228           required: true
15229           type: string
15230           example: __GLOBAL-CUSTOMER-ID__
15231         - name: service-type
15232           in: path
15233           description: Value defined by orchestration to identify this service across ECOMP.
15234           required: true
15235           type: string
15236           example: __SERVICE-TYPE__
15237         - name: service-instance-id
15238           in: path
15239           description: Uniquely identifies this instance of a service
15240           required: true
15241           type: string
15242           example: __SERVICE-INSTANCE-ID__
15243         - name: metaname
15244           in: query
15245           description:
15246           required: false
15247           type: string
15248   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship:
15249     put:
15250       tags:
15251         - Business
15252       summary: see node definition for valid relationships
15253       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15254       consumes:
15255         - application/json
15256         - application/xml
15257       produces:
15258         - application/json
15259         - application/xml
15260       responses:
15261         "default":
15262           description: Response codes found in [response codes](https://wiki.onap.org/).
15263       parameters:
15264         - name: global-customer-id
15265           in: path
15266           description: Global customer id used across ECOMP to uniquely identify customer.
15267           required: true
15268           type: string
15269           example: __GLOBAL-CUSTOMER-ID__
15270         - name: service-type
15271           in: path
15272           description: Value defined by orchestration to identify this service across ECOMP.
15273           required: true
15274           type: string
15275           example: __SERVICE-TYPE__
15276         - name: service-instance-id
15277           in: path
15278           description: Uniquely identifies this instance of a service
15279           required: true
15280           type: string
15281           example: __SERVICE-INSTANCE-ID__
15282         - name: id
15283           in: path
15284           description: Allotted Resource id UUID assigned to this instance.
15285           required: true
15286           type: string
15287           example: __ID__
15288         - name: id
15289           in: path
15290           description: Allotted Resource id UUID assigned to this instance.
15291           required: true
15292           type: string
15293           example: __ID__
15294         - name: body
15295           in: body
15296           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15297           required: true
15298           schema:
15299             $ref: "#/definitions/relationship"
15300     delete:
15301       tags:
15302         - Business
15303       summary: delete an existing relationship
15304       description: delete an existing relationship
15305       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15306       consumes:
15307         - application/json
15308         - application/xml
15309       produces:
15310         - application/json
15311         - application/xml
15312       responses:
15313         "default":
15314           description: Response codes found in [response codes](https://wiki.onap.org/).
15315       parameters:
15316         - name: global-customer-id
15317           in: path
15318           description: Global customer id used across ECOMP to uniquely identify customer.
15319           required: true
15320           type: string
15321           example: __GLOBAL-CUSTOMER-ID__
15322         - name: service-type
15323           in: path
15324           description: Value defined by orchestration to identify this service across ECOMP.
15325           required: true
15326           type: string
15327           example: __SERVICE-TYPE__
15328         - name: service-instance-id
15329           in: path
15330           description: Uniquely identifies this instance of a service
15331           required: true
15332           type: string
15333           example: __SERVICE-INSTANCE-ID__
15334         - name: id
15335           in: path
15336           description: Allotted Resource id UUID assigned to this instance.
15337           required: true
15338           type: string
15339           example: __ID__
15340         - name: id
15341           in: path
15342           description: Allotted Resource id UUID assigned to this instance.
15343           required: true
15344           type: string
15345           example: __ID__
15346   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}:
15347     get:
15348       tags:
15349         - Business
15350       summary: returns tunnel-xconnect
15351       description: returns tunnel-xconnect
15352       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15353       produces:
15354         - application/json
15355         - application/xml
15356       responses:
15357         "200":
15358           description: successful operation
15359           schema:
15360               $ref: "#/getDefinitions/tunnel-xconnect"
15361         "default":
15362           description: Response codes found in [response codes](https://wiki.onap.org/).
15363       parameters:
15364         - name: global-customer-id
15365           in: path
15366           description: Global customer id used across ECOMP to uniquely identify customer.
15367           required: true
15368           type: string
15369           example: __GLOBAL-CUSTOMER-ID__
15370         - name: service-type
15371           in: path
15372           description: Value defined by orchestration to identify this service across ECOMP.
15373           required: true
15374           type: string
15375           example: __SERVICE-TYPE__
15376         - name: service-instance-id
15377           in: path
15378           description: Uniquely identifies this instance of a service
15379           required: true
15380           type: string
15381           example: __SERVICE-INSTANCE-ID__
15382         - name: id
15383           in: path
15384           description: Allotted Resource id UUID assigned to this instance.
15385           required: true
15386           type: string
15387           example: __ID__
15388         - name: id
15389           in: path
15390           description: Allotted Resource id UUID assigned to this instance.
15391           required: true
15392           type: string
15393           example: __ID__
15394     put:
15395       tags:
15396         - Business
15397       summary: create or update an existing tunnel-xconnect
15398       description: |
15399         Create or update an existing tunnel-xconnect.
15400         #
15401         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15402       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15403       consumes:
15404         - application/json
15405         - application/xml
15406       produces:
15407         - application/json
15408         - application/xml
15409       responses:
15410         "default":
15411           description: Response codes found in [response codes](https://wiki.onap.org/).
15412       parameters:
15413         - name: global-customer-id
15414           in: path
15415           description: Global customer id used across ECOMP to uniquely identify customer.
15416           required: true
15417           type: string
15418           example: __GLOBAL-CUSTOMER-ID__
15419         - name: service-type
15420           in: path
15421           description: Value defined by orchestration to identify this service across ECOMP.
15422           required: true
15423           type: string
15424           example: __SERVICE-TYPE__
15425         - name: service-instance-id
15426           in: path
15427           description: Uniquely identifies this instance of a service
15428           required: true
15429           type: string
15430           example: __SERVICE-INSTANCE-ID__
15431         - name: id
15432           in: path
15433           description: Allotted Resource id UUID assigned to this instance.
15434           required: true
15435           type: string
15436           example: __ID__
15437         - name: id
15438           in: path
15439           description: Allotted Resource id UUID assigned to this instance.
15440           required: true
15441           type: string
15442           example: __ID__
15443         - name: body
15444           in: body
15445           description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15446           required: true
15447           schema:
15448             $ref: "#/definitions/tunnel-xconnect"
15449     patch:
15450       tags:
15451         - Business
15452       summary: update an existing tunnel-xconnect
15453       description: |
15454         Update an existing tunnel-xconnect
15455         #
15456         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15457         The PUT operation will entirely replace an existing object.
15458         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15459         #
15460         Other differences between PUT and PATCH are:
15461         #
15462         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15463         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15464         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15465       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15466       consumes:
15467         - application/json
15468         - application/xml
15469       produces:
15470         - application/json
15471         - application/xml
15472       responses:
15473         "default":
15474           description: Response codes found in [response codes](https://wiki.onap.org/).
15475       parameters:
15476         - name: global-customer-id
15477           in: path
15478           description: Global customer id used across ECOMP to uniquely identify customer.
15479           required: true
15480           type: string
15481           example: __GLOBAL-CUSTOMER-ID__
15482         - name: service-type
15483           in: path
15484           description: Value defined by orchestration to identify this service across ECOMP.
15485           required: true
15486           type: string
15487           example: __SERVICE-TYPE__
15488         - name: service-instance-id
15489           in: path
15490           description: Uniquely identifies this instance of a service
15491           required: true
15492           type: string
15493           example: __SERVICE-INSTANCE-ID__
15494         - name: id
15495           in: path
15496           description: Allotted Resource id UUID assigned to this instance.
15497           required: true
15498           type: string
15499           example: __ID__
15500         - name: id
15501           in: path
15502           description: Allotted Resource id UUID assigned to this instance.
15503           required: true
15504           type: string
15505           example: __ID__
15506         - name: body
15507           in: body
15508           description: tunnel-xconnect object that needs to be updated.
15509           required: true
15510           schema:
15511             $ref: "#/patchDefinitions/tunnel-xconnect"
15512     delete:
15513       tags:
15514         - Business
15515       summary: delete an existing tunnel-xconnect
15516       description: delete an existing tunnel-xconnect
15517       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15518       consumes:
15519         - application/json
15520         - application/xml
15521       produces:
15522         - application/json
15523         - application/xml
15524       responses:
15525         "default":
15526           description: Response codes found in [response codes](https://wiki.onap.org/).
15527       parameters:
15528         - name: global-customer-id
15529           in: path
15530           description: Global customer id used across ECOMP to uniquely identify customer.
15531           required: true
15532           type: string
15533           example: __GLOBAL-CUSTOMER-ID__
15534         - name: service-type
15535           in: path
15536           description: Value defined by orchestration to identify this service across ECOMP.
15537           required: true
15538           type: string
15539           example: __SERVICE-TYPE__
15540         - name: service-instance-id
15541           in: path
15542           description: Uniquely identifies this instance of a service
15543           required: true
15544           type: string
15545           example: __SERVICE-INSTANCE-ID__
15546         - name: id
15547           in: path
15548           description: Allotted Resource id UUID assigned to this instance.
15549           required: true
15550           type: string
15551           example: __ID__
15552         - name: id
15553           in: path
15554           description: Allotted Resource id UUID assigned to this instance.
15555           required: true
15556           type: string
15557           example: __ID__
15558         - name: resource-version
15559           in: query
15560           description: resource-version for concurrency
15561           required: true
15562           type: string
15563   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects:
15564     get:
15565       tags:
15566         - Business
15567       summary: returns tunnel-xconnects
15568       description: returns tunnel-xconnects
15569       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
15570       produces:
15571         - application/json
15572         - application/xml
15573       responses:
15574         "200":
15575           description: successful operation
15576           schema:
15577               $ref: "#/getDefinitions/tunnel-xconnects"
15578         "default":
15579           description: Response codes found in [response codes](https://wiki.onap.org/).
15580       parameters:
15581         - name: global-customer-id
15582           in: path
15583           description: Global customer id used across ECOMP to uniquely identify customer.
15584           required: true
15585           type: string
15586           example: __GLOBAL-CUSTOMER-ID__
15587         - name: service-type
15588           in: path
15589           description: Value defined by orchestration to identify this service across ECOMP.
15590           required: true
15591           type: string
15592           example: __SERVICE-TYPE__
15593         - name: service-instance-id
15594           in: path
15595           description: Uniquely identifies this instance of a service
15596           required: true
15597           type: string
15598           example: __SERVICE-INSTANCE-ID__
15599         - name: id
15600           in: path
15601           description: Allotted Resource id UUID assigned to this instance.
15602           required: true
15603           type: string
15604           example: __ID__
15605         - name: id
15606           in: query
15607           description:
15608           required: false
15609           type: string
15610   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship:
15611     put:
15612       tags:
15613         - Business
15614       summary: see node definition for valid relationships
15615       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15616       consumes:
15617         - application/json
15618         - application/xml
15619       produces:
15620         - application/json
15621         - application/xml
15622       responses:
15623         "default":
15624           description: Response codes found in [response codes](https://wiki.onap.org/).
15625       parameters:
15626         - name: global-customer-id
15627           in: path
15628           description: Global customer id used across ECOMP to uniquely identify customer.
15629           required: true
15630           type: string
15631           example: __GLOBAL-CUSTOMER-ID__
15632         - name: service-type
15633           in: path
15634           description: Value defined by orchestration to identify this service across ECOMP.
15635           required: true
15636           type: string
15637           example: __SERVICE-TYPE__
15638         - name: service-instance-id
15639           in: path
15640           description: Uniquely identifies this instance of a service
15641           required: true
15642           type: string
15643           example: __SERVICE-INSTANCE-ID__
15644         - name: id
15645           in: path
15646           description: Allotted Resource id UUID assigned to this instance.
15647           required: true
15648           type: string
15649           example: __ID__
15650         - name: body
15651           in: body
15652           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
15653           required: true
15654           schema:
15655             $ref: "#/definitions/relationship"
15656     delete:
15657       tags:
15658         - Business
15659       summary: delete an existing relationship
15660       description: delete an existing relationship
15661       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15662       consumes:
15663         - application/json
15664         - application/xml
15665       produces:
15666         - application/json
15667         - application/xml
15668       responses:
15669         "default":
15670           description: Response codes found in [response codes](https://wiki.onap.org/).
15671       parameters:
15672         - name: global-customer-id
15673           in: path
15674           description: Global customer id used across ECOMP to uniquely identify customer.
15675           required: true
15676           type: string
15677           example: __GLOBAL-CUSTOMER-ID__
15678         - name: service-type
15679           in: path
15680           description: Value defined by orchestration to identify this service across ECOMP.
15681           required: true
15682           type: string
15683           example: __SERVICE-TYPE__
15684         - name: service-instance-id
15685           in: path
15686           description: Uniquely identifies this instance of a service
15687           required: true
15688           type: string
15689           example: __SERVICE-INSTANCE-ID__
15690         - name: id
15691           in: path
15692           description: Allotted Resource id UUID assigned to this instance.
15693           required: true
15694           type: string
15695           example: __ID__
15696   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
15697     get:
15698       tags:
15699         - Business
15700       summary: returns allotted-resource
15701       description: returns allotted-resource
15702       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15703       produces:
15704         - application/json
15705         - application/xml
15706       responses:
15707         "200":
15708           description: successful operation
15709           schema:
15710               $ref: "#/getDefinitions/allotted-resource"
15711         "default":
15712           description: Response codes found in [response codes](https://wiki.onap.org/).
15713       parameters:
15714         - name: global-customer-id
15715           in: path
15716           description: Global customer id used across ECOMP to uniquely identify customer.
15717           required: true
15718           type: string
15719           example: __GLOBAL-CUSTOMER-ID__
15720         - name: service-type
15721           in: path
15722           description: Value defined by orchestration to identify this service across ECOMP.
15723           required: true
15724           type: string
15725           example: __SERVICE-TYPE__
15726         - name: service-instance-id
15727           in: path
15728           description: Uniquely identifies this instance of a service
15729           required: true
15730           type: string
15731           example: __SERVICE-INSTANCE-ID__
15732         - name: id
15733           in: path
15734           description: Allotted Resource id UUID assigned to this instance.
15735           required: true
15736           type: string
15737           example: __ID__
15738     put:
15739       tags:
15740         - Business
15741       summary: create or update an existing allotted-resource
15742       description: |
15743         Create or update an existing allotted-resource.
15744         #
15745         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15746       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15747       consumes:
15748         - application/json
15749         - application/xml
15750       produces:
15751         - application/json
15752         - application/xml
15753       responses:
15754         "default":
15755           description: Response codes found in [response codes](https://wiki.onap.org/).
15756       parameters:
15757         - name: global-customer-id
15758           in: path
15759           description: Global customer id used across ECOMP to uniquely identify customer.
15760           required: true
15761           type: string
15762           example: __GLOBAL-CUSTOMER-ID__
15763         - name: service-type
15764           in: path
15765           description: Value defined by orchestration to identify this service across ECOMP.
15766           required: true
15767           type: string
15768           example: __SERVICE-TYPE__
15769         - name: service-instance-id
15770           in: path
15771           description: Uniquely identifies this instance of a service
15772           required: true
15773           type: string
15774           example: __SERVICE-INSTANCE-ID__
15775         - name: id
15776           in: path
15777           description: Allotted Resource id UUID assigned to this instance.
15778           required: true
15779           type: string
15780           example: __ID__
15781         - name: body
15782           in: body
15783           description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
15784           required: true
15785           schema:
15786             $ref: "#/definitions/allotted-resource"
15787     patch:
15788       tags:
15789         - Business
15790       summary: update an existing allotted-resource
15791       description: |
15792         Update an existing allotted-resource
15793         #
15794         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15795         The PUT operation will entirely replace an existing object.
15796         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15797         #
15798         Other differences between PUT and PATCH are:
15799         #
15800         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15801         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15802         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15803       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15804       consumes:
15805         - application/json
15806         - application/xml
15807       produces:
15808         - application/json
15809         - application/xml
15810       responses:
15811         "default":
15812           description: Response codes found in [response codes](https://wiki.onap.org/).
15813       parameters:
15814         - name: global-customer-id
15815           in: path
15816           description: Global customer id used across ECOMP to uniquely identify customer.
15817           required: true
15818           type: string
15819           example: __GLOBAL-CUSTOMER-ID__
15820         - name: service-type
15821           in: path
15822           description: Value defined by orchestration to identify this service across ECOMP.
15823           required: true
15824           type: string
15825           example: __SERVICE-TYPE__
15826         - name: service-instance-id
15827           in: path
15828           description: Uniquely identifies this instance of a service
15829           required: true
15830           type: string
15831           example: __SERVICE-INSTANCE-ID__
15832         - name: id
15833           in: path
15834           description: Allotted Resource id UUID assigned to this instance.
15835           required: true
15836           type: string
15837           example: __ID__
15838         - name: body
15839           in: body
15840           description: allotted-resource object that needs to be updated.
15841           required: true
15842           schema:
15843             $ref: "#/patchDefinitions/allotted-resource"
15844     delete:
15845       tags:
15846         - Business
15847       summary: delete an existing allotted-resource
15848       description: delete an existing allotted-resource
15849       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15850       consumes:
15851         - application/json
15852         - application/xml
15853       produces:
15854         - application/json
15855         - application/xml
15856       responses:
15857         "default":
15858           description: Response codes found in [response codes](https://wiki.onap.org/).
15859       parameters:
15860         - name: global-customer-id
15861           in: path
15862           description: Global customer id used across ECOMP to uniquely identify customer.
15863           required: true
15864           type: string
15865           example: __GLOBAL-CUSTOMER-ID__
15866         - name: service-type
15867           in: path
15868           description: Value defined by orchestration to identify this service across ECOMP.
15869           required: true
15870           type: string
15871           example: __SERVICE-TYPE__
15872         - name: service-instance-id
15873           in: path
15874           description: Uniquely identifies this instance of a service
15875           required: true
15876           type: string
15877           example: __SERVICE-INSTANCE-ID__
15878         - name: id
15879           in: path
15880           description: Allotted Resource id UUID assigned to this instance.
15881           required: true
15882           type: string
15883           example: __ID__
15884         - name: resource-version
15885           in: query
15886           description: resource-version for concurrency
15887           required: true
15888           type: string
15889   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
15890     get:
15891       tags:
15892         - Business
15893       summary: returns allotted-resources
15894       description: returns allotted-resources
15895       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
15896       produces:
15897         - application/json
15898         - application/xml
15899       responses:
15900         "200":
15901           description: successful operation
15902           schema:
15903               $ref: "#/getDefinitions/allotted-resources"
15904         "default":
15905           description: Response codes found in [response codes](https://wiki.onap.org/).
15906       parameters:
15907         - name: global-customer-id
15908           in: path
15909           description: Global customer id used across ECOMP to uniquely identify customer.
15910           required: true
15911           type: string
15912           example: __GLOBAL-CUSTOMER-ID__
15913         - name: service-type
15914           in: path
15915           description: Value defined by orchestration to identify this service across ECOMP.
15916           required: true
15917           type: string
15918           example: __SERVICE-TYPE__
15919         - name: service-instance-id
15920           in: path
15921           description: Uniquely identifies this instance of a service
15922           required: true
15923           type: string
15924           example: __SERVICE-INSTANCE-ID__
15925         - name: id
15926           in: query
15927           description:
15928           required: false
15929           type: string
15930         - name: model-invariant-id
15931           in: query
15932           description:
15933           required: false
15934           type: string
15935         - name: model-version-id
15936           in: query
15937           description:
15938           required: false
15939           type: string
15940         - name: type
15941           in: query
15942           description:
15943           required: false
15944           type: string
15945         - name: role
15946           in: query
15947           description:
15948           required: false
15949           type: string
15950   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
15951     get:
15952       tags:
15953         - Business
15954       summary: returns service-instance
15955       description: returns service-instance
15956       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
15957       produces:
15958         - application/json
15959         - application/xml
15960       responses:
15961         "200":
15962           description: successful operation
15963           schema:
15964               $ref: "#/getDefinitions/service-instance"
15965         "default":
15966           description: Response codes found in [response codes](https://wiki.onap.org/).
15967       parameters:
15968         - name: global-customer-id
15969           in: path
15970           description: Global customer id used across ECOMP to uniquely identify customer.
15971           required: true
15972           type: string
15973           example: __GLOBAL-CUSTOMER-ID__
15974         - name: service-type
15975           in: path
15976           description: Value defined by orchestration to identify this service across ECOMP.
15977           required: true
15978           type: string
15979           example: __SERVICE-TYPE__
15980         - name: service-instance-id
15981           in: path
15982           description: Uniquely identifies this instance of a service
15983           required: true
15984           type: string
15985           example: __SERVICE-INSTANCE-ID__
15986     put:
15987       tags:
15988         - Business
15989       summary: create or update an existing service-instance
15990       description: |
15991         Create or update an existing service-instance.
15992         #
15993         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15994       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
15995       consumes:
15996         - application/json
15997         - application/xml
15998       produces:
15999         - application/json
16000         - application/xml
16001       responses:
16002         "default":
16003           description: Response codes found in [response codes](https://wiki.onap.org/).
16004       parameters:
16005         - name: global-customer-id
16006           in: path
16007           description: Global customer id used across ECOMP to uniquely identify customer.
16008           required: true
16009           type: string
16010           example: __GLOBAL-CUSTOMER-ID__
16011         - name: service-type
16012           in: path
16013           description: Value defined by orchestration to identify this service across ECOMP.
16014           required: true
16015           type: string
16016           example: __SERVICE-TYPE__
16017         - name: service-instance-id
16018           in: path
16019           description: Uniquely identifies this instance of a service
16020           required: true
16021           type: string
16022           example: __SERVICE-INSTANCE-ID__
16023         - name: body
16024           in: body
16025           description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
16026           required: true
16027           schema:
16028             $ref: "#/definitions/service-instance"
16029     patch:
16030       tags:
16031         - Business
16032       summary: update an existing service-instance
16033       description: |
16034         Update an existing service-instance
16035         #
16036         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16037         The PUT operation will entirely replace an existing object.
16038         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16039         #
16040         Other differences between PUT and PATCH are:
16041         #
16042         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16043         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16044         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16045       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16046       consumes:
16047         - application/json
16048         - application/xml
16049       produces:
16050         - application/json
16051         - application/xml
16052       responses:
16053         "default":
16054           description: Response codes found in [response codes](https://wiki.onap.org/).
16055       parameters:
16056         - name: global-customer-id
16057           in: path
16058           description: Global customer id used across ECOMP to uniquely identify customer.
16059           required: true
16060           type: string
16061           example: __GLOBAL-CUSTOMER-ID__
16062         - name: service-type
16063           in: path
16064           description: Value defined by orchestration to identify this service across ECOMP.
16065           required: true
16066           type: string
16067           example: __SERVICE-TYPE__
16068         - name: service-instance-id
16069           in: path
16070           description: Uniquely identifies this instance of a service
16071           required: true
16072           type: string
16073           example: __SERVICE-INSTANCE-ID__
16074         - name: body
16075           in: body
16076           description: service-instance object that needs to be updated.
16077           required: true
16078           schema:
16079             $ref: "#/patchDefinitions/service-instance"
16080     delete:
16081       tags:
16082         - Business
16083       summary: delete an existing service-instance
16084       description: delete an existing service-instance
16085       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16086       consumes:
16087         - application/json
16088         - application/xml
16089       produces:
16090         - application/json
16091         - application/xml
16092       responses:
16093         "default":
16094           description: Response codes found in [response codes](https://wiki.onap.org/).
16095       parameters:
16096         - name: global-customer-id
16097           in: path
16098           description: Global customer id used across ECOMP to uniquely identify customer.
16099           required: true
16100           type: string
16101           example: __GLOBAL-CUSTOMER-ID__
16102         - name: service-type
16103           in: path
16104           description: Value defined by orchestration to identify this service across ECOMP.
16105           required: true
16106           type: string
16107           example: __SERVICE-TYPE__
16108         - name: service-instance-id
16109           in: path
16110           description: Uniquely identifies this instance of a service
16111           required: true
16112           type: string
16113           example: __SERVICE-INSTANCE-ID__
16114         - name: resource-version
16115           in: query
16116           description: resource-version for concurrency
16117           required: true
16118           type: string
16119   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
16120     get:
16121       tags:
16122         - Business
16123       summary: returns service-instances
16124       description: returns service-instances
16125       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
16126       produces:
16127         - application/json
16128         - application/xml
16129       responses:
16130         "200":
16131           description: successful operation
16132           schema:
16133               $ref: "#/getDefinitions/service-instances"
16134         "default":
16135           description: Response codes found in [response codes](https://wiki.onap.org/).
16136       parameters:
16137         - name: global-customer-id
16138           in: path
16139           description: Global customer id used across ECOMP to uniquely identify customer.
16140           required: true
16141           type: string
16142           example: __GLOBAL-CUSTOMER-ID__
16143         - name: service-type
16144           in: path
16145           description: Value defined by orchestration to identify this service across ECOMP.
16146           required: true
16147           type: string
16148           example: __SERVICE-TYPE__
16149         - name: service-instance-id
16150           in: query
16151           description:
16152           required: false
16153           type: string
16154         - name: service-instance-name
16155           in: query
16156           description:
16157           required: false
16158           type: string
16159         - name: environment-context
16160           in: query
16161           description:
16162           required: false
16163           type: string
16164         - name: workload-context
16165           in: query
16166           description:
16167           required: false
16168           type: string
16169         - name: model-invariant-id
16170           in: query
16171           description:
16172           required: false
16173           type: string
16174         - name: model-version-id
16175           in: query
16176           description:
16177           required: false
16178           type: string
16179         - name: widget-model-id
16180           in: query
16181           description:
16182           required: false
16183           type: string
16184         - name: widget-model-version
16185           in: query
16186           description:
16187           required: false
16188           type: string
16189         - name: service-instance-location-id
16190           in: query
16191           description:
16192           required: false
16193           type: string
16194         - name: orchestration-status
16195           in: query
16196           description:
16197           required: false
16198           type: string
16199   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
16200     put:
16201       tags:
16202         - Business
16203       summary: see node definition for valid relationships
16204       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16205       consumes:
16206         - application/json
16207         - application/xml
16208       produces:
16209         - application/json
16210         - application/xml
16211       responses:
16212         "default":
16213           description: Response codes found in [response codes](https://wiki.onap.org/).
16214       parameters:
16215         - name: global-customer-id
16216           in: path
16217           description: Global customer id used across ECOMP to uniquely identify customer.
16218           required: true
16219           type: string
16220           example: __GLOBAL-CUSTOMER-ID__
16221         - name: service-type
16222           in: path
16223           description: Value defined by orchestration to identify this service across ECOMP.
16224           required: true
16225           type: string
16226           example: __SERVICE-TYPE__
16227         - name: body
16228           in: body
16229           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16230           required: true
16231           schema:
16232             $ref: "#/definitions/relationship"
16233     delete:
16234       tags:
16235         - Business
16236       summary: delete an existing relationship
16237       description: delete an existing relationship
16238       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16239       consumes:
16240         - application/json
16241         - application/xml
16242       produces:
16243         - application/json
16244         - application/xml
16245       responses:
16246         "default":
16247           description: Response codes found in [response codes](https://wiki.onap.org/).
16248       parameters:
16249         - name: global-customer-id
16250           in: path
16251           description: Global customer id used across ECOMP to uniquely identify customer.
16252           required: true
16253           type: string
16254           example: __GLOBAL-CUSTOMER-ID__
16255         - name: service-type
16256           in: path
16257           description: Value defined by orchestration to identify this service across ECOMP.
16258           required: true
16259           type: string
16260           example: __SERVICE-TYPE__
16261   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
16262     get:
16263       tags:
16264         - Business
16265       summary: returns service-subscription
16266       description: returns service-subscription
16267       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16268       produces:
16269         - application/json
16270         - application/xml
16271       responses:
16272         "200":
16273           description: successful operation
16274           schema:
16275               $ref: "#/getDefinitions/service-subscription"
16276         "default":
16277           description: Response codes found in [response codes](https://wiki.onap.org/).
16278       parameters:
16279         - name: global-customer-id
16280           in: path
16281           description: Global customer id used across ECOMP to uniquely identify customer.
16282           required: true
16283           type: string
16284           example: __GLOBAL-CUSTOMER-ID__
16285         - name: service-type
16286           in: path
16287           description: Value defined by orchestration to identify this service across ECOMP.
16288           required: true
16289           type: string
16290           example: __SERVICE-TYPE__
16291     put:
16292       tags:
16293         - Business
16294       summary: create or update an existing service-subscription
16295       description: |
16296         Create or update an existing service-subscription.
16297         #
16298         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16299       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16300       consumes:
16301         - application/json
16302         - application/xml
16303       produces:
16304         - application/json
16305         - application/xml
16306       responses:
16307         "default":
16308           description: Response codes found in [response codes](https://wiki.onap.org/).
16309       parameters:
16310         - name: global-customer-id
16311           in: path
16312           description: Global customer id used across ECOMP to uniquely identify customer.
16313           required: true
16314           type: string
16315           example: __GLOBAL-CUSTOMER-ID__
16316         - name: service-type
16317           in: path
16318           description: Value defined by orchestration to identify this service across ECOMP.
16319           required: true
16320           type: string
16321           example: __SERVICE-TYPE__
16322         - name: body
16323           in: body
16324           description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16325           required: true
16326           schema:
16327             $ref: "#/definitions/service-subscription"
16328     patch:
16329       tags:
16330         - Business
16331       summary: update an existing service-subscription
16332       description: |
16333         Update an existing service-subscription
16334         #
16335         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16336         The PUT operation will entirely replace an existing object.
16337         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16338         #
16339         Other differences between PUT and PATCH are:
16340         #
16341         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16342         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16343         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16344       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16345       consumes:
16346         - application/json
16347         - application/xml
16348       produces:
16349         - application/json
16350         - application/xml
16351       responses:
16352         "default":
16353           description: Response codes found in [response codes](https://wiki.onap.org/).
16354       parameters:
16355         - name: global-customer-id
16356           in: path
16357           description: Global customer id used across ECOMP to uniquely identify customer.
16358           required: true
16359           type: string
16360           example: __GLOBAL-CUSTOMER-ID__
16361         - name: service-type
16362           in: path
16363           description: Value defined by orchestration to identify this service across ECOMP.
16364           required: true
16365           type: string
16366           example: __SERVICE-TYPE__
16367         - name: body
16368           in: body
16369           description: service-subscription object that needs to be updated.
16370           required: true
16371           schema:
16372             $ref: "#/patchDefinitions/service-subscription"
16373     delete:
16374       tags:
16375         - Business
16376       summary: delete an existing service-subscription
16377       description: delete an existing service-subscription
16378       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16379       consumes:
16380         - application/json
16381         - application/xml
16382       produces:
16383         - application/json
16384         - application/xml
16385       responses:
16386         "default":
16387           description: Response codes found in [response codes](https://wiki.onap.org/).
16388       parameters:
16389         - name: global-customer-id
16390           in: path
16391           description: Global customer id used across ECOMP to uniquely identify customer.
16392           required: true
16393           type: string
16394           example: __GLOBAL-CUSTOMER-ID__
16395         - name: service-type
16396           in: path
16397           description: Value defined by orchestration to identify this service across ECOMP.
16398           required: true
16399           type: string
16400           example: __SERVICE-TYPE__
16401         - name: resource-version
16402           in: query
16403           description: resource-version for concurrency
16404           required: true
16405           type: string
16406   /business/customers/customer/{global-customer-id}/service-subscriptions:
16407     get:
16408       tags:
16409         - Business
16410       summary: returns service-subscriptions
16411       description: returns service-subscriptions
16412       operationId: getBusinessCustomersCustomerServiceSubscriptions
16413       produces:
16414         - application/json
16415         - application/xml
16416       responses:
16417         "200":
16418           description: successful operation
16419           schema:
16420               $ref: "#/getDefinitions/service-subscriptions"
16421         "default":
16422           description: Response codes found in [response codes](https://wiki.onap.org/).
16423       parameters:
16424         - name: global-customer-id
16425           in: path
16426           description: Global customer id used across ECOMP to uniquely identify customer.
16427           required: true
16428           type: string
16429           example: __GLOBAL-CUSTOMER-ID__
16430         - name: service-type
16431           in: query
16432           description:
16433           required: false
16434           type: string
16435   /business/customers/customer/{global-customer-id}/relationship-list/relationship:
16436     put:
16437       tags:
16438         - Business
16439       summary: see node definition for valid relationships
16440       operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
16441       consumes:
16442         - application/json
16443         - application/xml
16444       produces:
16445         - application/json
16446         - application/xml
16447       responses:
16448         "default":
16449           description: Response codes found in [response codes](https://wiki.onap.org/).
16450       parameters:
16451         - name: global-customer-id
16452           in: path
16453           description: Global customer id used across ECOMP to uniquely identify customer.
16454           required: true
16455           type: string
16456           example: __GLOBAL-CUSTOMER-ID__
16457         - name: body
16458           in: body
16459           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json)
16460           required: true
16461           schema:
16462             $ref: "#/definitions/relationship"
16463     delete:
16464       tags:
16465         - Business
16466       summary: delete an existing relationship
16467       description: delete an existing relationship
16468       operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
16469       consumes:
16470         - application/json
16471         - application/xml
16472       produces:
16473         - application/json
16474         - application/xml
16475       responses:
16476         "default":
16477           description: Response codes found in [response codes](https://wiki.onap.org/).
16478       parameters:
16479         - name: global-customer-id
16480           in: path
16481           description: Global customer id used across ECOMP to uniquely identify customer.
16482           required: true
16483           type: string
16484           example: __GLOBAL-CUSTOMER-ID__
16485   /business/customers/customer/{global-customer-id}:
16486     get:
16487       tags:
16488         - Business
16489       summary: returns customer
16490       description: returns customer
16491       operationId: getBusinessCustomersCustomer
16492       produces:
16493         - application/json
16494         - application/xml
16495       responses:
16496         "200":
16497           description: successful operation
16498           schema:
16499               $ref: "#/getDefinitions/customer"
16500         "default":
16501           description: Response codes found in [response codes](https://wiki.onap.org/).
16502       parameters:
16503         - name: global-customer-id
16504           in: path
16505           description: Global customer id used across ECOMP to uniquely identify customer.
16506           required: true
16507           type: string
16508           example: __GLOBAL-CUSTOMER-ID__
16509     put:
16510       tags:
16511         - Business
16512       summary: create or update an existing customer
16513       description: |
16514         Create or update an existing customer.
16515         #
16516         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16517       operationId: createOrUpdateBusinessCustomersCustomer
16518       consumes:
16519         - application/json
16520         - application/xml
16521       produces:
16522         - application/json
16523         - application/xml
16524       responses:
16525         "default":
16526           description: Response codes found in [response codes](https://wiki.onap.org/).
16527       parameters:
16528         - name: global-customer-id
16529           in: path
16530           description: Global customer id used across ECOMP to uniquely identify customer.
16531           required: true
16532           type: string
16533           example: __GLOBAL-CUSTOMER-ID__
16534         - name: body
16535           in: body
16536           description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json)
16537           required: true
16538           schema:
16539             $ref: "#/definitions/customer"
16540     patch:
16541       tags:
16542         - Business
16543       summary: update an existing customer
16544       description: |
16545         Update an existing customer
16546         #
16547         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16548         The PUT operation will entirely replace an existing object.
16549         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16550         #
16551         Other differences between PUT and PATCH are:
16552         #
16553         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16554         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16555         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16556       operationId: UpdateBusinessCustomersCustomer
16557       consumes:
16558         - application/json
16559         - application/xml
16560       produces:
16561         - application/json
16562         - application/xml
16563       responses:
16564         "default":
16565           description: Response codes found in [response codes](https://wiki.onap.org/).
16566       parameters:
16567         - name: global-customer-id
16568           in: path
16569           description: Global customer id used across ECOMP to uniquely identify customer.
16570           required: true
16571           type: string
16572           example: __GLOBAL-CUSTOMER-ID__
16573         - name: body
16574           in: body
16575           description: customer object that needs to be updated.
16576           required: true
16577           schema:
16578             $ref: "#/patchDefinitions/customer"
16579     delete:
16580       tags:
16581         - Business
16582       summary: delete an existing customer
16583       description: delete an existing customer
16584       operationId: deleteBusinessCustomersCustomer
16585       consumes:
16586         - application/json
16587         - application/xml
16588       produces:
16589         - application/json
16590         - application/xml
16591       responses:
16592         "default":
16593           description: Response codes found in [response codes](https://wiki.onap.org/).
16594       parameters:
16595         - name: global-customer-id
16596           in: path
16597           description: Global customer id used across ECOMP to uniquely identify customer.
16598           required: true
16599           type: string
16600           example: __GLOBAL-CUSTOMER-ID__
16601         - name: resource-version
16602           in: query
16603           description: resource-version for concurrency
16604           required: true
16605           type: string
16606   /business/customers:
16607     get:
16608       tags:
16609         - Business
16610       summary: returns customers
16611       description: returns customers
16612       operationId: getBusinessCustomers
16613       produces:
16614         - application/json
16615         - application/xml
16616       responses:
16617         "200":
16618           description: successful operation
16619           schema:
16620               $ref: "#/getDefinitions/customers"
16621         "default":
16622           description: Response codes found in [response codes](https://wiki.onap.org/).
16623       parameters:
16624         - name: global-customer-id
16625           in: query
16626           description:
16627           required: false
16628           type: string
16629         - name: subscriber-name
16630           in: query
16631           description:
16632           required: false
16633           type: string
16634         - name: subscriber-type
16635           in: query
16636           description:
16637           required: false
16638           type: string
16639   /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
16640     put:
16641       tags:
16642         - Business
16643       summary: see node definition for valid relationships
16644       operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
16645       consumes:
16646         - application/json
16647         - application/xml
16648       produces:
16649         - application/json
16650         - application/xml
16651       responses:
16652         "default":
16653           description: Response codes found in [response codes](https://wiki.onap.org/).
16654       parameters:
16655         - name: line-of-business-name
16656           in: path
16657           description: Name of the line-of-business (product)
16658           required: true
16659           type: string
16660           example: __LINE-OF-BUSINESS-NAME__
16661         - name: body
16662           in: body
16663           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json)
16664           required: true
16665           schema:
16666             $ref: "#/definitions/relationship"
16667     delete:
16668       tags:
16669         - Business
16670       summary: delete an existing relationship
16671       description: delete an existing relationship
16672       operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
16673       consumes:
16674         - application/json
16675         - application/xml
16676       produces:
16677         - application/json
16678         - application/xml
16679       responses:
16680         "default":
16681           description: Response codes found in [response codes](https://wiki.onap.org/).
16682       parameters:
16683         - name: line-of-business-name
16684           in: path
16685           description: Name of the line-of-business (product)
16686           required: true
16687           type: string
16688           example: __LINE-OF-BUSINESS-NAME__
16689   /business/lines-of-business/line-of-business/{line-of-business-name}:
16690     get:
16691       tags:
16692         - Business
16693       summary: returns line-of-business
16694       description: returns line-of-business
16695       operationId: getBusinessLinesOfBusinessLineOfBusiness
16696       produces:
16697         - application/json
16698         - application/xml
16699       responses:
16700         "200":
16701           description: successful operation
16702           schema:
16703               $ref: "#/getDefinitions/line-of-business"
16704         "default":
16705           description: Response codes found in [response codes](https://wiki.onap.org/).
16706       parameters:
16707         - name: line-of-business-name
16708           in: path
16709           description: Name of the line-of-business (product)
16710           required: true
16711           type: string
16712           example: __LINE-OF-BUSINESS-NAME__
16713     put:
16714       tags:
16715         - Business
16716       summary: create or update an existing line-of-business
16717       description: |
16718         Create or update an existing line-of-business.
16719         #
16720         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16721       operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
16722       consumes:
16723         - application/json
16724         - application/xml
16725       produces:
16726         - application/json
16727         - application/xml
16728       responses:
16729         "default":
16730           description: Response codes found in [response codes](https://wiki.onap.org/).
16731       parameters:
16732         - name: line-of-business-name
16733           in: path
16734           description: Name of the line-of-business (product)
16735           required: true
16736           type: string
16737           example: __LINE-OF-BUSINESS-NAME__
16738         - name: body
16739           in: body
16740           description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json)
16741           required: true
16742           schema:
16743             $ref: "#/definitions/line-of-business"
16744     patch:
16745       tags:
16746         - Business
16747       summary: update an existing line-of-business
16748       description: |
16749         Update an existing line-of-business
16750         #
16751         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16752         The PUT operation will entirely replace an existing object.
16753         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16754         #
16755         Other differences between PUT and PATCH are:
16756         #
16757         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16758         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16759         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16760       operationId: UpdateBusinessLinesOfBusinessLineOfBusiness
16761       consumes:
16762         - application/json
16763         - application/xml
16764       produces:
16765         - application/json
16766         - application/xml
16767       responses:
16768         "default":
16769           description: Response codes found in [response codes](https://wiki.onap.org/).
16770       parameters:
16771         - name: line-of-business-name
16772           in: path
16773           description: Name of the line-of-business (product)
16774           required: true
16775           type: string
16776           example: __LINE-OF-BUSINESS-NAME__
16777         - name: body
16778           in: body
16779           description: line-of-business object that needs to be updated.
16780           required: true
16781           schema:
16782             $ref: "#/patchDefinitions/line-of-business"
16783     delete:
16784       tags:
16785         - Business
16786       summary: delete an existing line-of-business
16787       description: delete an existing line-of-business
16788       operationId: deleteBusinessLinesOfBusinessLineOfBusiness
16789       consumes:
16790         - application/json
16791         - application/xml
16792       produces:
16793         - application/json
16794         - application/xml
16795       responses:
16796         "default":
16797           description: Response codes found in [response codes](https://wiki.onap.org/).
16798       parameters:
16799         - name: line-of-business-name
16800           in: path
16801           description: Name of the line-of-business (product)
16802           required: true
16803           type: string
16804           example: __LINE-OF-BUSINESS-NAME__
16805         - name: resource-version
16806           in: query
16807           description: resource-version for concurrency
16808           required: true
16809           type: string
16810   /business/lines-of-business:
16811     get:
16812       tags:
16813         - Business
16814       summary: returns lines-of-business
16815       description: returns lines-of-business
16816       operationId: getBusinessLinesOfBusiness
16817       produces:
16818         - application/json
16819         - application/xml
16820       responses:
16821         "200":
16822           description: successful operation
16823           schema:
16824               $ref: "#/getDefinitions/lines-of-business"
16825         "default":
16826           description: Response codes found in [response codes](https://wiki.onap.org/).
16827       parameters:
16828         - name: line-of-business-name
16829           in: query
16830           description:
16831           required: false
16832           type: string
16833   /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
16834     put:
16835       tags:
16836         - Business
16837       summary: see node definition for valid relationships
16838       operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship
16839       consumes:
16840         - application/json
16841         - application/xml
16842       produces:
16843         - application/json
16844         - application/xml
16845       responses:
16846         "default":
16847           description: Response codes found in [response codes](https://wiki.onap.org/).
16848       parameters:
16849         - name: owning-entity-id
16850           in: path
16851           description: UUID of an owning entity
16852           required: true
16853           type: string
16854           example: __OWNING-ENTITY-ID__
16855         - name: body
16856           in: body
16857           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json)
16858           required: true
16859           schema:
16860             $ref: "#/definitions/relationship"
16861     delete:
16862       tags:
16863         - Business
16864       summary: delete an existing relationship
16865       description: delete an existing relationship
16866       operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship
16867       consumes:
16868         - application/json
16869         - application/xml
16870       produces:
16871         - application/json
16872         - application/xml
16873       responses:
16874         "default":
16875           description: Response codes found in [response codes](https://wiki.onap.org/).
16876       parameters:
16877         - name: owning-entity-id
16878           in: path
16879           description: UUID of an owning entity
16880           required: true
16881           type: string
16882           example: __OWNING-ENTITY-ID__
16883   /business/owning-entities/owning-entity/{owning-entity-id}:
16884     get:
16885       tags:
16886         - Business
16887       summary: returns owning-entity
16888       description: returns owning-entity
16889       operationId: getBusinessOwningEntitiesOwningEntity
16890       produces:
16891         - application/json
16892         - application/xml
16893       responses:
16894         "200":
16895           description: successful operation
16896           schema:
16897               $ref: "#/getDefinitions/owning-entity"
16898         "default":
16899           description: Response codes found in [response codes](https://wiki.onap.org/).
16900       parameters:
16901         - name: owning-entity-id
16902           in: path
16903           description: UUID of an owning entity
16904           required: true
16905           type: string
16906           example: __OWNING-ENTITY-ID__
16907     put:
16908       tags:
16909         - Business
16910       summary: create or update an existing owning-entity
16911       description: |
16912         Create or update an existing owning-entity.
16913         #
16914         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16915       operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
16916       consumes:
16917         - application/json
16918         - application/xml
16919       produces:
16920         - application/json
16921         - application/xml
16922       responses:
16923         "default":
16924           description: Response codes found in [response codes](https://wiki.onap.org/).
16925       parameters:
16926         - name: owning-entity-id
16927           in: path
16928           description: UUID of an owning entity
16929           required: true
16930           type: string
16931           example: __OWNING-ENTITY-ID__
16932         - name: body
16933           in: body
16934           description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json)
16935           required: true
16936           schema:
16937             $ref: "#/definitions/owning-entity"
16938     patch:
16939       tags:
16940         - Business
16941       summary: update an existing owning-entity
16942       description: |
16943         Update an existing owning-entity
16944         #
16945         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16946         The PUT operation will entirely replace an existing object.
16947         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16948         #
16949         Other differences between PUT and PATCH are:
16950         #
16951         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16952         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16953         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16954       operationId: UpdateBusinessOwningEntitiesOwningEntity
16955       consumes:
16956         - application/json
16957         - application/xml
16958       produces:
16959         - application/json
16960         - application/xml
16961       responses:
16962         "default":
16963           description: Response codes found in [response codes](https://wiki.onap.org/).
16964       parameters:
16965         - name: owning-entity-id
16966           in: path
16967           description: UUID of an owning entity
16968           required: true
16969           type: string
16970           example: __OWNING-ENTITY-ID__
16971         - name: body
16972           in: body
16973           description: owning-entity object that needs to be updated.
16974           required: true
16975           schema:
16976             $ref: "#/patchDefinitions/owning-entity"
16977     delete:
16978       tags:
16979         - Business
16980       summary: delete an existing owning-entity
16981       description: delete an existing owning-entity
16982       operationId: deleteBusinessOwningEntitiesOwningEntity
16983       consumes:
16984         - application/json
16985         - application/xml
16986       produces:
16987         - application/json
16988         - application/xml
16989       responses:
16990         "default":
16991           description: Response codes found in [response codes](https://wiki.onap.org/).
16992       parameters:
16993         - name: owning-entity-id
16994           in: path
16995           description: UUID of an owning entity
16996           required: true
16997           type: string
16998           example: __OWNING-ENTITY-ID__
16999         - name: resource-version
17000           in: query
17001           description: resource-version for concurrency
17002           required: true
17003           type: string
17004   /business/owning-entities:
17005     get:
17006       tags:
17007         - Business
17008       summary: returns owning-entities
17009       description: returns owning-entities
17010       operationId: getBusinessOwningEntities
17011       produces:
17012         - application/json
17013         - application/xml
17014       responses:
17015         "200":
17016           description: successful operation
17017           schema:
17018               $ref: "#/getDefinitions/owning-entities"
17019         "default":
17020           description: Response codes found in [response codes](https://wiki.onap.org/).
17021       parameters:
17022         - name: owning-entity-id
17023           in: query
17024           description:
17025           required: false
17026           type: string
17027   /business/platforms/platform/{platform-name}/relationship-list/relationship:
17028     put:
17029       tags:
17030         - Business
17031       summary: see node definition for valid relationships
17032       operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship
17033       consumes:
17034         - application/json
17035         - application/xml
17036       produces:
17037         - application/json
17038         - application/xml
17039       responses:
17040         "default":
17041           description: Response codes found in [response codes](https://wiki.onap.org/).
17042       parameters:
17043         - name: platform-name
17044           in: path
17045           description: Name of the platform
17046           required: true
17047           type: string
17048           example: __PLATFORM-NAME__
17049         - name: body
17050           in: body
17051           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json)
17052           required: true
17053           schema:
17054             $ref: "#/definitions/relationship"
17055     delete:
17056       tags:
17057         - Business
17058       summary: delete an existing relationship
17059       description: delete an existing relationship
17060       operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship
17061       consumes:
17062         - application/json
17063         - application/xml
17064       produces:
17065         - application/json
17066         - application/xml
17067       responses:
17068         "default":
17069           description: Response codes found in [response codes](https://wiki.onap.org/).
17070       parameters:
17071         - name: platform-name
17072           in: path
17073           description: Name of the platform
17074           required: true
17075           type: string
17076           example: __PLATFORM-NAME__
17077   /business/platforms/platform/{platform-name}:
17078     get:
17079       tags:
17080         - Business
17081       summary: returns platform
17082       description: returns platform
17083       operationId: getBusinessPlatformsPlatform
17084       produces:
17085         - application/json
17086         - application/xml
17087       responses:
17088         "200":
17089           description: successful operation
17090           schema:
17091               $ref: "#/getDefinitions/platform"
17092         "default":
17093           description: Response codes found in [response codes](https://wiki.onap.org/).
17094       parameters:
17095         - name: platform-name
17096           in: path
17097           description: Name of the platform
17098           required: true
17099           type: string
17100           example: __PLATFORM-NAME__
17101     put:
17102       tags:
17103         - Business
17104       summary: create or update an existing platform
17105       description: |
17106         Create or update an existing platform.
17107         #
17108         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17109       operationId: createOrUpdateBusinessPlatformsPlatform
17110       consumes:
17111         - application/json
17112         - application/xml
17113       produces:
17114         - application/json
17115         - application/xml
17116       responses:
17117         "default":
17118           description: Response codes found in [response codes](https://wiki.onap.org/).
17119       parameters:
17120         - name: platform-name
17121           in: path
17122           description: Name of the platform
17123           required: true
17124           type: string
17125           example: __PLATFORM-NAME__
17126         - name: body
17127           in: body
17128           description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json)
17129           required: true
17130           schema:
17131             $ref: "#/definitions/platform"
17132     patch:
17133       tags:
17134         - Business
17135       summary: update an existing platform
17136       description: |
17137         Update an existing platform
17138         #
17139         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17140         The PUT operation will entirely replace an existing object.
17141         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17142         #
17143         Other differences between PUT and PATCH are:
17144         #
17145         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17146         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17147         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17148       operationId: UpdateBusinessPlatformsPlatform
17149       consumes:
17150         - application/json
17151         - application/xml
17152       produces:
17153         - application/json
17154         - application/xml
17155       responses:
17156         "default":
17157           description: Response codes found in [response codes](https://wiki.onap.org/).
17158       parameters:
17159         - name: platform-name
17160           in: path
17161           description: Name of the platform
17162           required: true
17163           type: string
17164           example: __PLATFORM-NAME__
17165         - name: body
17166           in: body
17167           description: platform object that needs to be updated.
17168           required: true
17169           schema:
17170             $ref: "#/patchDefinitions/platform"
17171     delete:
17172       tags:
17173         - Business
17174       summary: delete an existing platform
17175       description: delete an existing platform
17176       operationId: deleteBusinessPlatformsPlatform
17177       consumes:
17178         - application/json
17179         - application/xml
17180       produces:
17181         - application/json
17182         - application/xml
17183       responses:
17184         "default":
17185           description: Response codes found in [response codes](https://wiki.onap.org/).
17186       parameters:
17187         - name: platform-name
17188           in: path
17189           description: Name of the platform
17190           required: true
17191           type: string
17192           example: __PLATFORM-NAME__
17193         - name: resource-version
17194           in: query
17195           description: resource-version for concurrency
17196           required: true
17197           type: string
17198   /business/platforms:
17199     get:
17200       tags:
17201         - Business
17202       summary: returns platforms
17203       description: returns platforms
17204       operationId: getBusinessPlatforms
17205       produces:
17206         - application/json
17207         - application/xml
17208       responses:
17209         "200":
17210           description: successful operation
17211           schema:
17212               $ref: "#/getDefinitions/platforms"
17213         "default":
17214           description: Response codes found in [response codes](https://wiki.onap.org/).
17215       parameters:
17216         - name: platform-name
17217           in: query
17218           description:
17219           required: false
17220           type: string
17221   /business/projects/project/{project-name}/relationship-list/relationship:
17222     put:
17223       tags:
17224         - Business
17225       summary: see node definition for valid relationships
17226       operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship
17227       consumes:
17228         - application/json
17229         - application/xml
17230       produces:
17231         - application/json
17232         - application/xml
17233       responses:
17234         "default":
17235           description: Response codes found in [response codes](https://wiki.onap.org/).
17236       parameters:
17237         - name: project-name
17238           in: path
17239           description: Name of the project deploying a service
17240           required: true
17241           type: string
17242           example: __PROJECT-NAME__
17243         - name: body
17244           in: body
17245           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json)
17246           required: true
17247           schema:
17248             $ref: "#/definitions/relationship"
17249     delete:
17250       tags:
17251         - Business
17252       summary: delete an existing relationship
17253       description: delete an existing relationship
17254       operationId: deleteBusinessProjectsProjectRelationshipListRelationship
17255       consumes:
17256         - application/json
17257         - application/xml
17258       produces:
17259         - application/json
17260         - application/xml
17261       responses:
17262         "default":
17263           description: Response codes found in [response codes](https://wiki.onap.org/).
17264       parameters:
17265         - name: project-name
17266           in: path
17267           description: Name of the project deploying a service
17268           required: true
17269           type: string
17270           example: __PROJECT-NAME__
17271   /business/projects/project/{project-name}:
17272     get:
17273       tags:
17274         - Business
17275       summary: returns project
17276       description: returns project
17277       operationId: getBusinessProjectsProject
17278       produces:
17279         - application/json
17280         - application/xml
17281       responses:
17282         "200":
17283           description: successful operation
17284           schema:
17285               $ref: "#/getDefinitions/project"
17286         "default":
17287           description: Response codes found in [response codes](https://wiki.onap.org/).
17288       parameters:
17289         - name: project-name
17290           in: path
17291           description: Name of the project deploying a service
17292           required: true
17293           type: string
17294           example: __PROJECT-NAME__
17295     put:
17296       tags:
17297         - Business
17298       summary: create or update an existing project
17299       description: |
17300         Create or update an existing project.
17301         #
17302         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17303       operationId: createOrUpdateBusinessProjectsProject
17304       consumes:
17305         - application/json
17306         - application/xml
17307       produces:
17308         - application/json
17309         - application/xml
17310       responses:
17311         "default":
17312           description: Response codes found in [response codes](https://wiki.onap.org/).
17313       parameters:
17314         - name: project-name
17315           in: path
17316           description: Name of the project deploying a service
17317           required: true
17318           type: string
17319           example: __PROJECT-NAME__
17320         - name: body
17321           in: body
17322           description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json)
17323           required: true
17324           schema:
17325             $ref: "#/definitions/project"
17326     patch:
17327       tags:
17328         - Business
17329       summary: update an existing project
17330       description: |
17331         Update an existing project
17332         #
17333         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17334         The PUT operation will entirely replace an existing object.
17335         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17336         #
17337         Other differences between PUT and PATCH are:
17338         #
17339         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17340         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17341         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17342       operationId: UpdateBusinessProjectsProject
17343       consumes:
17344         - application/json
17345         - application/xml
17346       produces:
17347         - application/json
17348         - application/xml
17349       responses:
17350         "default":
17351           description: Response codes found in [response codes](https://wiki.onap.org/).
17352       parameters:
17353         - name: project-name
17354           in: path
17355           description: Name of the project deploying a service
17356           required: true
17357           type: string
17358           example: __PROJECT-NAME__
17359         - name: body
17360           in: body
17361           description: project object that needs to be updated.
17362           required: true
17363           schema:
17364             $ref: "#/patchDefinitions/project"
17365     delete:
17366       tags:
17367         - Business
17368       summary: delete an existing project
17369       description: delete an existing project
17370       operationId: deleteBusinessProjectsProject
17371       consumes:
17372         - application/json
17373         - application/xml
17374       produces:
17375         - application/json
17376         - application/xml
17377       responses:
17378         "default":
17379           description: Response codes found in [response codes](https://wiki.onap.org/).
17380       parameters:
17381         - name: project-name
17382           in: path
17383           description: Name of the project deploying a service
17384           required: true
17385           type: string
17386           example: __PROJECT-NAME__
17387         - name: resource-version
17388           in: query
17389           description: resource-version for concurrency
17390           required: true
17391           type: string
17392   /business/projects:
17393     get:
17394       tags:
17395         - Business
17396       summary: returns projects
17397       description: returns projects
17398       operationId: getBusinessProjects
17399       produces:
17400         - application/json
17401         - application/xml
17402       responses:
17403         "200":
17404           description: successful operation
17405           schema:
17406               $ref: "#/getDefinitions/projects"
17407         "default":
17408           description: Response codes found in [response codes](https://wiki.onap.org/).
17409       parameters:
17410         - name: project-name
17411           in: query
17412           description:
17413           required: false
17414           type: string
17415   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
17416     put:
17417       tags:
17418         - ServiceDesignAndCreation
17419       summary: see node definition for valid relationships
17420       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
17421       consumes:
17422         - application/json
17423         - application/xml
17424       produces:
17425         - application/json
17426         - application/xml
17427       responses:
17428         "default":
17429           description: Response codes found in [response codes](https://wiki.onap.org/).
17430       parameters:
17431         - name: vnf-image-uuid
17432           in: path
17433           description: Unique ID of this asset
17434           required: true
17435           type: string
17436           example: __VNF-IMAGE-UUID__
17437         - name: body
17438           in: body
17439           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json)
17440           required: true
17441           schema:
17442             $ref: "#/definitions/relationship"
17443     delete:
17444       tags:
17445         - ServiceDesignAndCreation
17446       summary: delete an existing relationship
17447       description: delete an existing relationship
17448       operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
17449       consumes:
17450         - application/json
17451         - application/xml
17452       produces:
17453         - application/json
17454         - application/xml
17455       responses:
17456         "default":
17457           description: Response codes found in [response codes](https://wiki.onap.org/).
17458       parameters:
17459         - name: vnf-image-uuid
17460           in: path
17461           description: Unique ID of this asset
17462           required: true
17463           type: string
17464           example: __VNF-IMAGE-UUID__
17465   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
17466     get:
17467       tags:
17468         - ServiceDesignAndCreation
17469       summary: returns vnf-image
17470       description: returns vnf-image
17471       operationId: getServiceDesignAndCreationVnfImagesVnfImage
17472       produces:
17473         - application/json
17474         - application/xml
17475       responses:
17476         "200":
17477           description: successful operation
17478           schema:
17479               $ref: "#/getDefinitions/vnf-image"
17480         "default":
17481           description: Response codes found in [response codes](https://wiki.onap.org/).
17482       parameters:
17483         - name: vnf-image-uuid
17484           in: path
17485           description: Unique ID of this asset
17486           required: true
17487           type: string
17488           example: __VNF-IMAGE-UUID__
17489     put:
17490       tags:
17491         - ServiceDesignAndCreation
17492       summary: create or update an existing vnf-image
17493       description: |
17494         Create or update an existing vnf-image.
17495         #
17496         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17497       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
17498       consumes:
17499         - application/json
17500         - application/xml
17501       produces:
17502         - application/json
17503         - application/xml
17504       responses:
17505         "default":
17506           description: Response codes found in [response codes](https://wiki.onap.org/).
17507       parameters:
17508         - name: vnf-image-uuid
17509           in: path
17510           description: Unique ID of this asset
17511           required: true
17512           type: string
17513           example: __VNF-IMAGE-UUID__
17514         - name: body
17515           in: body
17516           description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json)
17517           required: true
17518           schema:
17519             $ref: "#/definitions/vnf-image"
17520     patch:
17521       tags:
17522         - ServiceDesignAndCreation
17523       summary: update an existing vnf-image
17524       description: |
17525         Update an existing vnf-image
17526         #
17527         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17528         The PUT operation will entirely replace an existing object.
17529         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17530         #
17531         Other differences between PUT and PATCH are:
17532         #
17533         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17534         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17535         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17536       operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
17537       consumes:
17538         - application/json
17539         - application/xml
17540       produces:
17541         - application/json
17542         - application/xml
17543       responses:
17544         "default":
17545           description: Response codes found in [response codes](https://wiki.onap.org/).
17546       parameters:
17547         - name: vnf-image-uuid
17548           in: path
17549           description: Unique ID of this asset
17550           required: true
17551           type: string
17552           example: __VNF-IMAGE-UUID__
17553         - name: body
17554           in: body
17555           description: vnf-image object that needs to be updated.
17556           required: true
17557           schema:
17558             $ref: "#/patchDefinitions/vnf-image"
17559     delete:
17560       tags:
17561         - ServiceDesignAndCreation
17562       summary: delete an existing vnf-image
17563       description: delete an existing vnf-image
17564       operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
17565       consumes:
17566         - application/json
17567         - application/xml
17568       produces:
17569         - application/json
17570         - application/xml
17571       responses:
17572         "default":
17573           description: Response codes found in [response codes](https://wiki.onap.org/).
17574       parameters:
17575         - name: vnf-image-uuid
17576           in: path
17577           description: Unique ID of this asset
17578           required: true
17579           type: string
17580           example: __VNF-IMAGE-UUID__
17581         - name: resource-version
17582           in: query
17583           description: resource-version for concurrency
17584           required: true
17585           type: string
17586   /service-design-and-creation/vnf-images:
17587     get:
17588       tags:
17589         - ServiceDesignAndCreation
17590       summary: returns vnf-images
17591       description: returns vnf-images
17592       operationId: getServiceDesignAndCreationVnfImages
17593       produces:
17594         - application/json
17595         - application/xml
17596       responses:
17597         "200":
17598           description: successful operation
17599           schema:
17600               $ref: "#/getDefinitions/vnf-images"
17601         "default":
17602           description: Response codes found in [response codes](https://wiki.onap.org/).
17603       parameters:
17604         - name: vnf-image-uuid
17605           in: query
17606           description:
17607           required: false
17608           type: string
17609         - name: application
17610           in: query
17611           description:
17612           required: false
17613           type: string
17614         - name: application-vendor
17615           in: query
17616           description:
17617           required: false
17618           type: string
17619         - name: application-version
17620           in: query
17621           description:
17622           required: false
17623           type: string
17624   /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
17625     put:
17626       tags:
17627         - ServiceDesignAndCreation
17628       summary: see node definition for valid relationships
17629       operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
17630       consumes:
17631         - application/json
17632         - application/xml
17633       produces:
17634         - application/json
17635         - application/xml
17636       responses:
17637         "default":
17638           description: Response codes found in [response codes](https://wiki.onap.org/).
17639       parameters:
17640         - name: service-id
17641           in: path
17642           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17643           required: true
17644           type: string
17645           example: __SERVICE-ID__
17646         - name: body
17647           in: body
17648           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json)
17649           required: true
17650           schema:
17651             $ref: "#/definitions/relationship"
17652     delete:
17653       tags:
17654         - ServiceDesignAndCreation
17655       summary: delete an existing relationship
17656       description: delete an existing relationship
17657       operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
17658       consumes:
17659         - application/json
17660         - application/xml
17661       produces:
17662         - application/json
17663         - application/xml
17664       responses:
17665         "default":
17666           description: Response codes found in [response codes](https://wiki.onap.org/).
17667       parameters:
17668         - name: service-id
17669           in: path
17670           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17671           required: true
17672           type: string
17673           example: __SERVICE-ID__
17674   /service-design-and-creation/services/service/{service-id}:
17675     get:
17676       tags:
17677         - ServiceDesignAndCreation
17678       summary: returns service
17679       description: returns service
17680       operationId: getServiceDesignAndCreationServicesService
17681       produces:
17682         - application/json
17683         - application/xml
17684       responses:
17685         "200":
17686           description: successful operation
17687           schema:
17688               $ref: "#/getDefinitions/service"
17689         "default":
17690           description: Response codes found in [response codes](https://wiki.onap.org/).
17691       parameters:
17692         - name: service-id
17693           in: path
17694           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17695           required: true
17696           type: string
17697           example: __SERVICE-ID__
17698     put:
17699       tags:
17700         - ServiceDesignAndCreation
17701       summary: create or update an existing service
17702       description: |
17703         Create or update an existing service.
17704         #
17705         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17706       operationId: createOrUpdateServiceDesignAndCreationServicesService
17707       consumes:
17708         - application/json
17709         - application/xml
17710       produces:
17711         - application/json
17712         - application/xml
17713       responses:
17714         "default":
17715           description: Response codes found in [response codes](https://wiki.onap.org/).
17716       parameters:
17717         - name: service-id
17718           in: path
17719           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17720           required: true
17721           type: string
17722           example: __SERVICE-ID__
17723         - name: body
17724           in: body
17725           description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json)
17726           required: true
17727           schema:
17728             $ref: "#/definitions/service"
17729     patch:
17730       tags:
17731         - ServiceDesignAndCreation
17732       summary: update an existing service
17733       description: |
17734         Update an existing service
17735         #
17736         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17737         The PUT operation will entirely replace an existing object.
17738         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17739         #
17740         Other differences between PUT and PATCH are:
17741         #
17742         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17743         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17744         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17745       operationId: UpdateServiceDesignAndCreationServicesService
17746       consumes:
17747         - application/json
17748         - application/xml
17749       produces:
17750         - application/json
17751         - application/xml
17752       responses:
17753         "default":
17754           description: Response codes found in [response codes](https://wiki.onap.org/).
17755       parameters:
17756         - name: service-id
17757           in: path
17758           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17759           required: true
17760           type: string
17761           example: __SERVICE-ID__
17762         - name: body
17763           in: body
17764           description: service object that needs to be updated.
17765           required: true
17766           schema:
17767             $ref: "#/patchDefinitions/service"
17768     delete:
17769       tags:
17770         - ServiceDesignAndCreation
17771       summary: delete an existing service
17772       description: delete an existing service
17773       operationId: deleteServiceDesignAndCreationServicesService
17774       consumes:
17775         - application/json
17776         - application/xml
17777       produces:
17778         - application/json
17779         - application/xml
17780       responses:
17781         "default":
17782           description: Response codes found in [response codes](https://wiki.onap.org/).
17783       parameters:
17784         - name: service-id
17785           in: path
17786           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17787           required: true
17788           type: string
17789           example: __SERVICE-ID__
17790         - name: resource-version
17791           in: query
17792           description: resource-version for concurrency
17793           required: true
17794           type: string
17795   /service-design-and-creation/services:
17796     get:
17797       tags:
17798         - ServiceDesignAndCreation
17799       summary: returns services
17800       description: returns services
17801       operationId: getServiceDesignAndCreationServices
17802       produces:
17803         - application/json
17804         - application/xml
17805       responses:
17806         "200":
17807           description: successful operation
17808           schema:
17809               $ref: "#/getDefinitions/services"
17810         "default":
17811           description: Response codes found in [response codes](https://wiki.onap.org/).
17812       parameters:
17813         - name: service-id
17814           in: query
17815           description:
17816           required: false
17817           type: string
17818         - name: service-description
17819           in: query
17820           description:
17821           required: false
17822           type: string
17823   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
17824     put:
17825       tags:
17826         - ServiceDesignAndCreation
17827       summary: see node definition for valid relationships
17828       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
17829       consumes:
17830         - application/json
17831         - application/xml
17832       produces:
17833         - application/json
17834         - application/xml
17835       responses:
17836         "default":
17837           description: Response codes found in [response codes](https://wiki.onap.org/).
17838       parameters:
17839         - name: service-type
17840           in: path
17841           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17842           required: true
17843           type: string
17844           example: __SERVICE-TYPE__
17845         - name: vnf-type
17846           in: path
17847           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17848           required: true
17849           type: string
17850           example: __VNF-TYPE__
17851         - name: body
17852           in: body
17853           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
17854           required: true
17855           schema:
17856             $ref: "#/definitions/relationship"
17857     delete:
17858       tags:
17859         - ServiceDesignAndCreation
17860       summary: delete an existing relationship
17861       description: delete an existing relationship
17862       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
17863       consumes:
17864         - application/json
17865         - application/xml
17866       produces:
17867         - application/json
17868         - application/xml
17869       responses:
17870         "default":
17871           description: Response codes found in [response codes](https://wiki.onap.org/).
17872       parameters:
17873         - name: service-type
17874           in: path
17875           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17876           required: true
17877           type: string
17878           example: __SERVICE-TYPE__
17879         - name: vnf-type
17880           in: path
17881           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17882           required: true
17883           type: string
17884           example: __VNF-TYPE__
17885   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
17886     get:
17887       tags:
17888         - ServiceDesignAndCreation
17889       summary: returns service-capability
17890       description: returns service-capability
17891       operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
17892       produces:
17893         - application/json
17894         - application/xml
17895       responses:
17896         "200":
17897           description: successful operation
17898           schema:
17899               $ref: "#/getDefinitions/service-capability"
17900         "default":
17901           description: Response codes found in [response codes](https://wiki.onap.org/).
17902       parameters:
17903         - name: service-type
17904           in: path
17905           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17906           required: true
17907           type: string
17908           example: __SERVICE-TYPE__
17909         - name: vnf-type
17910           in: path
17911           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17912           required: true
17913           type: string
17914           example: __VNF-TYPE__
17915     put:
17916       tags:
17917         - ServiceDesignAndCreation
17918       summary: create or update an existing service-capability
17919       description: |
17920         Create or update an existing service-capability.
17921         #
17922         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17923       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
17924       consumes:
17925         - application/json
17926         - application/xml
17927       produces:
17928         - application/json
17929         - application/xml
17930       responses:
17931         "default":
17932           description: Response codes found in [response codes](https://wiki.onap.org/).
17933       parameters:
17934         - name: service-type
17935           in: path
17936           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17937           required: true
17938           type: string
17939           example: __SERVICE-TYPE__
17940         - name: vnf-type
17941           in: path
17942           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17943           required: true
17944           type: string
17945           example: __VNF-TYPE__
17946         - name: body
17947           in: body
17948           description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
17949           required: true
17950           schema:
17951             $ref: "#/definitions/service-capability"
17952     patch:
17953       tags:
17954         - ServiceDesignAndCreation
17955       summary: update an existing service-capability
17956       description: |
17957         Update an existing service-capability
17958         #
17959         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17960         The PUT operation will entirely replace an existing object.
17961         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17962         #
17963         Other differences between PUT and PATCH are:
17964         #
17965         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17966         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17967         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17968       operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
17969       consumes:
17970         - application/json
17971         - application/xml
17972       produces:
17973         - application/json
17974         - application/xml
17975       responses:
17976         "default":
17977           description: Response codes found in [response codes](https://wiki.onap.org/).
17978       parameters:
17979         - name: service-type
17980           in: path
17981           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17982           required: true
17983           type: string
17984           example: __SERVICE-TYPE__
17985         - name: vnf-type
17986           in: path
17987           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17988           required: true
17989           type: string
17990           example: __VNF-TYPE__
17991         - name: body
17992           in: body
17993           description: service-capability object that needs to be updated.
17994           required: true
17995           schema:
17996             $ref: "#/patchDefinitions/service-capability"
17997     delete:
17998       tags:
17999         - ServiceDesignAndCreation
18000       summary: delete an existing service-capability
18001       description: delete an existing service-capability
18002       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
18003       consumes:
18004         - application/json
18005         - application/xml
18006       produces:
18007         - application/json
18008         - application/xml
18009       responses:
18010         "default":
18011           description: Response codes found in [response codes](https://wiki.onap.org/).
18012       parameters:
18013         - name: service-type
18014           in: path
18015           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18016           required: true
18017           type: string
18018           example: __SERVICE-TYPE__
18019         - name: vnf-type
18020           in: path
18021           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
18022           required: true
18023           type: string
18024           example: __VNF-TYPE__
18025         - name: resource-version
18026           in: query
18027           description: resource-version for concurrency
18028           required: true
18029           type: string
18030   /service-design-and-creation/service-capabilities:
18031     get:
18032       tags:
18033         - ServiceDesignAndCreation
18034       summary: returns service-capabilities
18035       description: returns service-capabilities
18036       operationId: getServiceDesignAndCreationServiceCapabilities
18037       produces:
18038         - application/json
18039         - application/xml
18040       responses:
18041         "200":
18042           description: successful operation
18043           schema:
18044               $ref: "#/getDefinitions/service-capabilities"
18045         "default":
18046           description: Response codes found in [response codes](https://wiki.onap.org/).
18047       parameters:
18048         - name: service-type
18049           in: query
18050           description:
18051           required: false
18052           type: string
18053         - name: vnf-type
18054           in: query
18055           description:
18056           required: false
18057           type: string
18058   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship:
18059     put:
18060       tags:
18061         - ServiceDesignAndCreation
18062       summary: see node definition for valid relationships
18063       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
18064       consumes:
18065         - application/json
18066         - application/xml
18067       produces:
18068         - application/json
18069         - application/xml
18070       responses:
18071         "default":
18072           description: Response codes found in [response codes](https://wiki.onap.org/).
18073       parameters:
18074         - name: model-invariant-id
18075           in: path
18076           description: Unique identifier corresponding to the main definition of a model in ASDC
18077           required: true
18078           type: string
18079           example: __MODEL-INVARIANT-ID__
18080         - name: model-version-id
18081           in: path
18082           description: Unique identifier corresponding to one version of a model in ASDC
18083           required: true
18084           type: string
18085           example: __MODEL-VERSION-ID__
18086         - name: model-element-uuid
18087           in: path
18088           required: true
18089           type: string
18090           example: __MODEL-ELEMENT-UUID__
18091         - name: model-constraint-uuid
18092           in: path
18093           required: true
18094           type: string
18095           example: __MODEL-CONSTRAINT-UUID__
18096         - name: constrained-element-set-uuid
18097           in: path
18098           required: true
18099           type: string
18100           example: __CONSTRAINED-ELEMENT-SET-UUID__
18101         - name: element-choice-set-uuid
18102           in: path
18103           required: true
18104           type: string
18105           example: __ELEMENT-CHOICE-SET-UUID__
18106         - name: body
18107           in: body
18108           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
18109           required: true
18110           schema:
18111             $ref: "#/definitions/relationship"
18112     delete:
18113       tags:
18114         - ServiceDesignAndCreation
18115       summary: delete an existing relationship
18116       description: delete an existing relationship
18117       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
18118       consumes:
18119         - application/json
18120         - application/xml
18121       produces:
18122         - application/json
18123         - application/xml
18124       responses:
18125         "default":
18126           description: Response codes found in [response codes](https://wiki.onap.org/).
18127       parameters:
18128         - name: model-invariant-id
18129           in: path
18130           description: Unique identifier corresponding to the main definition of a model in ASDC
18131           required: true
18132           type: string
18133           example: __MODEL-INVARIANT-ID__
18134         - name: model-version-id
18135           in: path
18136           description: Unique identifier corresponding to one version of a model in ASDC
18137           required: true
18138           type: string
18139           example: __MODEL-VERSION-ID__
18140         - name: model-element-uuid
18141           in: path
18142           required: true
18143           type: string
18144           example: __MODEL-ELEMENT-UUID__
18145         - name: model-constraint-uuid
18146           in: path
18147           required: true
18148           type: string
18149           example: __MODEL-CONSTRAINT-UUID__
18150         - name: constrained-element-set-uuid
18151           in: path
18152           required: true
18153           type: string
18154           example: __CONSTRAINED-ELEMENT-SET-UUID__
18155         - name: element-choice-set-uuid
18156           in: path
18157           required: true
18158           type: string
18159           example: __ELEMENT-CHOICE-SET-UUID__
18160   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}:
18161     get:
18162       tags:
18163         - ServiceDesignAndCreation
18164       summary: returns element-choice-set
18165       description: returns element-choice-set
18166       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18167       produces:
18168         - application/json
18169         - application/xml
18170       responses:
18171         "200":
18172           description: successful operation
18173           schema:
18174               $ref: "#/getDefinitions/element-choice-set"
18175         "default":
18176           description: Response codes found in [response codes](https://wiki.onap.org/).
18177       parameters:
18178         - name: model-invariant-id
18179           in: path
18180           description: Unique identifier corresponding to the main definition of a model in ASDC
18181           required: true
18182           type: string
18183           example: __MODEL-INVARIANT-ID__
18184         - name: model-version-id
18185           in: path
18186           description: Unique identifier corresponding to one version of a model in ASDC
18187           required: true
18188           type: string
18189           example: __MODEL-VERSION-ID__
18190         - name: model-element-uuid
18191           in: path
18192           required: true
18193           type: string
18194           example: __MODEL-ELEMENT-UUID__
18195         - name: model-constraint-uuid
18196           in: path
18197           required: true
18198           type: string
18199           example: __MODEL-CONSTRAINT-UUID__
18200         - name: constrained-element-set-uuid
18201           in: path
18202           required: true
18203           type: string
18204           example: __CONSTRAINED-ELEMENT-SET-UUID__
18205         - name: element-choice-set-uuid
18206           in: path
18207           required: true
18208           type: string
18209           example: __ELEMENT-CHOICE-SET-UUID__
18210     put:
18211       tags:
18212         - ServiceDesignAndCreation
18213       summary: create or update an existing element-choice-set
18214       description: |
18215         Create or update an existing element-choice-set.
18216         #
18217         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18218       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18219       consumes:
18220         - application/json
18221         - application/xml
18222       produces:
18223         - application/json
18224         - application/xml
18225       responses:
18226         "default":
18227           description: Response codes found in [response codes](https://wiki.onap.org/).
18228       parameters:
18229         - name: model-invariant-id
18230           in: path
18231           description: Unique identifier corresponding to the main definition of a model in ASDC
18232           required: true
18233           type: string
18234           example: __MODEL-INVARIANT-ID__
18235         - name: model-version-id
18236           in: path
18237           description: Unique identifier corresponding to one version of a model in ASDC
18238           required: true
18239           type: string
18240           example: __MODEL-VERSION-ID__
18241         - name: model-element-uuid
18242           in: path
18243           required: true
18244           type: string
18245           example: __MODEL-ELEMENT-UUID__
18246         - name: model-constraint-uuid
18247           in: path
18248           required: true
18249           type: string
18250           example: __MODEL-CONSTRAINT-UUID__
18251         - name: constrained-element-set-uuid
18252           in: path
18253           required: true
18254           type: string
18255           example: __CONSTRAINED-ELEMENT-SET-UUID__
18256         - name: element-choice-set-uuid
18257           in: path
18258           required: true
18259           type: string
18260           example: __ELEMENT-CHOICE-SET-UUID__
18261         - name: body
18262           in: body
18263           description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
18264           required: true
18265           schema:
18266             $ref: "#/definitions/element-choice-set"
18267     patch:
18268       tags:
18269         - ServiceDesignAndCreation
18270       summary: update an existing element-choice-set
18271       description: |
18272         Update an existing element-choice-set
18273         #
18274         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18275         The PUT operation will entirely replace an existing object.
18276         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18277         #
18278         Other differences between PUT and PATCH are:
18279         #
18280         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18281         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18282         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18283       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18284       consumes:
18285         - application/json
18286         - application/xml
18287       produces:
18288         - application/json
18289         - application/xml
18290       responses:
18291         "default":
18292           description: Response codes found in [response codes](https://wiki.onap.org/).
18293       parameters:
18294         - name: model-invariant-id
18295           in: path
18296           description: Unique identifier corresponding to the main definition of a model in ASDC
18297           required: true
18298           type: string
18299           example: __MODEL-INVARIANT-ID__
18300         - name: model-version-id
18301           in: path
18302           description: Unique identifier corresponding to one version of a model in ASDC
18303           required: true
18304           type: string
18305           example: __MODEL-VERSION-ID__
18306         - name: model-element-uuid
18307           in: path
18308           required: true
18309           type: string
18310           example: __MODEL-ELEMENT-UUID__
18311         - name: model-constraint-uuid
18312           in: path
18313           required: true
18314           type: string
18315           example: __MODEL-CONSTRAINT-UUID__
18316         - name: constrained-element-set-uuid
18317           in: path
18318           required: true
18319           type: string
18320           example: __CONSTRAINED-ELEMENT-SET-UUID__
18321         - name: element-choice-set-uuid
18322           in: path
18323           required: true
18324           type: string
18325           example: __ELEMENT-CHOICE-SET-UUID__
18326         - name: body
18327           in: body
18328           description: element-choice-set object that needs to be updated.
18329           required: true
18330           schema:
18331             $ref: "#/patchDefinitions/element-choice-set"
18332     delete:
18333       tags:
18334         - ServiceDesignAndCreation
18335       summary: delete an existing element-choice-set
18336       description: delete an existing element-choice-set
18337       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18338       consumes:
18339         - application/json
18340         - application/xml
18341       produces:
18342         - application/json
18343         - application/xml
18344       responses:
18345         "default":
18346           description: Response codes found in [response codes](https://wiki.onap.org/).
18347       parameters:
18348         - name: model-invariant-id
18349           in: path
18350           description: Unique identifier corresponding to the main definition of a model in ASDC
18351           required: true
18352           type: string
18353           example: __MODEL-INVARIANT-ID__
18354         - name: model-version-id
18355           in: path
18356           description: Unique identifier corresponding to one version of a model in ASDC
18357           required: true
18358           type: string
18359           example: __MODEL-VERSION-ID__
18360         - name: model-element-uuid
18361           in: path
18362           required: true
18363           type: string
18364           example: __MODEL-ELEMENT-UUID__
18365         - name: model-constraint-uuid
18366           in: path
18367           required: true
18368           type: string
18369           example: __MODEL-CONSTRAINT-UUID__
18370         - name: constrained-element-set-uuid
18371           in: path
18372           required: true
18373           type: string
18374           example: __CONSTRAINED-ELEMENT-SET-UUID__
18375         - name: element-choice-set-uuid
18376           in: path
18377           required: true
18378           type: string
18379           example: __ELEMENT-CHOICE-SET-UUID__
18380         - name: resource-version
18381           in: query
18382           description: resource-version for concurrency
18383           required: true
18384           type: string
18385   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets:
18386     get:
18387       tags:
18388         - ServiceDesignAndCreation
18389       summary: returns element-choice-sets
18390       description: returns element-choice-sets
18391       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
18392       produces:
18393         - application/json
18394         - application/xml
18395       responses:
18396         "200":
18397           description: successful operation
18398           schema:
18399               $ref: "#/getDefinitions/element-choice-sets"
18400         "default":
18401           description: Response codes found in [response codes](https://wiki.onap.org/).
18402       parameters:
18403         - name: model-invariant-id
18404           in: path
18405           description: Unique identifier corresponding to the main definition of a model in ASDC
18406           required: true
18407           type: string
18408           example: __MODEL-INVARIANT-ID__
18409         - name: model-version-id
18410           in: path
18411           description: Unique identifier corresponding to one version of a model in ASDC
18412           required: true
18413           type: string
18414           example: __MODEL-VERSION-ID__
18415         - name: model-element-uuid
18416           in: path
18417           required: true
18418           type: string
18419           example: __MODEL-ELEMENT-UUID__
18420         - name: model-constraint-uuid
18421           in: path
18422           required: true
18423           type: string
18424           example: __MODEL-CONSTRAINT-UUID__
18425         - name: constrained-element-set-uuid
18426           in: path
18427           required: true
18428           type: string
18429           example: __CONSTRAINED-ELEMENT-SET-UUID__
18430         - name: element-choice-set-uuid
18431           in: query
18432           description:
18433           required: false
18434           type: string
18435   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship:
18436     put:
18437       tags:
18438         - ServiceDesignAndCreation
18439       summary: see node definition for valid relationships
18440       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
18441       consumes:
18442         - application/json
18443         - application/xml
18444       produces:
18445         - application/json
18446         - application/xml
18447       responses:
18448         "default":
18449           description: Response codes found in [response codes](https://wiki.onap.org/).
18450       parameters:
18451         - name: model-invariant-id
18452           in: path
18453           description: Unique identifier corresponding to the main definition of a model in ASDC
18454           required: true
18455           type: string
18456           example: __MODEL-INVARIANT-ID__
18457         - name: model-version-id
18458           in: path
18459           description: Unique identifier corresponding to one version of a model in ASDC
18460           required: true
18461           type: string
18462           example: __MODEL-VERSION-ID__
18463         - name: model-element-uuid
18464           in: path
18465           required: true
18466           type: string
18467           example: __MODEL-ELEMENT-UUID__
18468         - name: model-constraint-uuid
18469           in: path
18470           required: true
18471           type: string
18472           example: __MODEL-CONSTRAINT-UUID__
18473         - name: constrained-element-set-uuid
18474           in: path
18475           required: true
18476           type: string
18477           example: __CONSTRAINED-ELEMENT-SET-UUID__
18478         - name: body
18479           in: body
18480           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
18481           required: true
18482           schema:
18483             $ref: "#/definitions/relationship"
18484     delete:
18485       tags:
18486         - ServiceDesignAndCreation
18487       summary: delete an existing relationship
18488       description: delete an existing relationship
18489       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
18490       consumes:
18491         - application/json
18492         - application/xml
18493       produces:
18494         - application/json
18495         - application/xml
18496       responses:
18497         "default":
18498           description: Response codes found in [response codes](https://wiki.onap.org/).
18499       parameters:
18500         - name: model-invariant-id
18501           in: path
18502           description: Unique identifier corresponding to the main definition of a model in ASDC
18503           required: true
18504           type: string
18505           example: __MODEL-INVARIANT-ID__
18506         - name: model-version-id
18507           in: path
18508           description: Unique identifier corresponding to one version of a model in ASDC
18509           required: true
18510           type: string
18511           example: __MODEL-VERSION-ID__
18512         - name: model-element-uuid
18513           in: path
18514           required: true
18515           type: string
18516           example: __MODEL-ELEMENT-UUID__
18517         - name: model-constraint-uuid
18518           in: path
18519           required: true
18520           type: string
18521           example: __MODEL-CONSTRAINT-UUID__
18522         - name: constrained-element-set-uuid
18523           in: path
18524           required: true
18525           type: string
18526           example: __CONSTRAINED-ELEMENT-SET-UUID__
18527   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}:
18528     get:
18529       tags:
18530         - ServiceDesignAndCreation
18531       summary: returns constrained-element-set
18532       description: returns constrained-element-set
18533       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18534       produces:
18535         - application/json
18536         - application/xml
18537       responses:
18538         "200":
18539           description: successful operation
18540           schema:
18541               $ref: "#/getDefinitions/constrained-element-set"
18542         "default":
18543           description: Response codes found in [response codes](https://wiki.onap.org/).
18544       parameters:
18545         - name: model-invariant-id
18546           in: path
18547           description: Unique identifier corresponding to the main definition of a model in ASDC
18548           required: true
18549           type: string
18550           example: __MODEL-INVARIANT-ID__
18551         - name: model-version-id
18552           in: path
18553           description: Unique identifier corresponding to one version of a model in ASDC
18554           required: true
18555           type: string
18556           example: __MODEL-VERSION-ID__
18557         - name: model-element-uuid
18558           in: path
18559           required: true
18560           type: string
18561           example: __MODEL-ELEMENT-UUID__
18562         - name: model-constraint-uuid
18563           in: path
18564           required: true
18565           type: string
18566           example: __MODEL-CONSTRAINT-UUID__
18567         - name: constrained-element-set-uuid
18568           in: path
18569           required: true
18570           type: string
18571           example: __CONSTRAINED-ELEMENT-SET-UUID__
18572     put:
18573       tags:
18574         - ServiceDesignAndCreation
18575       summary: create or update an existing constrained-element-set
18576       description: |
18577         Create or update an existing constrained-element-set.
18578         #
18579         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18580       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18581       consumes:
18582         - application/json
18583         - application/xml
18584       produces:
18585         - application/json
18586         - application/xml
18587       responses:
18588         "default":
18589           description: Response codes found in [response codes](https://wiki.onap.org/).
18590       parameters:
18591         - name: model-invariant-id
18592           in: path
18593           description: Unique identifier corresponding to the main definition of a model in ASDC
18594           required: true
18595           type: string
18596           example: __MODEL-INVARIANT-ID__
18597         - name: model-version-id
18598           in: path
18599           description: Unique identifier corresponding to one version of a model in ASDC
18600           required: true
18601           type: string
18602           example: __MODEL-VERSION-ID__
18603         - name: model-element-uuid
18604           in: path
18605           required: true
18606           type: string
18607           example: __MODEL-ELEMENT-UUID__
18608         - name: model-constraint-uuid
18609           in: path
18610           required: true
18611           type: string
18612           example: __MODEL-CONSTRAINT-UUID__
18613         - name: constrained-element-set-uuid
18614           in: path
18615           required: true
18616           type: string
18617           example: __CONSTRAINED-ELEMENT-SET-UUID__
18618         - name: body
18619           in: body
18620           description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
18621           required: true
18622           schema:
18623             $ref: "#/definitions/constrained-element-set"
18624     patch:
18625       tags:
18626         - ServiceDesignAndCreation
18627       summary: update an existing constrained-element-set
18628       description: |
18629         Update an existing constrained-element-set
18630         #
18631         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18632         The PUT operation will entirely replace an existing object.
18633         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18634         #
18635         Other differences between PUT and PATCH are:
18636         #
18637         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18638         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18639         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18640       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18641       consumes:
18642         - application/json
18643         - application/xml
18644       produces:
18645         - application/json
18646         - application/xml
18647       responses:
18648         "default":
18649           description: Response codes found in [response codes](https://wiki.onap.org/).
18650       parameters:
18651         - name: model-invariant-id
18652           in: path
18653           description: Unique identifier corresponding to the main definition of a model in ASDC
18654           required: true
18655           type: string
18656           example: __MODEL-INVARIANT-ID__
18657         - name: model-version-id
18658           in: path
18659           description: Unique identifier corresponding to one version of a model in ASDC
18660           required: true
18661           type: string
18662           example: __MODEL-VERSION-ID__
18663         - name: model-element-uuid
18664           in: path
18665           required: true
18666           type: string
18667           example: __MODEL-ELEMENT-UUID__
18668         - name: model-constraint-uuid
18669           in: path
18670           required: true
18671           type: string
18672           example: __MODEL-CONSTRAINT-UUID__
18673         - name: constrained-element-set-uuid
18674           in: path
18675           required: true
18676           type: string
18677           example: __CONSTRAINED-ELEMENT-SET-UUID__
18678         - name: body
18679           in: body
18680           description: constrained-element-set object that needs to be updated.
18681           required: true
18682           schema:
18683             $ref: "#/patchDefinitions/constrained-element-set"
18684     delete:
18685       tags:
18686         - ServiceDesignAndCreation
18687       summary: delete an existing constrained-element-set
18688       description: delete an existing constrained-element-set
18689       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18690       consumes:
18691         - application/json
18692         - application/xml
18693       produces:
18694         - application/json
18695         - application/xml
18696       responses:
18697         "default":
18698           description: Response codes found in [response codes](https://wiki.onap.org/).
18699       parameters:
18700         - name: model-invariant-id
18701           in: path
18702           description: Unique identifier corresponding to the main definition of a model in ASDC
18703           required: true
18704           type: string
18705           example: __MODEL-INVARIANT-ID__
18706         - name: model-version-id
18707           in: path
18708           description: Unique identifier corresponding to one version of a model in ASDC
18709           required: true
18710           type: string
18711           example: __MODEL-VERSION-ID__
18712         - name: model-element-uuid
18713           in: path
18714           required: true
18715           type: string
18716           example: __MODEL-ELEMENT-UUID__
18717         - name: model-constraint-uuid
18718           in: path
18719           required: true
18720           type: string
18721           example: __MODEL-CONSTRAINT-UUID__
18722         - name: constrained-element-set-uuid
18723           in: path
18724           required: true
18725           type: string
18726           example: __CONSTRAINED-ELEMENT-SET-UUID__
18727         - name: resource-version
18728           in: query
18729           description: resource-version for concurrency
18730           required: true
18731           type: string
18732   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets:
18733     get:
18734       tags:
18735         - ServiceDesignAndCreation
18736       summary: returns constrained-element-sets
18737       description: returns constrained-element-sets
18738       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
18739       produces:
18740         - application/json
18741         - application/xml
18742       responses:
18743         "200":
18744           description: successful operation
18745           schema:
18746               $ref: "#/getDefinitions/constrained-element-sets"
18747         "default":
18748           description: Response codes found in [response codes](https://wiki.onap.org/).
18749       parameters:
18750         - name: model-invariant-id
18751           in: path
18752           description: Unique identifier corresponding to the main definition of a model in ASDC
18753           required: true
18754           type: string
18755           example: __MODEL-INVARIANT-ID__
18756         - name: model-version-id
18757           in: path
18758           description: Unique identifier corresponding to one version of a model in ASDC
18759           required: true
18760           type: string
18761           example: __MODEL-VERSION-ID__
18762         - name: model-element-uuid
18763           in: path
18764           required: true
18765           type: string
18766           example: __MODEL-ELEMENT-UUID__
18767         - name: model-constraint-uuid
18768           in: path
18769           required: true
18770           type: string
18771           example: __MODEL-CONSTRAINT-UUID__
18772         - name: constrained-element-set-uuid
18773           in: query
18774           description:
18775           required: false
18776           type: string
18777   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
18778     get:
18779       tags:
18780         - ServiceDesignAndCreation
18781       summary: returns model-constraint
18782       description: returns model-constraint
18783       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18784       produces:
18785         - application/json
18786         - application/xml
18787       responses:
18788         "200":
18789           description: successful operation
18790           schema:
18791               $ref: "#/getDefinitions/model-constraint"
18792         "default":
18793           description: Response codes found in [response codes](https://wiki.onap.org/).
18794       parameters:
18795         - name: model-invariant-id
18796           in: path
18797           description: Unique identifier corresponding to the main definition of a model in ASDC
18798           required: true
18799           type: string
18800           example: __MODEL-INVARIANT-ID__
18801         - name: model-version-id
18802           in: path
18803           description: Unique identifier corresponding to one version of a model in ASDC
18804           required: true
18805           type: string
18806           example: __MODEL-VERSION-ID__
18807         - name: model-element-uuid
18808           in: path
18809           required: true
18810           type: string
18811           example: __MODEL-ELEMENT-UUID__
18812         - name: model-constraint-uuid
18813           in: path
18814           required: true
18815           type: string
18816           example: __MODEL-CONSTRAINT-UUID__
18817     put:
18818       tags:
18819         - ServiceDesignAndCreation
18820       summary: create or update an existing model-constraint
18821       description: |
18822         Create or update an existing model-constraint.
18823         #
18824         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18825       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18826       consumes:
18827         - application/json
18828         - application/xml
18829       produces:
18830         - application/json
18831         - application/xml
18832       responses:
18833         "default":
18834           description: Response codes found in [response codes](https://wiki.onap.org/).
18835       parameters:
18836         - name: model-invariant-id
18837           in: path
18838           description: Unique identifier corresponding to the main definition of a model in ASDC
18839           required: true
18840           type: string
18841           example: __MODEL-INVARIANT-ID__
18842         - name: model-version-id
18843           in: path
18844           description: Unique identifier corresponding to one version of a model in ASDC
18845           required: true
18846           type: string
18847           example: __MODEL-VERSION-ID__
18848         - name: model-element-uuid
18849           in: path
18850           required: true
18851           type: string
18852           example: __MODEL-ELEMENT-UUID__
18853         - name: model-constraint-uuid
18854           in: path
18855           required: true
18856           type: string
18857           example: __MODEL-CONSTRAINT-UUID__
18858         - name: body
18859           in: body
18860           description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
18861           required: true
18862           schema:
18863             $ref: "#/definitions/model-constraint"
18864     patch:
18865       tags:
18866         - ServiceDesignAndCreation
18867       summary: update an existing model-constraint
18868       description: |
18869         Update an existing model-constraint
18870         #
18871         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18872         The PUT operation will entirely replace an existing object.
18873         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18874         #
18875         Other differences between PUT and PATCH are:
18876         #
18877         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18878         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18879         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18880       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18881       consumes:
18882         - application/json
18883         - application/xml
18884       produces:
18885         - application/json
18886         - application/xml
18887       responses:
18888         "default":
18889           description: Response codes found in [response codes](https://wiki.onap.org/).
18890       parameters:
18891         - name: model-invariant-id
18892           in: path
18893           description: Unique identifier corresponding to the main definition of a model in ASDC
18894           required: true
18895           type: string
18896           example: __MODEL-INVARIANT-ID__
18897         - name: model-version-id
18898           in: path
18899           description: Unique identifier corresponding to one version of a model in ASDC
18900           required: true
18901           type: string
18902           example: __MODEL-VERSION-ID__
18903         - name: model-element-uuid
18904           in: path
18905           required: true
18906           type: string
18907           example: __MODEL-ELEMENT-UUID__
18908         - name: model-constraint-uuid
18909           in: path
18910           required: true
18911           type: string
18912           example: __MODEL-CONSTRAINT-UUID__
18913         - name: body
18914           in: body
18915           description: model-constraint object that needs to be updated.
18916           required: true
18917           schema:
18918             $ref: "#/patchDefinitions/model-constraint"
18919     delete:
18920       tags:
18921         - ServiceDesignAndCreation
18922       summary: delete an existing model-constraint
18923       description: delete an existing model-constraint
18924       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18925       consumes:
18926         - application/json
18927         - application/xml
18928       produces:
18929         - application/json
18930         - application/xml
18931       responses:
18932         "default":
18933           description: Response codes found in [response codes](https://wiki.onap.org/).
18934       parameters:
18935         - name: model-invariant-id
18936           in: path
18937           description: Unique identifier corresponding to the main definition of a model in ASDC
18938           required: true
18939           type: string
18940           example: __MODEL-INVARIANT-ID__
18941         - name: model-version-id
18942           in: path
18943           description: Unique identifier corresponding to one version of a model in ASDC
18944           required: true
18945           type: string
18946           example: __MODEL-VERSION-ID__
18947         - name: model-element-uuid
18948           in: path
18949           required: true
18950           type: string
18951           example: __MODEL-ELEMENT-UUID__
18952         - name: model-constraint-uuid
18953           in: path
18954           required: true
18955           type: string
18956           example: __MODEL-CONSTRAINT-UUID__
18957         - name: resource-version
18958           in: query
18959           description: resource-version for concurrency
18960           required: true
18961           type: string
18962   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints:
18963     get:
18964       tags:
18965         - ServiceDesignAndCreation
18966       summary: returns model-constraints
18967       description: returns model-constraints
18968       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
18969       produces:
18970         - application/json
18971         - application/xml
18972       responses:
18973         "200":
18974           description: successful operation
18975           schema:
18976               $ref: "#/getDefinitions/model-constraints"
18977         "default":
18978           description: Response codes found in [response codes](https://wiki.onap.org/).
18979       parameters:
18980         - name: model-invariant-id
18981           in: path
18982           description: Unique identifier corresponding to the main definition of a model in ASDC
18983           required: true
18984           type: string
18985           example: __MODEL-INVARIANT-ID__
18986         - name: model-version-id
18987           in: path
18988           description: Unique identifier corresponding to one version of a model in ASDC
18989           required: true
18990           type: string
18991           example: __MODEL-VERSION-ID__
18992         - name: model-element-uuid
18993           in: path
18994           required: true
18995           type: string
18996           example: __MODEL-ELEMENT-UUID__
18997         - name: model-constraint-uuid
18998           in: query
18999           description:
19000           required: false
19001           type: string
19002   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship:
19003     put:
19004       tags:
19005         - ServiceDesignAndCreation
19006       summary: see node definition for valid relationships
19007       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
19008       consumes:
19009         - application/json
19010         - application/xml
19011       produces:
19012         - application/json
19013         - application/xml
19014       responses:
19015         "default":
19016           description: Response codes found in [response codes](https://wiki.onap.org/).
19017       parameters:
19018         - name: model-invariant-id
19019           in: path
19020           description: Unique identifier corresponding to the main definition of a model in ASDC
19021           required: true
19022           type: string
19023           example: __MODEL-INVARIANT-ID__
19024         - name: model-version-id
19025           in: path
19026           description: Unique identifier corresponding to one version of a model in ASDC
19027           required: true
19028           type: string
19029           example: __MODEL-VERSION-ID__
19030         - name: model-element-uuid
19031           in: path
19032           required: true
19033           type: string
19034           example: __MODEL-ELEMENT-UUID__
19035         - name: body
19036           in: body
19037           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
19038           required: true
19039           schema:
19040             $ref: "#/definitions/relationship"
19041     delete:
19042       tags:
19043         - ServiceDesignAndCreation
19044       summary: delete an existing relationship
19045       description: delete an existing relationship
19046       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
19047       consumes:
19048         - application/json
19049         - application/xml
19050       produces:
19051         - application/json
19052         - application/xml
19053       responses:
19054         "default":
19055           description: Response codes found in [response codes](https://wiki.onap.org/).
19056       parameters:
19057         - name: model-invariant-id
19058           in: path
19059           description: Unique identifier corresponding to the main definition of a model in ASDC
19060           required: true
19061           type: string
19062           example: __MODEL-INVARIANT-ID__
19063         - name: model-version-id
19064           in: path
19065           description: Unique identifier corresponding to one version of a model in ASDC
19066           required: true
19067           type: string
19068           example: __MODEL-VERSION-ID__
19069         - name: model-element-uuid
19070           in: path
19071           required: true
19072           type: string
19073           example: __MODEL-ELEMENT-UUID__
19074   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
19075     get:
19076       tags:
19077         - ServiceDesignAndCreation
19078       summary: returns model-element
19079       description: returns model-element
19080       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19081       produces:
19082         - application/json
19083         - application/xml
19084       responses:
19085         "200":
19086           description: successful operation
19087           schema:
19088               $ref: "#/getDefinitions/model-element"
19089         "default":
19090           description: Response codes found in [response codes](https://wiki.onap.org/).
19091       parameters:
19092         - name: model-invariant-id
19093           in: path
19094           description: Unique identifier corresponding to the main definition of a model in ASDC
19095           required: true
19096           type: string
19097           example: __MODEL-INVARIANT-ID__
19098         - name: model-version-id
19099           in: path
19100           description: Unique identifier corresponding to one version of a model in ASDC
19101           required: true
19102           type: string
19103           example: __MODEL-VERSION-ID__
19104         - name: model-element-uuid
19105           in: path
19106           required: true
19107           type: string
19108           example: __MODEL-ELEMENT-UUID__
19109     put:
19110       tags:
19111         - ServiceDesignAndCreation
19112       summary: create or update an existing model-element
19113       description: |
19114         Create or update an existing model-element.
19115         #
19116         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19117       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19118       consumes:
19119         - application/json
19120         - application/xml
19121       produces:
19122         - application/json
19123         - application/xml
19124       responses:
19125         "default":
19126           description: Response codes found in [response codes](https://wiki.onap.org/).
19127       parameters:
19128         - name: model-invariant-id
19129           in: path
19130           description: Unique identifier corresponding to the main definition of a model in ASDC
19131           required: true
19132           type: string
19133           example: __MODEL-INVARIANT-ID__
19134         - name: model-version-id
19135           in: path
19136           description: Unique identifier corresponding to one version of a model in ASDC
19137           required: true
19138           type: string
19139           example: __MODEL-VERSION-ID__
19140         - name: model-element-uuid
19141           in: path
19142           required: true
19143           type: string
19144           example: __MODEL-ELEMENT-UUID__
19145         - name: body
19146           in: body
19147           description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
19148           required: true
19149           schema:
19150             $ref: "#/definitions/model-element"
19151     patch:
19152       tags:
19153         - ServiceDesignAndCreation
19154       summary: update an existing model-element
19155       description: |
19156         Update an existing model-element
19157         #
19158         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19159         The PUT operation will entirely replace an existing object.
19160         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19161         #
19162         Other differences between PUT and PATCH are:
19163         #
19164         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19165         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19166         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19167       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19168       consumes:
19169         - application/json
19170         - application/xml
19171       produces:
19172         - application/json
19173         - application/xml
19174       responses:
19175         "default":
19176           description: Response codes found in [response codes](https://wiki.onap.org/).
19177       parameters:
19178         - name: model-invariant-id
19179           in: path
19180           description: Unique identifier corresponding to the main definition of a model in ASDC
19181           required: true
19182           type: string
19183           example: __MODEL-INVARIANT-ID__
19184         - name: model-version-id
19185           in: path
19186           description: Unique identifier corresponding to one version of a model in ASDC
19187           required: true
19188           type: string
19189           example: __MODEL-VERSION-ID__
19190         - name: model-element-uuid
19191           in: path
19192           required: true
19193           type: string
19194           example: __MODEL-ELEMENT-UUID__
19195         - name: body
19196           in: body
19197           description: model-element object that needs to be updated.
19198           required: true
19199           schema:
19200             $ref: "#/patchDefinitions/model-element"
19201     delete:
19202       tags:
19203         - ServiceDesignAndCreation
19204       summary: delete an existing model-element
19205       description: delete an existing model-element
19206       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19207       consumes:
19208         - application/json
19209         - application/xml
19210       produces:
19211         - application/json
19212         - application/xml
19213       responses:
19214         "default":
19215           description: Response codes found in [response codes](https://wiki.onap.org/).
19216       parameters:
19217         - name: model-invariant-id
19218           in: path
19219           description: Unique identifier corresponding to the main definition of a model in ASDC
19220           required: true
19221           type: string
19222           example: __MODEL-INVARIANT-ID__
19223         - name: model-version-id
19224           in: path
19225           description: Unique identifier corresponding to one version of a model in ASDC
19226           required: true
19227           type: string
19228           example: __MODEL-VERSION-ID__
19229         - name: model-element-uuid
19230           in: path
19231           required: true
19232           type: string
19233           example: __MODEL-ELEMENT-UUID__
19234         - name: resource-version
19235           in: query
19236           description: resource-version for concurrency
19237           required: true
19238           type: string
19239   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
19240     get:
19241       tags:
19242         - ServiceDesignAndCreation
19243       summary: returns model-elements
19244       description: returns model-elements
19245       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
19246       produces:
19247         - application/json
19248         - application/xml
19249       responses:
19250         "200":
19251           description: successful operation
19252           schema:
19253               $ref: "#/getDefinitions/model-elements"
19254         "default":
19255           description: Response codes found in [response codes](https://wiki.onap.org/).
19256       parameters:
19257         - name: model-invariant-id
19258           in: path
19259           description: Unique identifier corresponding to the main definition of a model in ASDC
19260           required: true
19261           type: string
19262           example: __MODEL-INVARIANT-ID__
19263         - name: model-version-id
19264           in: path
19265           description: Unique identifier corresponding to one version of a model in ASDC
19266           required: true
19267           type: string
19268           example: __MODEL-VERSION-ID__
19269         - name: model-element-uuid
19270           in: query
19271           description:
19272           required: false
19273           type: string
19274   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
19275     get:
19276       tags:
19277         - ServiceDesignAndCreation
19278       summary: returns metadatum
19279       description: returns metadatum
19280       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19281       produces:
19282         - application/json
19283         - application/xml
19284       responses:
19285         "200":
19286           description: successful operation
19287           schema:
19288               $ref: "#/getDefinitions/metadatum"
19289         "default":
19290           description: Response codes found in [response codes](https://wiki.onap.org/).
19291       parameters:
19292         - name: model-invariant-id
19293           in: path
19294           description: Unique identifier corresponding to the main definition of a model in ASDC
19295           required: true
19296           type: string
19297           example: __MODEL-INVARIANT-ID__
19298         - name: model-version-id
19299           in: path
19300           description: Unique identifier corresponding to one version of a model in ASDC
19301           required: true
19302           type: string
19303           example: __MODEL-VERSION-ID__
19304         - name: metaname
19305           in: path
19306           required: true
19307           type: string
19308           example: __METANAME__
19309     put:
19310       tags:
19311         - ServiceDesignAndCreation
19312       summary: create or update an existing metadatum
19313       description: |
19314         Create or update an existing metadatum.
19315         #
19316         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19317       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19318       consumes:
19319         - application/json
19320         - application/xml
19321       produces:
19322         - application/json
19323         - application/xml
19324       responses:
19325         "default":
19326           description: Response codes found in [response codes](https://wiki.onap.org/).
19327       parameters:
19328         - name: model-invariant-id
19329           in: path
19330           description: Unique identifier corresponding to the main definition of a model in ASDC
19331           required: true
19332           type: string
19333           example: __MODEL-INVARIANT-ID__
19334         - name: model-version-id
19335           in: path
19336           description: Unique identifier corresponding to one version of a model in ASDC
19337           required: true
19338           type: string
19339           example: __MODEL-VERSION-ID__
19340         - name: metaname
19341           in: path
19342           required: true
19343           type: string
19344           example: __METANAME__
19345         - name: body
19346           in: body
19347           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
19348           required: true
19349           schema:
19350             $ref: "#/definitions/metadatum"
19351     patch:
19352       tags:
19353         - ServiceDesignAndCreation
19354       summary: update an existing metadatum
19355       description: |
19356         Update an existing metadatum
19357         #
19358         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19359         The PUT operation will entirely replace an existing object.
19360         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19361         #
19362         Other differences between PUT and PATCH are:
19363         #
19364         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19365         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19366         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19367       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19368       consumes:
19369         - application/json
19370         - application/xml
19371       produces:
19372         - application/json
19373         - application/xml
19374       responses:
19375         "default":
19376           description: Response codes found in [response codes](https://wiki.onap.org/).
19377       parameters:
19378         - name: model-invariant-id
19379           in: path
19380           description: Unique identifier corresponding to the main definition of a model in ASDC
19381           required: true
19382           type: string
19383           example: __MODEL-INVARIANT-ID__
19384         - name: model-version-id
19385           in: path
19386           description: Unique identifier corresponding to one version of a model in ASDC
19387           required: true
19388           type: string
19389           example: __MODEL-VERSION-ID__
19390         - name: metaname
19391           in: path
19392           required: true
19393           type: string
19394           example: __METANAME__
19395         - name: body
19396           in: body
19397           description: metadatum object that needs to be updated.
19398           required: true
19399           schema:
19400             $ref: "#/patchDefinitions/metadatum"
19401     delete:
19402       tags:
19403         - ServiceDesignAndCreation
19404       summary: delete an existing metadatum
19405       description: delete an existing metadatum
19406       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19407       consumes:
19408         - application/json
19409         - application/xml
19410       produces:
19411         - application/json
19412         - application/xml
19413       responses:
19414         "default":
19415           description: Response codes found in [response codes](https://wiki.onap.org/).
19416       parameters:
19417         - name: model-invariant-id
19418           in: path
19419           description: Unique identifier corresponding to the main definition of a model in ASDC
19420           required: true
19421           type: string
19422           example: __MODEL-INVARIANT-ID__
19423         - name: model-version-id
19424           in: path
19425           description: Unique identifier corresponding to one version of a model in ASDC
19426           required: true
19427           type: string
19428           example: __MODEL-VERSION-ID__
19429         - name: metaname
19430           in: path
19431           required: true
19432           type: string
19433           example: __METANAME__
19434         - name: resource-version
19435           in: query
19436           description: resource-version for concurrency
19437           required: true
19438           type: string
19439   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
19440     get:
19441       tags:
19442         - ServiceDesignAndCreation
19443       summary: returns metadata
19444       description: returns metadata
19445       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
19446       produces:
19447         - application/json
19448         - application/xml
19449       responses:
19450         "200":
19451           description: successful operation
19452           schema:
19453               $ref: "#/getDefinitions/metadata"
19454         "default":
19455           description: Response codes found in [response codes](https://wiki.onap.org/).
19456       parameters:
19457         - name: model-invariant-id
19458           in: path
19459           description: Unique identifier corresponding to the main definition of a model in ASDC
19460           required: true
19461           type: string
19462           example: __MODEL-INVARIANT-ID__
19463         - name: model-version-id
19464           in: path
19465           description: Unique identifier corresponding to one version of a model in ASDC
19466           required: true
19467           type: string
19468           example: __MODEL-VERSION-ID__
19469         - name: metaname
19470           in: query
19471           description:
19472           required: false
19473           type: string
19474   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
19475     put:
19476       tags:
19477         - ServiceDesignAndCreation
19478       summary: see node definition for valid relationships
19479       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
19480       consumes:
19481         - application/json
19482         - application/xml
19483       produces:
19484         - application/json
19485         - application/xml
19486       responses:
19487         "default":
19488           description: Response codes found in [response codes](https://wiki.onap.org/).
19489       parameters:
19490         - name: model-invariant-id
19491           in: path
19492           description: Unique identifier corresponding to the main definition of a model in ASDC
19493           required: true
19494           type: string
19495           example: __MODEL-INVARIANT-ID__
19496         - name: model-version-id
19497           in: path
19498           description: Unique identifier corresponding to one version of a model in ASDC
19499           required: true
19500           type: string
19501           example: __MODEL-VERSION-ID__
19502         - name: body
19503           in: body
19504           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
19505           required: true
19506           schema:
19507             $ref: "#/definitions/relationship"
19508     delete:
19509       tags:
19510         - ServiceDesignAndCreation
19511       summary: delete an existing relationship
19512       description: delete an existing relationship
19513       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
19514       consumes:
19515         - application/json
19516         - application/xml
19517       produces:
19518         - application/json
19519         - application/xml
19520       responses:
19521         "default":
19522           description: Response codes found in [response codes](https://wiki.onap.org/).
19523       parameters:
19524         - name: model-invariant-id
19525           in: path
19526           description: Unique identifier corresponding to the main definition of a model in ASDC
19527           required: true
19528           type: string
19529           example: __MODEL-INVARIANT-ID__
19530         - name: model-version-id
19531           in: path
19532           description: Unique identifier corresponding to one version of a model in ASDC
19533           required: true
19534           type: string
19535           example: __MODEL-VERSION-ID__
19536   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
19537     get:
19538       tags:
19539         - ServiceDesignAndCreation
19540       summary: returns model-ver
19541       description: returns model-ver
19542       operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
19543       produces:
19544         - application/json
19545         - application/xml
19546       responses:
19547         "200":
19548           description: successful operation
19549           schema:
19550               $ref: "#/getDefinitions/model-ver"
19551         "default":
19552           description: Response codes found in [response codes](https://wiki.onap.org/).
19553       parameters:
19554         - name: model-invariant-id
19555           in: path
19556           description: Unique identifier corresponding to the main definition of a model in ASDC
19557           required: true
19558           type: string
19559           example: __MODEL-INVARIANT-ID__
19560         - name: model-version-id
19561           in: path
19562           description: Unique identifier corresponding to one version of a model in ASDC
19563           required: true
19564           type: string
19565           example: __MODEL-VERSION-ID__
19566     put:
19567       tags:
19568         - ServiceDesignAndCreation
19569       summary: create or update an existing model-ver
19570       description: |
19571         Create or update an existing model-ver.
19572         #
19573         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19574       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
19575       consumes:
19576         - application/json
19577         - application/xml
19578       produces:
19579         - application/json
19580         - application/xml
19581       responses:
19582         "default":
19583           description: Response codes found in [response codes](https://wiki.onap.org/).
19584       parameters:
19585         - name: model-invariant-id
19586           in: path
19587           description: Unique identifier corresponding to the main definition of a model in ASDC
19588           required: true
19589           type: string
19590           example: __MODEL-INVARIANT-ID__
19591         - name: model-version-id
19592           in: path
19593           description: Unique identifier corresponding to one version of a model in ASDC
19594           required: true
19595           type: string
19596           example: __MODEL-VERSION-ID__
19597         - name: body
19598           in: body
19599           description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
19600           required: true
19601           schema:
19602             $ref: "#/definitions/model-ver"
19603     patch:
19604       tags:
19605         - ServiceDesignAndCreation
19606       summary: update an existing model-ver
19607       description: |
19608         Update an existing model-ver
19609         #
19610         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19611         The PUT operation will entirely replace an existing object.
19612         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19613         #
19614         Other differences between PUT and PATCH are:
19615         #
19616         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19617         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19618         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19619       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
19620       consumes:
19621         - application/json
19622         - application/xml
19623       produces:
19624         - application/json
19625         - application/xml
19626       responses:
19627         "default":
19628           description: Response codes found in [response codes](https://wiki.onap.org/).
19629       parameters:
19630         - name: model-invariant-id
19631           in: path
19632           description: Unique identifier corresponding to the main definition of a model in ASDC
19633           required: true
19634           type: string
19635           example: __MODEL-INVARIANT-ID__
19636         - name: model-version-id
19637           in: path
19638           description: Unique identifier corresponding to one version of a model in ASDC
19639           required: true
19640           type: string
19641           example: __MODEL-VERSION-ID__
19642         - name: body
19643           in: body
19644           description: model-ver object that needs to be updated.
19645           required: true
19646           schema:
19647             $ref: "#/patchDefinitions/model-ver"
19648     delete:
19649       tags:
19650         - ServiceDesignAndCreation
19651       summary: delete an existing model-ver
19652       description: delete an existing model-ver
19653       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
19654       consumes:
19655         - application/json
19656         - application/xml
19657       produces:
19658         - application/json
19659         - application/xml
19660       responses:
19661         "default":
19662           description: Response codes found in [response codes](https://wiki.onap.org/).
19663       parameters:
19664         - name: model-invariant-id
19665           in: path
19666           description: Unique identifier corresponding to the main definition of a model in ASDC
19667           required: true
19668           type: string
19669           example: __MODEL-INVARIANT-ID__
19670         - name: model-version-id
19671           in: path
19672           description: Unique identifier corresponding to one version of a model in ASDC
19673           required: true
19674           type: string
19675           example: __MODEL-VERSION-ID__
19676         - name: resource-version
19677           in: query
19678           description: resource-version for concurrency
19679           required: true
19680           type: string
19681   /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
19682     get:
19683       tags:
19684         - ServiceDesignAndCreation
19685       summary: returns model-vers
19686       description: returns model-vers
19687       operationId: getServiceDesignAndCreationModelsModelModelVers
19688       produces:
19689         - application/json
19690         - application/xml
19691       responses:
19692         "200":
19693           description: successful operation
19694           schema:
19695               $ref: "#/getDefinitions/model-vers"
19696         "default":
19697           description: Response codes found in [response codes](https://wiki.onap.org/).
19698       parameters:
19699         - name: model-invariant-id
19700           in: path
19701           description: Unique identifier corresponding to the main definition of a model in ASDC
19702           required: true
19703           type: string
19704           example: __MODEL-INVARIANT-ID__
19705         - name: model-version-id
19706           in: query
19707           description:
19708           required: false
19709           type: string
19710         - name: model-name
19711           in: query
19712           description:
19713           required: false
19714           type: string
19715         - name: model-version
19716           in: query
19717           description:
19718           required: false
19719           type: string
19720         - name: distribution-status
19721           in: query
19722           description:
19723           required: false
19724           type: string
19725   /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
19726     put:
19727       tags:
19728         - ServiceDesignAndCreation
19729       summary: see node definition for valid relationships
19730       operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
19731       consumes:
19732         - application/json
19733         - application/xml
19734       produces:
19735         - application/json
19736         - application/xml
19737       responses:
19738         "default":
19739           description: Response codes found in [response codes](https://wiki.onap.org/).
19740       parameters:
19741         - name: model-invariant-id
19742           in: path
19743           description: Unique identifier corresponding to the main definition of a model in ASDC
19744           required: true
19745           type: string
19746           example: __MODEL-INVARIANT-ID__
19747         - name: body
19748           in: body
19749           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json)
19750           required: true
19751           schema:
19752             $ref: "#/definitions/relationship"
19753     delete:
19754       tags:
19755         - ServiceDesignAndCreation
19756       summary: delete an existing relationship
19757       description: delete an existing relationship
19758       operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
19759       consumes:
19760         - application/json
19761         - application/xml
19762       produces:
19763         - application/json
19764         - application/xml
19765       responses:
19766         "default":
19767           description: Response codes found in [response codes](https://wiki.onap.org/).
19768       parameters:
19769         - name: model-invariant-id
19770           in: path
19771           description: Unique identifier corresponding to the main definition of a model in ASDC
19772           required: true
19773           type: string
19774           example: __MODEL-INVARIANT-ID__
19775   /service-design-and-creation/models/model/{model-invariant-id}:
19776     get:
19777       tags:
19778         - ServiceDesignAndCreation
19779       summary: returns model
19780       description: returns model
19781       operationId: getServiceDesignAndCreationModelsModel
19782       produces:
19783         - application/json
19784         - application/xml
19785       responses:
19786         "200":
19787           description: successful operation
19788           schema:
19789               $ref: "#/getDefinitions/model"
19790         "default":
19791           description: Response codes found in [response codes](https://wiki.onap.org/).
19792       parameters:
19793         - name: model-invariant-id
19794           in: path
19795           description: Unique identifier corresponding to the main definition of a model in ASDC
19796           required: true
19797           type: string
19798           example: __MODEL-INVARIANT-ID__
19799     put:
19800       tags:
19801         - ServiceDesignAndCreation
19802       summary: create or update an existing model
19803       description: |
19804         Create or update an existing model.
19805         #
19806         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19807       operationId: createOrUpdateServiceDesignAndCreationModelsModel
19808       consumes:
19809         - application/json
19810         - application/xml
19811       produces:
19812         - application/json
19813         - application/xml
19814       responses:
19815         "default":
19816           description: Response codes found in [response codes](https://wiki.onap.org/).
19817       parameters:
19818         - name: model-invariant-id
19819           in: path
19820           description: Unique identifier corresponding to the main definition of a model in ASDC
19821           required: true
19822           type: string
19823           example: __MODEL-INVARIANT-ID__
19824         - name: body
19825           in: body
19826           description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json)
19827           required: true
19828           schema:
19829             $ref: "#/definitions/model"
19830     patch:
19831       tags:
19832         - ServiceDesignAndCreation
19833       summary: update an existing model
19834       description: |
19835         Update an existing model
19836         #
19837         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19838         The PUT operation will entirely replace an existing object.
19839         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19840         #
19841         Other differences between PUT and PATCH are:
19842         #
19843         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19844         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19845         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19846       operationId: UpdateServiceDesignAndCreationModelsModel
19847       consumes:
19848         - application/json
19849         - application/xml
19850       produces:
19851         - application/json
19852         - application/xml
19853       responses:
19854         "default":
19855           description: Response codes found in [response codes](https://wiki.onap.org/).
19856       parameters:
19857         - name: model-invariant-id
19858           in: path
19859           description: Unique identifier corresponding to the main definition of a model in ASDC
19860           required: true
19861           type: string
19862           example: __MODEL-INVARIANT-ID__
19863         - name: body
19864           in: body
19865           description: model object that needs to be updated.
19866           required: true
19867           schema:
19868             $ref: "#/patchDefinitions/model"
19869     delete:
19870       tags:
19871         - ServiceDesignAndCreation
19872       summary: delete an existing model
19873       description: delete an existing model
19874       operationId: deleteServiceDesignAndCreationModelsModel
19875       consumes:
19876         - application/json
19877         - application/xml
19878       produces:
19879         - application/json
19880         - application/xml
19881       responses:
19882         "default":
19883           description: Response codes found in [response codes](https://wiki.onap.org/).
19884       parameters:
19885         - name: model-invariant-id
19886           in: path
19887           description: Unique identifier corresponding to the main definition of a model in ASDC
19888           required: true
19889           type: string
19890           example: __MODEL-INVARIANT-ID__
19891         - name: resource-version
19892           in: query
19893           description: resource-version for concurrency
19894           required: true
19895           type: string
19896   /service-design-and-creation/models:
19897     get:
19898       tags:
19899         - ServiceDesignAndCreation
19900       summary: returns models
19901       description: returns models
19902       operationId: getServiceDesignAndCreationModels
19903       produces:
19904         - application/json
19905         - application/xml
19906       responses:
19907         "200":
19908           description: successful operation
19909           schema:
19910               $ref: "#/getDefinitions/models"
19911         "default":
19912           description: Response codes found in [response codes](https://wiki.onap.org/).
19913       parameters:
19914         - name: model-invariant-id
19915           in: query
19916           description:
19917           required: false
19918           type: string
19919         - name: model-type
19920           in: query
19921           description:
19922           required: false
19923           type: string
19924   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship:
19925     put:
19926       tags:
19927         - ServiceDesignAndCreation
19928       summary: see node definition for valid relationships
19929       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
19930       consumes:
19931         - application/json
19932         - application/xml
19933       produces:
19934         - application/json
19935         - application/xml
19936       responses:
19937         "default":
19938           description: Response codes found in [response codes](https://wiki.onap.org/).
19939       parameters:
19940         - name: named-query-uuid
19941           in: path
19942           required: true
19943           type: string
19944           example: __NAMED-QUERY-UUID__
19945         - name: named-query-element-uuid
19946           in: path
19947           required: true
19948           type: string
19949           example: __NAMED-QUERY-ELEMENT-UUID__
19950         - name: related-lookup-uuid
19951           in: path
19952           required: true
19953           type: string
19954           example: __RELATED-LOOKUP-UUID__
19955         - name: body
19956           in: body
19957           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
19958           required: true
19959           schema:
19960             $ref: "#/definitions/relationship"
19961     delete:
19962       tags:
19963         - ServiceDesignAndCreation
19964       summary: delete an existing relationship
19965       description: delete an existing relationship
19966       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
19967       consumes:
19968         - application/json
19969         - application/xml
19970       produces:
19971         - application/json
19972         - application/xml
19973       responses:
19974         "default":
19975           description: Response codes found in [response codes](https://wiki.onap.org/).
19976       parameters:
19977         - name: named-query-uuid
19978           in: path
19979           required: true
19980           type: string
19981           example: __NAMED-QUERY-UUID__
19982         - name: named-query-element-uuid
19983           in: path
19984           required: true
19985           type: string
19986           example: __NAMED-QUERY-ELEMENT-UUID__
19987         - name: related-lookup-uuid
19988           in: path
19989           required: true
19990           type: string
19991           example: __RELATED-LOOKUP-UUID__
19992   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}:
19993     get:
19994       tags:
19995         - ServiceDesignAndCreation
19996       summary: returns related-lookup
19997       description: returns related-lookup
19998       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19999       produces:
20000         - application/json
20001         - application/xml
20002       responses:
20003         "200":
20004           description: successful operation
20005           schema:
20006               $ref: "#/getDefinitions/related-lookup"
20007         "default":
20008           description: Response codes found in [response codes](https://wiki.onap.org/).
20009       parameters:
20010         - name: named-query-uuid
20011           in: path
20012           required: true
20013           type: string
20014           example: __NAMED-QUERY-UUID__
20015         - name: named-query-element-uuid
20016           in: path
20017           required: true
20018           type: string
20019           example: __NAMED-QUERY-ELEMENT-UUID__
20020         - name: related-lookup-uuid
20021           in: path
20022           required: true
20023           type: string
20024           example: __RELATED-LOOKUP-UUID__
20025     put:
20026       tags:
20027         - ServiceDesignAndCreation
20028       summary: create or update an existing related-lookup
20029       description: |
20030         Create or update an existing related-lookup.
20031         #
20032         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20033       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
20034       consumes:
20035         - application/json
20036         - application/xml
20037       produces:
20038         - application/json
20039         - application/xml
20040       responses:
20041         "default":
20042           description: Response codes found in [response codes](https://wiki.onap.org/).
20043       parameters:
20044         - name: named-query-uuid
20045           in: path
20046           required: true
20047           type: string
20048           example: __NAMED-QUERY-UUID__
20049         - name: named-query-element-uuid
20050           in: path
20051           required: true
20052           type: string
20053           example: __NAMED-QUERY-ELEMENT-UUID__
20054         - name: related-lookup-uuid
20055           in: path
20056           required: true
20057           type: string
20058           example: __RELATED-LOOKUP-UUID__
20059         - name: body
20060           in: body
20061           description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
20062           required: true
20063           schema:
20064             $ref: "#/definitions/related-lookup"
20065     patch:
20066       tags:
20067         - ServiceDesignAndCreation
20068       summary: update an existing related-lookup
20069       description: |
20070         Update an existing related-lookup
20071         #
20072         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20073         The PUT operation will entirely replace an existing object.
20074         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20075         #
20076         Other differences between PUT and PATCH are:
20077         #
20078         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20079         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20080         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20081       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
20082       consumes:
20083         - application/json
20084         - application/xml
20085       produces:
20086         - application/json
20087         - application/xml
20088       responses:
20089         "default":
20090           description: Response codes found in [response codes](https://wiki.onap.org/).
20091       parameters:
20092         - name: named-query-uuid
20093           in: path
20094           required: true
20095           type: string
20096           example: __NAMED-QUERY-UUID__
20097         - name: named-query-element-uuid
20098           in: path
20099           required: true
20100           type: string
20101           example: __NAMED-QUERY-ELEMENT-UUID__
20102         - name: related-lookup-uuid
20103           in: path
20104           required: true
20105           type: string
20106           example: __RELATED-LOOKUP-UUID__
20107         - name: body
20108           in: body
20109           description: related-lookup object that needs to be updated.
20110           required: true
20111           schema:
20112             $ref: "#/patchDefinitions/related-lookup"
20113     delete:
20114       tags:
20115         - ServiceDesignAndCreation
20116       summary: delete an existing related-lookup
20117       description: delete an existing related-lookup
20118       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
20119       consumes:
20120         - application/json
20121         - application/xml
20122       produces:
20123         - application/json
20124         - application/xml
20125       responses:
20126         "default":
20127           description: Response codes found in [response codes](https://wiki.onap.org/).
20128       parameters:
20129         - name: named-query-uuid
20130           in: path
20131           required: true
20132           type: string
20133           example: __NAMED-QUERY-UUID__
20134         - name: named-query-element-uuid
20135           in: path
20136           required: true
20137           type: string
20138           example: __NAMED-QUERY-ELEMENT-UUID__
20139         - name: related-lookup-uuid
20140           in: path
20141           required: true
20142           type: string
20143           example: __RELATED-LOOKUP-UUID__
20144         - name: resource-version
20145           in: query
20146           description: resource-version for concurrency
20147           required: true
20148           type: string
20149   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
20150     get:
20151       tags:
20152         - ServiceDesignAndCreation
20153       summary: returns related-lookups
20154       description: returns related-lookups
20155       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
20156       produces:
20157         - application/json
20158         - application/xml
20159       responses:
20160         "200":
20161           description: successful operation
20162           schema:
20163               $ref: "#/getDefinitions/related-lookups"
20164         "default":
20165           description: Response codes found in [response codes](https://wiki.onap.org/).
20166       parameters:
20167         - name: named-query-uuid
20168           in: path
20169           required: true
20170           type: string
20171           example: __NAMED-QUERY-UUID__
20172         - name: named-query-element-uuid
20173           in: path
20174           required: true
20175           type: string
20176           example: __NAMED-QUERY-ELEMENT-UUID__
20177         - name: related-lookup-uuid
20178           in: query
20179           description:
20180           required: false
20181           type: string
20182   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}:
20183     get:
20184       tags:
20185         - ServiceDesignAndCreation
20186       summary: returns property-constraint
20187       description: returns property-constraint
20188       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20189       produces:
20190         - application/json
20191         - application/xml
20192       responses:
20193         "200":
20194           description: successful operation
20195           schema:
20196               $ref: "#/getDefinitions/property-constraint"
20197         "default":
20198           description: Response codes found in [response codes](https://wiki.onap.org/).
20199       parameters:
20200         - name: named-query-uuid
20201           in: path
20202           required: true
20203           type: string
20204           example: __NAMED-QUERY-UUID__
20205         - name: named-query-element-uuid
20206           in: path
20207           required: true
20208           type: string
20209           example: __NAMED-QUERY-ELEMENT-UUID__
20210         - name: property-constraint-uuid
20211           in: path
20212           required: true
20213           type: string
20214           example: __PROPERTY-CONSTRAINT-UUID__
20215     put:
20216       tags:
20217         - ServiceDesignAndCreation
20218       summary: create or update an existing property-constraint
20219       description: |
20220         Create or update an existing property-constraint.
20221         #
20222         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20223       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20224       consumes:
20225         - application/json
20226         - application/xml
20227       produces:
20228         - application/json
20229         - application/xml
20230       responses:
20231         "default":
20232           description: Response codes found in [response codes](https://wiki.onap.org/).
20233       parameters:
20234         - name: named-query-uuid
20235           in: path
20236           required: true
20237           type: string
20238           example: __NAMED-QUERY-UUID__
20239         - name: named-query-element-uuid
20240           in: path
20241           required: true
20242           type: string
20243           example: __NAMED-QUERY-ELEMENT-UUID__
20244         - name: property-constraint-uuid
20245           in: path
20246           required: true
20247           type: string
20248           example: __PROPERTY-CONSTRAINT-UUID__
20249         - name: body
20250           in: body
20251           description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
20252           required: true
20253           schema:
20254             $ref: "#/definitions/property-constraint"
20255     patch:
20256       tags:
20257         - ServiceDesignAndCreation
20258       summary: update an existing property-constraint
20259       description: |
20260         Update an existing property-constraint
20261         #
20262         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20263         The PUT operation will entirely replace an existing object.
20264         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20265         #
20266         Other differences between PUT and PATCH are:
20267         #
20268         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20269         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20270         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20271       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20272       consumes:
20273         - application/json
20274         - application/xml
20275       produces:
20276         - application/json
20277         - application/xml
20278       responses:
20279         "default":
20280           description: Response codes found in [response codes](https://wiki.onap.org/).
20281       parameters:
20282         - name: named-query-uuid
20283           in: path
20284           required: true
20285           type: string
20286           example: __NAMED-QUERY-UUID__
20287         - name: named-query-element-uuid
20288           in: path
20289           required: true
20290           type: string
20291           example: __NAMED-QUERY-ELEMENT-UUID__
20292         - name: property-constraint-uuid
20293           in: path
20294           required: true
20295           type: string
20296           example: __PROPERTY-CONSTRAINT-UUID__
20297         - name: body
20298           in: body
20299           description: property-constraint object that needs to be updated.
20300           required: true
20301           schema:
20302             $ref: "#/patchDefinitions/property-constraint"
20303     delete:
20304       tags:
20305         - ServiceDesignAndCreation
20306       summary: delete an existing property-constraint
20307       description: delete an existing property-constraint
20308       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20309       consumes:
20310         - application/json
20311         - application/xml
20312       produces:
20313         - application/json
20314         - application/xml
20315       responses:
20316         "default":
20317           description: Response codes found in [response codes](https://wiki.onap.org/).
20318       parameters:
20319         - name: named-query-uuid
20320           in: path
20321           required: true
20322           type: string
20323           example: __NAMED-QUERY-UUID__
20324         - name: named-query-element-uuid
20325           in: path
20326           required: true
20327           type: string
20328           example: __NAMED-QUERY-ELEMENT-UUID__
20329         - name: property-constraint-uuid
20330           in: path
20331           required: true
20332           type: string
20333           example: __PROPERTY-CONSTRAINT-UUID__
20334         - name: resource-version
20335           in: query
20336           description: resource-version for concurrency
20337           required: true
20338           type: string
20339   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
20340     get:
20341       tags:
20342         - ServiceDesignAndCreation
20343       summary: returns property-constraints
20344       description: returns property-constraints
20345       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
20346       produces:
20347         - application/json
20348         - application/xml
20349       responses:
20350         "200":
20351           description: successful operation
20352           schema:
20353               $ref: "#/getDefinitions/property-constraints"
20354         "default":
20355           description: Response codes found in [response codes](https://wiki.onap.org/).
20356       parameters:
20357         - name: named-query-uuid
20358           in: path
20359           required: true
20360           type: string
20361           example: __NAMED-QUERY-UUID__
20362         - name: named-query-element-uuid
20363           in: path
20364           required: true
20365           type: string
20366           example: __NAMED-QUERY-ELEMENT-UUID__
20367         - name: property-constraint-uuid
20368           in: query
20369           description:
20370           required: false
20371           type: string
20372   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
20373     put:
20374       tags:
20375         - ServiceDesignAndCreation
20376       summary: see node definition for valid relationships
20377       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
20378       consumes:
20379         - application/json
20380         - application/xml
20381       produces:
20382         - application/json
20383         - application/xml
20384       responses:
20385         "default":
20386           description: Response codes found in [response codes](https://wiki.onap.org/).
20387       parameters:
20388         - name: named-query-uuid
20389           in: path
20390           required: true
20391           type: string
20392           example: __NAMED-QUERY-UUID__
20393         - name: named-query-element-uuid
20394           in: path
20395           required: true
20396           type: string
20397           example: __NAMED-QUERY-ELEMENT-UUID__
20398         - name: body
20399           in: body
20400           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
20401           required: true
20402           schema:
20403             $ref: "#/definitions/relationship"
20404     delete:
20405       tags:
20406         - ServiceDesignAndCreation
20407       summary: delete an existing relationship
20408       description: delete an existing relationship
20409       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
20410       consumes:
20411         - application/json
20412         - application/xml
20413       produces:
20414         - application/json
20415         - application/xml
20416       responses:
20417         "default":
20418           description: Response codes found in [response codes](https://wiki.onap.org/).
20419       parameters:
20420         - name: named-query-uuid
20421           in: path
20422           required: true
20423           type: string
20424           example: __NAMED-QUERY-UUID__
20425         - name: named-query-element-uuid
20426           in: path
20427           required: true
20428           type: string
20429           example: __NAMED-QUERY-ELEMENT-UUID__
20430   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
20431     get:
20432       tags:
20433         - ServiceDesignAndCreation
20434       summary: returns named-query-element
20435       description: returns named-query-element
20436       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20437       produces:
20438         - application/json
20439         - application/xml
20440       responses:
20441         "200":
20442           description: successful operation
20443           schema:
20444               $ref: "#/getDefinitions/named-query-element"
20445         "default":
20446           description: Response codes found in [response codes](https://wiki.onap.org/).
20447       parameters:
20448         - name: named-query-uuid
20449           in: path
20450           required: true
20451           type: string
20452           example: __NAMED-QUERY-UUID__
20453         - name: named-query-element-uuid
20454           in: path
20455           required: true
20456           type: string
20457           example: __NAMED-QUERY-ELEMENT-UUID__
20458     put:
20459       tags:
20460         - ServiceDesignAndCreation
20461       summary: create or update an existing named-query-element
20462       description: |
20463         Create or update an existing named-query-element.
20464         #
20465         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20466       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20467       consumes:
20468         - application/json
20469         - application/xml
20470       produces:
20471         - application/json
20472         - application/xml
20473       responses:
20474         "default":
20475           description: Response codes found in [response codes](https://wiki.onap.org/).
20476       parameters:
20477         - name: named-query-uuid
20478           in: path
20479           required: true
20480           type: string
20481           example: __NAMED-QUERY-UUID__
20482         - name: named-query-element-uuid
20483           in: path
20484           required: true
20485           type: string
20486           example: __NAMED-QUERY-ELEMENT-UUID__
20487         - name: body
20488           in: body
20489           description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
20490           required: true
20491           schema:
20492             $ref: "#/definitions/named-query-element"
20493     patch:
20494       tags:
20495         - ServiceDesignAndCreation
20496       summary: update an existing named-query-element
20497       description: |
20498         Update an existing named-query-element
20499         #
20500         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20501         The PUT operation will entirely replace an existing object.
20502         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20503         #
20504         Other differences between PUT and PATCH are:
20505         #
20506         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20507         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20508         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20509       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20510       consumes:
20511         - application/json
20512         - application/xml
20513       produces:
20514         - application/json
20515         - application/xml
20516       responses:
20517         "default":
20518           description: Response codes found in [response codes](https://wiki.onap.org/).
20519       parameters:
20520         - name: named-query-uuid
20521           in: path
20522           required: true
20523           type: string
20524           example: __NAMED-QUERY-UUID__
20525         - name: named-query-element-uuid
20526           in: path
20527           required: true
20528           type: string
20529           example: __NAMED-QUERY-ELEMENT-UUID__
20530         - name: body
20531           in: body
20532           description: named-query-element object that needs to be updated.
20533           required: true
20534           schema:
20535             $ref: "#/patchDefinitions/named-query-element"
20536     delete:
20537       tags:
20538         - ServiceDesignAndCreation
20539       summary: delete an existing named-query-element
20540       description: delete an existing named-query-element
20541       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20542       consumes:
20543         - application/json
20544         - application/xml
20545       produces:
20546         - application/json
20547         - application/xml
20548       responses:
20549         "default":
20550           description: Response codes found in [response codes](https://wiki.onap.org/).
20551       parameters:
20552         - name: named-query-uuid
20553           in: path
20554           required: true
20555           type: string
20556           example: __NAMED-QUERY-UUID__
20557         - name: named-query-element-uuid
20558           in: path
20559           required: true
20560           type: string
20561           example: __NAMED-QUERY-ELEMENT-UUID__
20562         - name: resource-version
20563           in: query
20564           description: resource-version for concurrency
20565           required: true
20566           type: string
20567   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
20568     get:
20569       tags:
20570         - ServiceDesignAndCreation
20571       summary: returns named-query-elements
20572       description: returns named-query-elements
20573       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
20574       produces:
20575         - application/json
20576         - application/xml
20577       responses:
20578         "200":
20579           description: successful operation
20580           schema:
20581               $ref: "#/getDefinitions/named-query-elements"
20582         "default":
20583           description: Response codes found in [response codes](https://wiki.onap.org/).
20584       parameters:
20585         - name: named-query-uuid
20586           in: path
20587           required: true
20588           type: string
20589           example: __NAMED-QUERY-UUID__
20590         - name: named-query-element-uuid
20591           in: query
20592           description:
20593           required: false
20594           type: string
20595   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
20596     put:
20597       tags:
20598         - ServiceDesignAndCreation
20599       summary: see node definition for valid relationships
20600       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
20601       consumes:
20602         - application/json
20603         - application/xml
20604       produces:
20605         - application/json
20606         - application/xml
20607       responses:
20608         "default":
20609           description: Response codes found in [response codes](https://wiki.onap.org/).
20610       parameters:
20611         - name: named-query-uuid
20612           in: path
20613           required: true
20614           type: string
20615           example: __NAMED-QUERY-UUID__
20616         - name: body
20617           in: body
20618           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
20619           required: true
20620           schema:
20621             $ref: "#/definitions/relationship"
20622     delete:
20623       tags:
20624         - ServiceDesignAndCreation
20625       summary: delete an existing relationship
20626       description: delete an existing relationship
20627       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
20628       consumes:
20629         - application/json
20630         - application/xml
20631       produces:
20632         - application/json
20633         - application/xml
20634       responses:
20635         "default":
20636           description: Response codes found in [response codes](https://wiki.onap.org/).
20637       parameters:
20638         - name: named-query-uuid
20639           in: path
20640           required: true
20641           type: string
20642           example: __NAMED-QUERY-UUID__
20643   /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
20644     get:
20645       tags:
20646         - ServiceDesignAndCreation
20647       summary: returns named-query
20648       description: returns named-query
20649       operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
20650       produces:
20651         - application/json
20652         - application/xml
20653       responses:
20654         "200":
20655           description: successful operation
20656           schema:
20657               $ref: "#/getDefinitions/named-query"
20658         "default":
20659           description: Response codes found in [response codes](https://wiki.onap.org/).
20660       parameters:
20661         - name: named-query-uuid
20662           in: path
20663           required: true
20664           type: string
20665           example: __NAMED-QUERY-UUID__
20666     put:
20667       tags:
20668         - ServiceDesignAndCreation
20669       summary: create or update an existing named-query
20670       description: |
20671         Create or update an existing named-query.
20672         #
20673         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20674       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
20675       consumes:
20676         - application/json
20677         - application/xml
20678       produces:
20679         - application/json
20680         - application/xml
20681       responses:
20682         "default":
20683           description: Response codes found in [response codes](https://wiki.onap.org/).
20684       parameters:
20685         - name: named-query-uuid
20686           in: path
20687           required: true
20688           type: string
20689           example: __NAMED-QUERY-UUID__
20690         - name: body
20691           in: body
20692           description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
20693           required: true
20694           schema:
20695             $ref: "#/definitions/named-query"
20696     patch:
20697       tags:
20698         - ServiceDesignAndCreation
20699       summary: update an existing named-query
20700       description: |
20701         Update an existing named-query
20702         #
20703         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20704         The PUT operation will entirely replace an existing object.
20705         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20706         #
20707         Other differences between PUT and PATCH are:
20708         #
20709         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20710         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20711         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20712       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
20713       consumes:
20714         - application/json
20715         - application/xml
20716       produces:
20717         - application/json
20718         - application/xml
20719       responses:
20720         "default":
20721           description: Response codes found in [response codes](https://wiki.onap.org/).
20722       parameters:
20723         - name: named-query-uuid
20724           in: path
20725           required: true
20726           type: string
20727           example: __NAMED-QUERY-UUID__
20728         - name: body
20729           in: body
20730           description: named-query object that needs to be updated.
20731           required: true
20732           schema:
20733             $ref: "#/patchDefinitions/named-query"
20734     delete:
20735       tags:
20736         - ServiceDesignAndCreation
20737       summary: delete an existing named-query
20738       description: delete an existing named-query
20739       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
20740       consumes:
20741         - application/json
20742         - application/xml
20743       produces:
20744         - application/json
20745         - application/xml
20746       responses:
20747         "default":
20748           description: Response codes found in [response codes](https://wiki.onap.org/).
20749       parameters:
20750         - name: named-query-uuid
20751           in: path
20752           required: true
20753           type: string
20754           example: __NAMED-QUERY-UUID__
20755         - name: resource-version
20756           in: query
20757           description: resource-version for concurrency
20758           required: true
20759           type: string
20760   /service-design-and-creation/named-queries:
20761     get:
20762       tags:
20763         - ServiceDesignAndCreation
20764       summary: returns named-queries
20765       description: returns named-queries
20766       operationId: getServiceDesignAndCreationNamedQueries
20767       produces:
20768         - application/json
20769         - application/xml
20770       responses:
20771         "200":
20772           description: successful operation
20773           schema:
20774               $ref: "#/getDefinitions/named-queries"
20775         "default":
20776           description: Response codes found in [response codes](https://wiki.onap.org/).
20777       parameters:
20778         - name: named-query-uuid
20779           in: query
20780           description:
20781           required: false
20782           type: string
20783         - name: named-query-name
20784           in: query
20785           description:
20786           required: false
20787           type: string
20788   /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
20789     put:
20790       tags:
20791         - Network
20792       summary: see node definition for valid relationships
20793       operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
20794       consumes:
20795         - application/json
20796         - application/xml
20797       produces:
20798         - application/json
20799         - application/xml
20800       responses:
20801         "default":
20802           description: Response codes found in [response codes](https://wiki.onap.org/).
20803       parameters:
20804         - name: link-name
20805           in: path
20806           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20807           required: true
20808           type: string
20809           example: __LINK-NAME__
20810         - name: body
20811           in: body
20812           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLogicalLinksLogicalLink.json)
20813           required: true
20814           schema:
20815             $ref: "#/definitions/relationship"
20816     delete:
20817       tags:
20818         - Network
20819       summary: delete an existing relationship
20820       description: delete an existing relationship
20821       operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
20822       consumes:
20823         - application/json
20824         - application/xml
20825       produces:
20826         - application/json
20827         - application/xml
20828       responses:
20829         "default":
20830           description: Response codes found in [response codes](https://wiki.onap.org/).
20831       parameters:
20832         - name: link-name
20833           in: path
20834           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20835           required: true
20836           type: string
20837           example: __LINK-NAME__
20838   /network/logical-links/logical-link/{link-name}:
20839     get:
20840       tags:
20841         - Network
20842       summary: returns logical-link
20843       description: returns logical-link
20844       operationId: getNetworkLogicalLinksLogicalLink
20845       produces:
20846         - application/json
20847         - application/xml
20848       responses:
20849         "200":
20850           description: successful operation
20851           schema:
20852               $ref: "#/getDefinitions/logical-link"
20853         "default":
20854           description: Response codes found in [response codes](https://wiki.onap.org/).
20855       parameters:
20856         - name: link-name
20857           in: path
20858           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20859           required: true
20860           type: string
20861           example: __LINK-NAME__
20862     put:
20863       tags:
20864         - Network
20865       summary: create or update an existing logical-link
20866       description: |
20867         Create or update an existing logical-link.
20868         #
20869         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20870       operationId: createOrUpdateNetworkLogicalLinksLogicalLink
20871       consumes:
20872         - application/json
20873         - application/xml
20874       produces:
20875         - application/json
20876         - application/xml
20877       responses:
20878         "default":
20879           description: Response codes found in [response codes](https://wiki.onap.org/).
20880       parameters:
20881         - name: link-name
20882           in: path
20883           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20884           required: true
20885           type: string
20886           example: __LINK-NAME__
20887         - name: body
20888           in: body
20889           description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLogicalLinksLogicalLink.json)
20890           required: true
20891           schema:
20892             $ref: "#/definitions/logical-link"
20893     patch:
20894       tags:
20895         - Network
20896       summary: update an existing logical-link
20897       description: |
20898         Update an existing logical-link
20899         #
20900         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20901         The PUT operation will entirely replace an existing object.
20902         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20903         #
20904         Other differences between PUT and PATCH are:
20905         #
20906         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20907         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20908         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20909       operationId: UpdateNetworkLogicalLinksLogicalLink
20910       consumes:
20911         - application/json
20912         - application/xml
20913       produces:
20914         - application/json
20915         - application/xml
20916       responses:
20917         "default":
20918           description: Response codes found in [response codes](https://wiki.onap.org/).
20919       parameters:
20920         - name: link-name
20921           in: path
20922           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20923           required: true
20924           type: string
20925           example: __LINK-NAME__
20926         - name: body
20927           in: body
20928           description: logical-link object that needs to be updated.
20929           required: true
20930           schema:
20931             $ref: "#/patchDefinitions/logical-link"
20932     delete:
20933       tags:
20934         - Network
20935       summary: delete an existing logical-link
20936       description: delete an existing logical-link
20937       operationId: deleteNetworkLogicalLinksLogicalLink
20938       consumes:
20939         - application/json
20940         - application/xml
20941       produces:
20942         - application/json
20943         - application/xml
20944       responses:
20945         "default":
20946           description: Response codes found in [response codes](https://wiki.onap.org/).
20947       parameters:
20948         - name: link-name
20949           in: path
20950           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20951           required: true
20952           type: string
20953           example: __LINK-NAME__
20954         - name: resource-version
20955           in: query
20956           description: resource-version for concurrency
20957           required: true
20958           type: string
20959   /network/logical-links:
20960     get:
20961       tags:
20962         - Network
20963       summary: returns logical-links
20964       description: returns logical-links
20965       operationId: getNetworkLogicalLinks
20966       produces:
20967         - application/json
20968         - application/xml
20969       responses:
20970         "200":
20971           description: successful operation
20972           schema:
20973               $ref: "#/getDefinitions/logical-links"
20974         "default":
20975           description: Response codes found in [response codes](https://wiki.onap.org/).
20976       parameters:
20977         - name: link-name
20978           in: query
20979           description:
20980           required: false
20981           type: string
20982         - name: model-invariant-id
20983           in: query
20984           description:
20985           required: false
20986           type: string
20987         - name: model-version-id
20988           in: query
20989           description:
20990           required: false
20991           type: string
20992         - name: widget-model-id
20993           in: query
20994           description:
20995           required: false
20996           type: string
20997         - name: widget-model-version
20998           in: query
20999           description:
21000           required: false
21001           type: string
21002         - name: prov-status
21003           in: query
21004           description:
21005           required: false
21006           type: string
21007         - name: link-id
21008           in: query
21009           description:
21010           required: false
21011           type: string
21012         - name: circuit-id
21013           in: query
21014           description:
21015           required: false
21016           type: string
21017         - name: purpose
21018           in: query
21019           description:
21020           required: false
21021           type: string
21022   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship:
21023     put:
21024       tags:
21025         - Network
21026       summary: see node definition for valid relationships
21027       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
21028       consumes:
21029         - application/json
21030         - application/xml
21031       produces:
21032         - application/json
21033         - application/xml
21034       responses:
21035         "default":
21036           description: Response codes found in [response codes](https://wiki.onap.org/).
21037       parameters:
21038         - name: site-pair-set-id
21039           in: path
21040           description: Unique id of site pair set.
21041           required: true
21042           type: string
21043           example: __SITE-PAIR-SET-ID__
21044         - name: routing-instance-id
21045           in: path
21046           description: Unique id of routing instance
21047           required: true
21048           type: string
21049           example: __ROUTING-INSTANCE-ID__
21050         - name: site-pair-id
21051           in: path
21052           description: unique identifier of probe
21053           required: true
21054           type: string
21055           example: __SITE-PAIR-ID__
21056         - name: cos
21057           in: path
21058           description: unique identifier of probe
21059           required: true
21060           type: string
21061           example: __COS__
21062         - name: body
21063           in: body
21064           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
21065           required: true
21066           schema:
21067             $ref: "#/definitions/relationship"
21068     delete:
21069       tags:
21070         - Network
21071       summary: delete an existing relationship
21072       description: delete an existing relationship
21073       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
21074       consumes:
21075         - application/json
21076         - application/xml
21077       produces:
21078         - application/json
21079         - application/xml
21080       responses:
21081         "default":
21082           description: Response codes found in [response codes](https://wiki.onap.org/).
21083       parameters:
21084         - name: site-pair-set-id
21085           in: path
21086           description: Unique id of site pair set.
21087           required: true
21088           type: string
21089           example: __SITE-PAIR-SET-ID__
21090         - name: routing-instance-id
21091           in: path
21092           description: Unique id of routing instance
21093           required: true
21094           type: string
21095           example: __ROUTING-INSTANCE-ID__
21096         - name: site-pair-id
21097           in: path
21098           description: unique identifier of probe
21099           required: true
21100           type: string
21101           example: __SITE-PAIR-ID__
21102         - name: cos
21103           in: path
21104           description: unique identifier of probe
21105           required: true
21106           type: string
21107           example: __COS__
21108   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}:
21109     get:
21110       tags:
21111         - Network
21112       summary: returns class-of-service
21113       description: returns class-of-service
21114       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21115       produces:
21116         - application/json
21117         - application/xml
21118       responses:
21119         "200":
21120           description: successful operation
21121           schema:
21122               $ref: "#/getDefinitions/class-of-service"
21123         "default":
21124           description: Response codes found in [response codes](https://wiki.onap.org/).
21125       parameters:
21126         - name: site-pair-set-id
21127           in: path
21128           description: Unique id of site pair set.
21129           required: true
21130           type: string
21131           example: __SITE-PAIR-SET-ID__
21132         - name: routing-instance-id
21133           in: path
21134           description: Unique id of routing instance
21135           required: true
21136           type: string
21137           example: __ROUTING-INSTANCE-ID__
21138         - name: site-pair-id
21139           in: path
21140           description: unique identifier of probe
21141           required: true
21142           type: string
21143           example: __SITE-PAIR-ID__
21144         - name: cos
21145           in: path
21146           description: unique identifier of probe
21147           required: true
21148           type: string
21149           example: __COS__
21150     put:
21151       tags:
21152         - Network
21153       summary: create or update an existing class-of-service
21154       description: |
21155         Create or update an existing class-of-service.
21156         #
21157         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21158       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21159       consumes:
21160         - application/json
21161         - application/xml
21162       produces:
21163         - application/json
21164         - application/xml
21165       responses:
21166         "default":
21167           description: Response codes found in [response codes](https://wiki.onap.org/).
21168       parameters:
21169         - name: site-pair-set-id
21170           in: path
21171           description: Unique id of site pair set.
21172           required: true
21173           type: string
21174           example: __SITE-PAIR-SET-ID__
21175         - name: routing-instance-id
21176           in: path
21177           description: Unique id of routing instance
21178           required: true
21179           type: string
21180           example: __ROUTING-INSTANCE-ID__
21181         - name: site-pair-id
21182           in: path
21183           description: unique identifier of probe
21184           required: true
21185           type: string
21186           example: __SITE-PAIR-ID__
21187         - name: cos
21188           in: path
21189           description: unique identifier of probe
21190           required: true
21191           type: string
21192           example: __COS__
21193         - name: body
21194           in: body
21195           description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
21196           required: true
21197           schema:
21198             $ref: "#/definitions/class-of-service"
21199     patch:
21200       tags:
21201         - Network
21202       summary: update an existing class-of-service
21203       description: |
21204         Update an existing class-of-service
21205         #
21206         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21207         The PUT operation will entirely replace an existing object.
21208         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21209         #
21210         Other differences between PUT and PATCH are:
21211         #
21212         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21213         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21214         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21215       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21216       consumes:
21217         - application/json
21218         - application/xml
21219       produces:
21220         - application/json
21221         - application/xml
21222       responses:
21223         "default":
21224           description: Response codes found in [response codes](https://wiki.onap.org/).
21225       parameters:
21226         - name: site-pair-set-id
21227           in: path
21228           description: Unique id of site pair set.
21229           required: true
21230           type: string
21231           example: __SITE-PAIR-SET-ID__
21232         - name: routing-instance-id
21233           in: path
21234           description: Unique id of routing instance
21235           required: true
21236           type: string
21237           example: __ROUTING-INSTANCE-ID__
21238         - name: site-pair-id
21239           in: path
21240           description: unique identifier of probe
21241           required: true
21242           type: string
21243           example: __SITE-PAIR-ID__
21244         - name: cos
21245           in: path
21246           description: unique identifier of probe
21247           required: true
21248           type: string
21249           example: __COS__
21250         - name: body
21251           in: body
21252           description: class-of-service object that needs to be updated.
21253           required: true
21254           schema:
21255             $ref: "#/patchDefinitions/class-of-service"
21256     delete:
21257       tags:
21258         - Network
21259       summary: delete an existing class-of-service
21260       description: delete an existing class-of-service
21261       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21262       consumes:
21263         - application/json
21264         - application/xml
21265       produces:
21266         - application/json
21267         - application/xml
21268       responses:
21269         "default":
21270           description: Response codes found in [response codes](https://wiki.onap.org/).
21271       parameters:
21272         - name: site-pair-set-id
21273           in: path
21274           description: Unique id of site pair set.
21275           required: true
21276           type: string
21277           example: __SITE-PAIR-SET-ID__
21278         - name: routing-instance-id
21279           in: path
21280           description: Unique id of routing instance
21281           required: true
21282           type: string
21283           example: __ROUTING-INSTANCE-ID__
21284         - name: site-pair-id
21285           in: path
21286           description: unique identifier of probe
21287           required: true
21288           type: string
21289           example: __SITE-PAIR-ID__
21290         - name: cos
21291           in: path
21292           description: unique identifier of probe
21293           required: true
21294           type: string
21295           example: __COS__
21296         - name: resource-version
21297           in: query
21298           description: resource-version for concurrency
21299           required: true
21300           type: string
21301   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service:
21302     get:
21303       tags:
21304         - Network
21305       summary: returns classes-of-service
21306       description: returns classes-of-service
21307       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
21308       produces:
21309         - application/json
21310         - application/xml
21311       responses:
21312         "200":
21313           description: successful operation
21314           schema:
21315               $ref: "#/getDefinitions/classes-of-service"
21316         "default":
21317           description: Response codes found in [response codes](https://wiki.onap.org/).
21318       parameters:
21319         - name: site-pair-set-id
21320           in: path
21321           description: Unique id of site pair set.
21322           required: true
21323           type: string
21324           example: __SITE-PAIR-SET-ID__
21325         - name: routing-instance-id
21326           in: path
21327           description: Unique id of routing instance
21328           required: true
21329           type: string
21330           example: __ROUTING-INSTANCE-ID__
21331         - name: site-pair-id
21332           in: path
21333           description: unique identifier of probe
21334           required: true
21335           type: string
21336           example: __SITE-PAIR-ID__
21337         - name: cos
21338           in: query
21339           description:
21340           required: false
21341           type: string
21342   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship:
21343     put:
21344       tags:
21345         - Network
21346       summary: see node definition for valid relationships
21347       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
21348       consumes:
21349         - application/json
21350         - application/xml
21351       produces:
21352         - application/json
21353         - application/xml
21354       responses:
21355         "default":
21356           description: Response codes found in [response codes](https://wiki.onap.org/).
21357       parameters:
21358         - name: site-pair-set-id
21359           in: path
21360           description: Unique id of site pair set.
21361           required: true
21362           type: string
21363           example: __SITE-PAIR-SET-ID__
21364         - name: routing-instance-id
21365           in: path
21366           description: Unique id of routing instance
21367           required: true
21368           type: string
21369           example: __ROUTING-INSTANCE-ID__
21370         - name: site-pair-id
21371           in: path
21372           description: unique identifier of probe
21373           required: true
21374           type: string
21375           example: __SITE-PAIR-ID__
21376         - name: body
21377           in: body
21378           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
21379           required: true
21380           schema:
21381             $ref: "#/definitions/relationship"
21382     delete:
21383       tags:
21384         - Network
21385       summary: delete an existing relationship
21386       description: delete an existing relationship
21387       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
21388       consumes:
21389         - application/json
21390         - application/xml
21391       produces:
21392         - application/json
21393         - application/xml
21394       responses:
21395         "default":
21396           description: Response codes found in [response codes](https://wiki.onap.org/).
21397       parameters:
21398         - name: site-pair-set-id
21399           in: path
21400           description: Unique id of site pair set.
21401           required: true
21402           type: string
21403           example: __SITE-PAIR-SET-ID__
21404         - name: routing-instance-id
21405           in: path
21406           description: Unique id of routing instance
21407           required: true
21408           type: string
21409           example: __ROUTING-INSTANCE-ID__
21410         - name: site-pair-id
21411           in: path
21412           description: unique identifier of probe
21413           required: true
21414           type: string
21415           example: __SITE-PAIR-ID__
21416   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}:
21417     get:
21418       tags:
21419         - Network
21420       summary: returns site-pair
21421       description: returns site-pair
21422       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21423       produces:
21424         - application/json
21425         - application/xml
21426       responses:
21427         "200":
21428           description: successful operation
21429           schema:
21430               $ref: "#/getDefinitions/site-pair"
21431         "default":
21432           description: Response codes found in [response codes](https://wiki.onap.org/).
21433       parameters:
21434         - name: site-pair-set-id
21435           in: path
21436           description: Unique id of site pair set.
21437           required: true
21438           type: string
21439           example: __SITE-PAIR-SET-ID__
21440         - name: routing-instance-id
21441           in: path
21442           description: Unique id of routing instance
21443           required: true
21444           type: string
21445           example: __ROUTING-INSTANCE-ID__
21446         - name: site-pair-id
21447           in: path
21448           description: unique identifier of probe
21449           required: true
21450           type: string
21451           example: __SITE-PAIR-ID__
21452     put:
21453       tags:
21454         - Network
21455       summary: create or update an existing site-pair
21456       description: |
21457         Create or update an existing site-pair.
21458         #
21459         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21460       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21461       consumes:
21462         - application/json
21463         - application/xml
21464       produces:
21465         - application/json
21466         - application/xml
21467       responses:
21468         "default":
21469           description: Response codes found in [response codes](https://wiki.onap.org/).
21470       parameters:
21471         - name: site-pair-set-id
21472           in: path
21473           description: Unique id of site pair set.
21474           required: true
21475           type: string
21476           example: __SITE-PAIR-SET-ID__
21477         - name: routing-instance-id
21478           in: path
21479           description: Unique id of routing instance
21480           required: true
21481           type: string
21482           example: __ROUTING-INSTANCE-ID__
21483         - name: site-pair-id
21484           in: path
21485           description: unique identifier of probe
21486           required: true
21487           type: string
21488           example: __SITE-PAIR-ID__
21489         - name: body
21490           in: body
21491           description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
21492           required: true
21493           schema:
21494             $ref: "#/definitions/site-pair"
21495     patch:
21496       tags:
21497         - Network
21498       summary: update an existing site-pair
21499       description: |
21500         Update an existing site-pair
21501         #
21502         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21503         The PUT operation will entirely replace an existing object.
21504         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21505         #
21506         Other differences between PUT and PATCH are:
21507         #
21508         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21509         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21510         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21511       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21512       consumes:
21513         - application/json
21514         - application/xml
21515       produces:
21516         - application/json
21517         - application/xml
21518       responses:
21519         "default":
21520           description: Response codes found in [response codes](https://wiki.onap.org/).
21521       parameters:
21522         - name: site-pair-set-id
21523           in: path
21524           description: Unique id of site pair set.
21525           required: true
21526           type: string
21527           example: __SITE-PAIR-SET-ID__
21528         - name: routing-instance-id
21529           in: path
21530           description: Unique id of routing instance
21531           required: true
21532           type: string
21533           example: __ROUTING-INSTANCE-ID__
21534         - name: site-pair-id
21535           in: path
21536           description: unique identifier of probe
21537           required: true
21538           type: string
21539           example: __SITE-PAIR-ID__
21540         - name: body
21541           in: body
21542           description: site-pair object that needs to be updated.
21543           required: true
21544           schema:
21545             $ref: "#/patchDefinitions/site-pair"
21546     delete:
21547       tags:
21548         - Network
21549       summary: delete an existing site-pair
21550       description: delete an existing site-pair
21551       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21552       consumes:
21553         - application/json
21554         - application/xml
21555       produces:
21556         - application/json
21557         - application/xml
21558       responses:
21559         "default":
21560           description: Response codes found in [response codes](https://wiki.onap.org/).
21561       parameters:
21562         - name: site-pair-set-id
21563           in: path
21564           description: Unique id of site pair set.
21565           required: true
21566           type: string
21567           example: __SITE-PAIR-SET-ID__
21568         - name: routing-instance-id
21569           in: path
21570           description: Unique id of routing instance
21571           required: true
21572           type: string
21573           example: __ROUTING-INSTANCE-ID__
21574         - name: site-pair-id
21575           in: path
21576           description: unique identifier of probe
21577           required: true
21578           type: string
21579           example: __SITE-PAIR-ID__
21580         - name: resource-version
21581           in: query
21582           description: resource-version for concurrency
21583           required: true
21584           type: string
21585   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
21586     get:
21587       tags:
21588         - Network
21589       summary: returns site-pairs
21590       description: returns site-pairs
21591       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
21592       produces:
21593         - application/json
21594         - application/xml
21595       responses:
21596         "200":
21597           description: successful operation
21598           schema:
21599               $ref: "#/getDefinitions/site-pairs"
21600         "default":
21601           description: Response codes found in [response codes](https://wiki.onap.org/).
21602       parameters:
21603         - name: site-pair-set-id
21604           in: path
21605           description: Unique id of site pair set.
21606           required: true
21607           type: string
21608           example: __SITE-PAIR-SET-ID__
21609         - name: routing-instance-id
21610           in: path
21611           description: Unique id of routing instance
21612           required: true
21613           type: string
21614           example: __ROUTING-INSTANCE-ID__
21615         - name: site-pair-id
21616           in: query
21617           description:
21618           required: false
21619           type: string
21620   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
21621     put:
21622       tags:
21623         - Network
21624       summary: see node definition for valid relationships
21625       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
21626       consumes:
21627         - application/json
21628         - application/xml
21629       produces:
21630         - application/json
21631         - application/xml
21632       responses:
21633         "default":
21634           description: Response codes found in [response codes](https://wiki.onap.org/).
21635       parameters:
21636         - name: site-pair-set-id
21637           in: path
21638           description: Unique id of site pair set.
21639           required: true
21640           type: string
21641           example: __SITE-PAIR-SET-ID__
21642         - name: routing-instance-id
21643           in: path
21644           description: Unique id of routing instance
21645           required: true
21646           type: string
21647           example: __ROUTING-INSTANCE-ID__
21648         - name: body
21649           in: body
21650           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
21651           required: true
21652           schema:
21653             $ref: "#/definitions/relationship"
21654     delete:
21655       tags:
21656         - Network
21657       summary: delete an existing relationship
21658       description: delete an existing relationship
21659       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
21660       consumes:
21661         - application/json
21662         - application/xml
21663       produces:
21664         - application/json
21665         - application/xml
21666       responses:
21667         "default":
21668           description: Response codes found in [response codes](https://wiki.onap.org/).
21669       parameters:
21670         - name: site-pair-set-id
21671           in: path
21672           description: Unique id of site pair set.
21673           required: true
21674           type: string
21675           example: __SITE-PAIR-SET-ID__
21676         - name: routing-instance-id
21677           in: path
21678           description: Unique id of routing instance
21679           required: true
21680           type: string
21681           example: __ROUTING-INSTANCE-ID__
21682   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
21683     get:
21684       tags:
21685         - Network
21686       summary: returns routing-instance
21687       description: returns routing-instance
21688       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21689       produces:
21690         - application/json
21691         - application/xml
21692       responses:
21693         "200":
21694           description: successful operation
21695           schema:
21696               $ref: "#/getDefinitions/routing-instance"
21697         "default":
21698           description: Response codes found in [response codes](https://wiki.onap.org/).
21699       parameters:
21700         - name: site-pair-set-id
21701           in: path
21702           description: Unique id of site pair set.
21703           required: true
21704           type: string
21705           example: __SITE-PAIR-SET-ID__
21706         - name: routing-instance-id
21707           in: path
21708           description: Unique id of routing instance
21709           required: true
21710           type: string
21711           example: __ROUTING-INSTANCE-ID__
21712     put:
21713       tags:
21714         - Network
21715       summary: create or update an existing routing-instance
21716       description: |
21717         Create or update an existing routing-instance.
21718         #
21719         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21720       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21721       consumes:
21722         - application/json
21723         - application/xml
21724       produces:
21725         - application/json
21726         - application/xml
21727       responses:
21728         "default":
21729           description: Response codes found in [response codes](https://wiki.onap.org/).
21730       parameters:
21731         - name: site-pair-set-id
21732           in: path
21733           description: Unique id of site pair set.
21734           required: true
21735           type: string
21736           example: __SITE-PAIR-SET-ID__
21737         - name: routing-instance-id
21738           in: path
21739           description: Unique id of routing instance
21740           required: true
21741           type: string
21742           example: __ROUTING-INSTANCE-ID__
21743         - name: body
21744           in: body
21745           description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
21746           required: true
21747           schema:
21748             $ref: "#/definitions/routing-instance"
21749     patch:
21750       tags:
21751         - Network
21752       summary: update an existing routing-instance
21753       description: |
21754         Update an existing routing-instance
21755         #
21756         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21757         The PUT operation will entirely replace an existing object.
21758         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21759         #
21760         Other differences between PUT and PATCH are:
21761         #
21762         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21763         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21764         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21765       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21766       consumes:
21767         - application/json
21768         - application/xml
21769       produces:
21770         - application/json
21771         - application/xml
21772       responses:
21773         "default":
21774           description: Response codes found in [response codes](https://wiki.onap.org/).
21775       parameters:
21776         - name: site-pair-set-id
21777           in: path
21778           description: Unique id of site pair set.
21779           required: true
21780           type: string
21781           example: __SITE-PAIR-SET-ID__
21782         - name: routing-instance-id
21783           in: path
21784           description: Unique id of routing instance
21785           required: true
21786           type: string
21787           example: __ROUTING-INSTANCE-ID__
21788         - name: body
21789           in: body
21790           description: routing-instance object that needs to be updated.
21791           required: true
21792           schema:
21793             $ref: "#/patchDefinitions/routing-instance"
21794     delete:
21795       tags:
21796         - Network
21797       summary: delete an existing routing-instance
21798       description: delete an existing routing-instance
21799       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21800       consumes:
21801         - application/json
21802         - application/xml
21803       produces:
21804         - application/json
21805         - application/xml
21806       responses:
21807         "default":
21808           description: Response codes found in [response codes](https://wiki.onap.org/).
21809       parameters:
21810         - name: site-pair-set-id
21811           in: path
21812           description: Unique id of site pair set.
21813           required: true
21814           type: string
21815           example: __SITE-PAIR-SET-ID__
21816         - name: routing-instance-id
21817           in: path
21818           description: Unique id of routing instance
21819           required: true
21820           type: string
21821           example: __ROUTING-INSTANCE-ID__
21822         - name: resource-version
21823           in: query
21824           description: resource-version for concurrency
21825           required: true
21826           type: string
21827   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
21828     get:
21829       tags:
21830         - Network
21831       summary: returns routing-instances
21832       description: returns routing-instances
21833       operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
21834       produces:
21835         - application/json
21836         - application/xml
21837       responses:
21838         "200":
21839           description: successful operation
21840           schema:
21841               $ref: "#/getDefinitions/routing-instances"
21842         "default":
21843           description: Response codes found in [response codes](https://wiki.onap.org/).
21844       parameters:
21845         - name: site-pair-set-id
21846           in: path
21847           description: Unique id of site pair set.
21848           required: true
21849           type: string
21850           example: __SITE-PAIR-SET-ID__
21851         - name: routing-instance-id
21852           in: query
21853           description:
21854           required: false
21855           type: string
21856   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
21857     put:
21858       tags:
21859         - Network
21860       summary: see node definition for valid relationships
21861       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
21862       consumes:
21863         - application/json
21864         - application/xml
21865       produces:
21866         - application/json
21867         - application/xml
21868       responses:
21869         "default":
21870           description: Response codes found in [response codes](https://wiki.onap.org/).
21871       parameters:
21872         - name: site-pair-set-id
21873           in: path
21874           description: Unique id of site pair set.
21875           required: true
21876           type: string
21877           example: __SITE-PAIR-SET-ID__
21878         - name: body
21879           in: body
21880           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json)
21881           required: true
21882           schema:
21883             $ref: "#/definitions/relationship"
21884     delete:
21885       tags:
21886         - Network
21887       summary: delete an existing relationship
21888       description: delete an existing relationship
21889       operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
21890       consumes:
21891         - application/json
21892         - application/xml
21893       produces:
21894         - application/json
21895         - application/xml
21896       responses:
21897         "default":
21898           description: Response codes found in [response codes](https://wiki.onap.org/).
21899       parameters:
21900         - name: site-pair-set-id
21901           in: path
21902           description: Unique id of site pair set.
21903           required: true
21904           type: string
21905           example: __SITE-PAIR-SET-ID__
21906   /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
21907     get:
21908       tags:
21909         - Network
21910       summary: returns site-pair-set
21911       description: returns site-pair-set
21912       operationId: getNetworkSitePairSetsSitePairSet
21913       produces:
21914         - application/json
21915         - application/xml
21916       responses:
21917         "200":
21918           description: successful operation
21919           schema:
21920               $ref: "#/getDefinitions/site-pair-set"
21921         "default":
21922           description: Response codes found in [response codes](https://wiki.onap.org/).
21923       parameters:
21924         - name: site-pair-set-id
21925           in: path
21926           description: Unique id of site pair set.
21927           required: true
21928           type: string
21929           example: __SITE-PAIR-SET-ID__
21930     put:
21931       tags:
21932         - Network
21933       summary: create or update an existing site-pair-set
21934       description: |
21935         Create or update an existing site-pair-set.
21936         #
21937         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21938       operationId: createOrUpdateNetworkSitePairSetsSitePairSet
21939       consumes:
21940         - application/json
21941         - application/xml
21942       produces:
21943         - application/json
21944         - application/xml
21945       responses:
21946         "default":
21947           description: Response codes found in [response codes](https://wiki.onap.org/).
21948       parameters:
21949         - name: site-pair-set-id
21950           in: path
21951           description: Unique id of site pair set.
21952           required: true
21953           type: string
21954           example: __SITE-PAIR-SET-ID__
21955         - name: body
21956           in: body
21957           description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json)
21958           required: true
21959           schema:
21960             $ref: "#/definitions/site-pair-set"
21961     patch:
21962       tags:
21963         - Network
21964       summary: update an existing site-pair-set
21965       description: |
21966         Update an existing site-pair-set
21967         #
21968         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21969         The PUT operation will entirely replace an existing object.
21970         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21971         #
21972         Other differences between PUT and PATCH are:
21973         #
21974         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21975         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21976         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21977       operationId: UpdateNetworkSitePairSetsSitePairSet
21978       consumes:
21979         - application/json
21980         - application/xml
21981       produces:
21982         - application/json
21983         - application/xml
21984       responses:
21985         "default":
21986           description: Response codes found in [response codes](https://wiki.onap.org/).
21987       parameters:
21988         - name: site-pair-set-id
21989           in: path
21990           description: Unique id of site pair set.
21991           required: true
21992           type: string
21993           example: __SITE-PAIR-SET-ID__
21994         - name: body
21995           in: body
21996           description: site-pair-set object that needs to be updated.
21997           required: true
21998           schema:
21999             $ref: "#/patchDefinitions/site-pair-set"
22000     delete:
22001       tags:
22002         - Network
22003       summary: delete an existing site-pair-set
22004       description: delete an existing site-pair-set
22005       operationId: deleteNetworkSitePairSetsSitePairSet
22006       consumes:
22007         - application/json
22008         - application/xml
22009       produces:
22010         - application/json
22011         - application/xml
22012       responses:
22013         "default":
22014           description: Response codes found in [response codes](https://wiki.onap.org/).
22015       parameters:
22016         - name: site-pair-set-id
22017           in: path
22018           description: Unique id of site pair set.
22019           required: true
22020           type: string
22021           example: __SITE-PAIR-SET-ID__
22022         - name: resource-version
22023           in: query
22024           description: resource-version for concurrency
22025           required: true
22026           type: string
22027   /network/site-pair-sets:
22028     get:
22029       tags:
22030         - Network
22031       summary: returns site-pair-sets
22032       description: returns site-pair-sets
22033       operationId: getNetworkSitePairSets
22034       produces:
22035         - application/json
22036         - application/xml
22037       responses:
22038         "200":
22039           description: successful operation
22040           schema:
22041               $ref: "#/getDefinitions/site-pair-sets"
22042         "default":
22043           description: Response codes found in [response codes](https://wiki.onap.org/).
22044       parameters:
22045         - name: site-pair-set-id
22046           in: query
22047           description:
22048           required: false
22049           type: string
22050   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
22051     put:
22052       tags:
22053         - Network
22054       summary: see node definition for valid relationships
22055       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
22056       consumes:
22057         - application/json
22058         - application/xml
22059       produces:
22060         - application/json
22061         - application/xml
22062       responses:
22063         "default":
22064           description: Response codes found in [response codes](https://wiki.onap.org/).
22065       parameters:
22066         - name: vpn-id
22067           in: path
22068           description: VPN ID, globally unique within A&AI
22069           required: true
22070           type: string
22071           example: __VPN-ID__
22072         - name: global-route-target
22073           in: path
22074           description: Number used to identify an RT, globally unique in the network
22075           required: true
22076           type: string
22077           example: __GLOBAL-ROUTE-TARGET__
22078         - name: route-target-role
22079           in: path
22080           description: Role assigned to this route target
22081           required: true
22082           type: string
22083           example: __ROUTE-TARGET-ROLE__
22084         - name: body
22085           in: body
22086           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
22087           required: true
22088           schema:
22089             $ref: "#/definitions/relationship"
22090     delete:
22091       tags:
22092         - Network
22093       summary: delete an existing relationship
22094       description: delete an existing relationship
22095       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
22096       consumes:
22097         - application/json
22098         - application/xml
22099       produces:
22100         - application/json
22101         - application/xml
22102       responses:
22103         "default":
22104           description: Response codes found in [response codes](https://wiki.onap.org/).
22105       parameters:
22106         - name: vpn-id
22107           in: path
22108           description: VPN ID, globally unique within A&AI
22109           required: true
22110           type: string
22111           example: __VPN-ID__
22112         - name: global-route-target
22113           in: path
22114           description: Number used to identify an RT, globally unique in the network
22115           required: true
22116           type: string
22117           example: __GLOBAL-ROUTE-TARGET__
22118         - name: route-target-role
22119           in: path
22120           description: Role assigned to this route target
22121           required: true
22122           type: string
22123           example: __ROUTE-TARGET-ROLE__
22124   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
22125     get:
22126       tags:
22127         - Network
22128       summary: returns route-target
22129       description: returns route-target
22130       operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22131       produces:
22132         - application/json
22133         - application/xml
22134       responses:
22135         "200":
22136           description: successful operation
22137           schema:
22138               $ref: "#/getDefinitions/route-target"
22139         "default":
22140           description: Response codes found in [response codes](https://wiki.onap.org/).
22141       parameters:
22142         - name: vpn-id
22143           in: path
22144           description: VPN ID, globally unique within A&AI
22145           required: true
22146           type: string
22147           example: __VPN-ID__
22148         - name: global-route-target
22149           in: path
22150           description: Number used to identify an RT, globally unique in the network
22151           required: true
22152           type: string
22153           example: __GLOBAL-ROUTE-TARGET__
22154         - name: route-target-role
22155           in: path
22156           description: Role assigned to this route target
22157           required: true
22158           type: string
22159           example: __ROUTE-TARGET-ROLE__
22160     put:
22161       tags:
22162         - Network
22163       summary: create or update an existing route-target
22164       description: |
22165         Create or update an existing route-target.
22166         #
22167         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22168       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22169       consumes:
22170         - application/json
22171         - application/xml
22172       produces:
22173         - application/json
22174         - application/xml
22175       responses:
22176         "default":
22177           description: Response codes found in [response codes](https://wiki.onap.org/).
22178       parameters:
22179         - name: vpn-id
22180           in: path
22181           description: VPN ID, globally unique within A&AI
22182           required: true
22183           type: string
22184           example: __VPN-ID__
22185         - name: global-route-target
22186           in: path
22187           description: Number used to identify an RT, globally unique in the network
22188           required: true
22189           type: string
22190           example: __GLOBAL-ROUTE-TARGET__
22191         - name: route-target-role
22192           in: path
22193           description: Role assigned to this route target
22194           required: true
22195           type: string
22196           example: __ROUTE-TARGET-ROLE__
22197         - name: body
22198           in: body
22199           description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
22200           required: true
22201           schema:
22202             $ref: "#/definitions/route-target"
22203     patch:
22204       tags:
22205         - Network
22206       summary: update an existing route-target
22207       description: |
22208         Update an existing route-target
22209         #
22210         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22211         The PUT operation will entirely replace an existing object.
22212         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22213         #
22214         Other differences between PUT and PATCH are:
22215         #
22216         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22217         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22218         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22219       operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22220       consumes:
22221         - application/json
22222         - application/xml
22223       produces:
22224         - application/json
22225         - application/xml
22226       responses:
22227         "default":
22228           description: Response codes found in [response codes](https://wiki.onap.org/).
22229       parameters:
22230         - name: vpn-id
22231           in: path
22232           description: VPN ID, globally unique within A&AI
22233           required: true
22234           type: string
22235           example: __VPN-ID__
22236         - name: global-route-target
22237           in: path
22238           description: Number used to identify an RT, globally unique in the network
22239           required: true
22240           type: string
22241           example: __GLOBAL-ROUTE-TARGET__
22242         - name: route-target-role
22243           in: path
22244           description: Role assigned to this route target
22245           required: true
22246           type: string
22247           example: __ROUTE-TARGET-ROLE__
22248         - name: body
22249           in: body
22250           description: route-target object that needs to be updated.
22251           required: true
22252           schema:
22253             $ref: "#/patchDefinitions/route-target"
22254     delete:
22255       tags:
22256         - Network
22257       summary: delete an existing route-target
22258       description: delete an existing route-target
22259       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22260       consumes:
22261         - application/json
22262         - application/xml
22263       produces:
22264         - application/json
22265         - application/xml
22266       responses:
22267         "default":
22268           description: Response codes found in [response codes](https://wiki.onap.org/).
22269       parameters:
22270         - name: vpn-id
22271           in: path
22272           description: VPN ID, globally unique within A&AI
22273           required: true
22274           type: string
22275           example: __VPN-ID__
22276         - name: global-route-target
22277           in: path
22278           description: Number used to identify an RT, globally unique in the network
22279           required: true
22280           type: string
22281           example: __GLOBAL-ROUTE-TARGET__
22282         - name: route-target-role
22283           in: path
22284           description: Role assigned to this route target
22285           required: true
22286           type: string
22287           example: __ROUTE-TARGET-ROLE__
22288         - name: resource-version
22289           in: query
22290           description: resource-version for concurrency
22291           required: true
22292           type: string
22293   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
22294     get:
22295       tags:
22296         - Network
22297       summary: returns route-targets
22298       description: returns route-targets
22299       operationId: getNetworkVpnBindingsVpnBindingRouteTargets
22300       produces:
22301         - application/json
22302         - application/xml
22303       responses:
22304         "200":
22305           description: successful operation
22306           schema:
22307               $ref: "#/getDefinitions/route-targets"
22308         "default":
22309           description: Response codes found in [response codes](https://wiki.onap.org/).
22310       parameters:
22311         - name: vpn-id
22312           in: path
22313           description: VPN ID, globally unique within A&AI
22314           required: true
22315           type: string
22316           example: __VPN-ID__
22317   /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
22318     put:
22319       tags:
22320         - Network
22321       summary: see node definition for valid relationships
22322       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
22323       consumes:
22324         - application/json
22325         - application/xml
22326       produces:
22327         - application/json
22328         - application/xml
22329       responses:
22330         "default":
22331           description: Response codes found in [response codes](https://wiki.onap.org/).
22332       parameters:
22333         - name: vpn-id
22334           in: path
22335           description: VPN ID, globally unique within A&AI
22336           required: true
22337           type: string
22338           example: __VPN-ID__
22339         - name: body
22340           in: body
22341           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json)
22342           required: true
22343           schema:
22344             $ref: "#/definitions/relationship"
22345     delete:
22346       tags:
22347         - Network
22348       summary: delete an existing relationship
22349       description: delete an existing relationship
22350       operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
22351       consumes:
22352         - application/json
22353         - application/xml
22354       produces:
22355         - application/json
22356         - application/xml
22357       responses:
22358         "default":
22359           description: Response codes found in [response codes](https://wiki.onap.org/).
22360       parameters:
22361         - name: vpn-id
22362           in: path
22363           description: VPN ID, globally unique within A&AI
22364           required: true
22365           type: string
22366           example: __VPN-ID__
22367   /network/vpn-bindings/vpn-binding/{vpn-id}:
22368     get:
22369       tags:
22370         - Network
22371       summary: returns vpn-binding
22372       description: returns vpn-binding
22373       operationId: getNetworkVpnBindingsVpnBinding
22374       produces:
22375         - application/json
22376         - application/xml
22377       responses:
22378         "200":
22379           description: successful operation
22380           schema:
22381               $ref: "#/getDefinitions/vpn-binding"
22382         "default":
22383           description: Response codes found in [response codes](https://wiki.onap.org/).
22384       parameters:
22385         - name: vpn-id
22386           in: path
22387           description: VPN ID, globally unique within A&AI
22388           required: true
22389           type: string
22390           example: __VPN-ID__
22391     put:
22392       tags:
22393         - Network
22394       summary: create or update an existing vpn-binding
22395       description: |
22396         Create or update an existing vpn-binding.
22397         #
22398         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22399       operationId: createOrUpdateNetworkVpnBindingsVpnBinding
22400       consumes:
22401         - application/json
22402         - application/xml
22403       produces:
22404         - application/json
22405         - application/xml
22406       responses:
22407         "default":
22408           description: Response codes found in [response codes](https://wiki.onap.org/).
22409       parameters:
22410         - name: vpn-id
22411           in: path
22412           description: VPN ID, globally unique within A&AI
22413           required: true
22414           type: string
22415           example: __VPN-ID__
22416         - name: body
22417           in: body
22418           description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json)
22419           required: true
22420           schema:
22421             $ref: "#/definitions/vpn-binding"
22422     patch:
22423       tags:
22424         - Network
22425       summary: update an existing vpn-binding
22426       description: |
22427         Update an existing vpn-binding
22428         #
22429         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22430         The PUT operation will entirely replace an existing object.
22431         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22432         #
22433         Other differences between PUT and PATCH are:
22434         #
22435         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22436         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22437         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22438       operationId: UpdateNetworkVpnBindingsVpnBinding
22439       consumes:
22440         - application/json
22441         - application/xml
22442       produces:
22443         - application/json
22444         - application/xml
22445       responses:
22446         "default":
22447           description: Response codes found in [response codes](https://wiki.onap.org/).
22448       parameters:
22449         - name: vpn-id
22450           in: path
22451           description: VPN ID, globally unique within A&AI
22452           required: true
22453           type: string
22454           example: __VPN-ID__
22455         - name: body
22456           in: body
22457           description: vpn-binding object that needs to be updated.
22458           required: true
22459           schema:
22460             $ref: "#/patchDefinitions/vpn-binding"
22461     delete:
22462       tags:
22463         - Network
22464       summary: delete an existing vpn-binding
22465       description: delete an existing vpn-binding
22466       operationId: deleteNetworkVpnBindingsVpnBinding
22467       consumes:
22468         - application/json
22469         - application/xml
22470       produces:
22471         - application/json
22472         - application/xml
22473       responses:
22474         "default":
22475           description: Response codes found in [response codes](https://wiki.onap.org/).
22476       parameters:
22477         - name: vpn-id
22478           in: path
22479           description: VPN ID, globally unique within A&AI
22480           required: true
22481           type: string
22482           example: __VPN-ID__
22483         - name: resource-version
22484           in: query
22485           description: resource-version for concurrency
22486           required: true
22487           type: string
22488   /network/vpn-bindings:
22489     get:
22490       tags:
22491         - Network
22492       summary: returns vpn-bindings
22493       description: returns vpn-bindings
22494       operationId: getNetworkVpnBindings
22495       produces:
22496         - application/json
22497         - application/xml
22498       responses:
22499         "200":
22500           description: successful operation
22501           schema:
22502               $ref: "#/getDefinitions/vpn-bindings"
22503         "default":
22504           description: Response codes found in [response codes](https://wiki.onap.org/).
22505       parameters:
22506         - name: vpn-id
22507           in: query
22508           description:
22509           required: false
22510           type: string
22511         - name: vpn-name
22512           in: query
22513           description:
22514           required: false
22515           type: string
22516         - name: vpn-type
22517           in: query
22518           description:
22519           required: false
22520           type: string
22521   /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
22522     put:
22523       tags:
22524         - Network
22525       summary: see node definition for valid relationships
22526       operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
22527       consumes:
22528         - application/json
22529         - application/xml
22530       produces:
22531         - application/json
22532         - application/xml
22533       responses:
22534         "default":
22535           description: Response codes found in [response codes](https://wiki.onap.org/).
22536       parameters:
22537         - name: equipment-name
22538           in: path
22539           required: true
22540           type: string
22541           example: __EQUIPMENT-NAME__
22542         - name: body
22543           in: body
22544           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json)
22545           required: true
22546           schema:
22547             $ref: "#/definitions/relationship"
22548     delete:
22549       tags:
22550         - Network
22551       summary: delete an existing relationship
22552       description: delete an existing relationship
22553       operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
22554       consumes:
22555         - application/json
22556         - application/xml
22557       produces:
22558         - application/json
22559         - application/xml
22560       responses:
22561         "default":
22562           description: Response codes found in [response codes](https://wiki.onap.org/).
22563       parameters:
22564         - name: equipment-name
22565           in: path
22566           required: true
22567           type: string
22568           example: __EQUIPMENT-NAME__
22569   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
22570     put:
22571       tags:
22572         - Network
22573       summary: see node definition for valid relationships
22574       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
22575       consumes:
22576         - application/json
22577         - application/xml
22578       produces:
22579         - application/json
22580         - application/xml
22581       responses:
22582         "default":
22583           description: Response codes found in [response codes](https://wiki.onap.org/).
22584       parameters:
22585         - name: equipment-name
22586           in: path
22587           required: true
22588           type: string
22589           example: __EQUIPMENT-NAME__
22590         - name: interface-name
22591           in: path
22592           description: Name that identifies the physical interface
22593           required: true
22594           type: string
22595           example: __INTERFACE-NAME__
22596         - name: body
22597           in: body
22598           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json)
22599           required: true
22600           schema:
22601             $ref: "#/definitions/relationship"
22602     delete:
22603       tags:
22604         - Network
22605       summary: delete an existing relationship
22606       description: delete an existing relationship
22607       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
22608       consumes:
22609         - application/json
22610         - application/xml
22611       produces:
22612         - application/json
22613         - application/xml
22614       responses:
22615         "default":
22616           description: Response codes found in [response codes](https://wiki.onap.org/).
22617       parameters:
22618         - name: equipment-name
22619           in: path
22620           required: true
22621           type: string
22622           example: __EQUIPMENT-NAME__
22623         - name: interface-name
22624           in: path
22625           description: Name that identifies the physical interface
22626           required: true
22627           type: string
22628           example: __INTERFACE-NAME__
22629   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
22630     put:
22631       tags:
22632         - Network
22633       summary: see node definition for valid relationships
22634       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
22635       consumes:
22636         - application/json
22637         - application/xml
22638       produces:
22639         - application/json
22640         - application/xml
22641       responses:
22642         "default":
22643           description: Response codes found in [response codes](https://wiki.onap.org/).
22644       parameters:
22645         - name: equipment-name
22646           in: path
22647           required: true
22648           type: string
22649           example: __EQUIPMENT-NAME__
22650         - name: interface-name
22651           in: path
22652           description: Name that identifies the physical interface
22653           required: true
22654           type: string
22655           example: __INTERFACE-NAME__
22656         - name: pf-pci-id
22657           in: path
22658           description: Identifier for the sriov-pf
22659           required: true
22660           type: string
22661           example: __PF-PCI-ID__
22662         - name: body
22663           in: body
22664           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
22665           required: true
22666           schema:
22667             $ref: "#/definitions/relationship"
22668     delete:
22669       tags:
22670         - Network
22671       summary: delete an existing relationship
22672       description: delete an existing relationship
22673       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
22674       consumes:
22675         - application/json
22676         - application/xml
22677       produces:
22678         - application/json
22679         - application/xml
22680       responses:
22681         "default":
22682           description: Response codes found in [response codes](https://wiki.onap.org/).
22683       parameters:
22684         - name: equipment-name
22685           in: path
22686           required: true
22687           type: string
22688           example: __EQUIPMENT-NAME__
22689         - name: interface-name
22690           in: path
22691           description: Name that identifies the physical interface
22692           required: true
22693           type: string
22694           example: __INTERFACE-NAME__
22695         - name: pf-pci-id
22696           in: path
22697           description: Identifier for the sriov-pf
22698           required: true
22699           type: string
22700           example: __PF-PCI-ID__
22701   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
22702     get:
22703       tags:
22704         - Network
22705       summary: returns sriov-pf
22706       description: returns sriov-pf
22707       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
22708       produces:
22709         - application/json
22710         - application/xml
22711       responses:
22712         "200":
22713           description: successful operation
22714           schema:
22715               $ref: "#/getDefinitions/sriov-pf"
22716         "default":
22717           description: Response codes found in [response codes](https://wiki.onap.org/).
22718       parameters:
22719         - name: equipment-name
22720           in: path
22721           required: true
22722           type: string
22723           example: __EQUIPMENT-NAME__
22724         - name: interface-name
22725           in: path
22726           description: Name that identifies the physical interface
22727           required: true
22728           type: string
22729           example: __INTERFACE-NAME__
22730         - name: pf-pci-id
22731           in: path
22732           description: Identifier for the sriov-pf
22733           required: true
22734           type: string
22735           example: __PF-PCI-ID__
22736     put:
22737       tags:
22738         - Network
22739       summary: create or update an existing sriov-pf
22740       description: |
22741         Create or update an existing sriov-pf.
22742         #
22743         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22744       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
22745       consumes:
22746         - application/json
22747         - application/xml
22748       produces:
22749         - application/json
22750         - application/xml
22751       responses:
22752         "default":
22753           description: Response codes found in [response codes](https://wiki.onap.org/).
22754       parameters:
22755         - name: equipment-name
22756           in: path
22757           required: true
22758           type: string
22759           example: __EQUIPMENT-NAME__
22760         - name: interface-name
22761           in: path
22762           description: Name that identifies the physical interface
22763           required: true
22764           type: string
22765           example: __INTERFACE-NAME__
22766         - name: pf-pci-id
22767           in: path
22768           description: Identifier for the sriov-pf
22769           required: true
22770           type: string
22771           example: __PF-PCI-ID__
22772         - name: body
22773           in: body
22774           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
22775           required: true
22776           schema:
22777             $ref: "#/definitions/sriov-pf"
22778     patch:
22779       tags:
22780         - Network
22781       summary: update an existing sriov-pf
22782       description: |
22783         Update an existing sriov-pf
22784         #
22785         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22786         The PUT operation will entirely replace an existing object.
22787         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22788         #
22789         Other differences between PUT and PATCH are:
22790         #
22791         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22792         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22793         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22794       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
22795       consumes:
22796         - application/json
22797         - application/xml
22798       produces:
22799         - application/json
22800         - application/xml
22801       responses:
22802         "default":
22803           description: Response codes found in [response codes](https://wiki.onap.org/).
22804       parameters:
22805         - name: equipment-name
22806           in: path
22807           required: true
22808           type: string
22809           example: __EQUIPMENT-NAME__
22810         - name: interface-name
22811           in: path
22812           description: Name that identifies the physical interface
22813           required: true
22814           type: string
22815           example: __INTERFACE-NAME__
22816         - name: pf-pci-id
22817           in: path
22818           description: Identifier for the sriov-pf
22819           required: true
22820           type: string
22821           example: __PF-PCI-ID__
22822         - name: body
22823           in: body
22824           description: sriov-pf object that needs to be updated.
22825           required: true
22826           schema:
22827             $ref: "#/patchDefinitions/sriov-pf"
22828     delete:
22829       tags:
22830         - Network
22831       summary: delete an existing sriov-pf
22832       description: delete an existing sriov-pf
22833       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
22834       consumes:
22835         - application/json
22836         - application/xml
22837       produces:
22838         - application/json
22839         - application/xml
22840       responses:
22841         "default":
22842           description: Response codes found in [response codes](https://wiki.onap.org/).
22843       parameters:
22844         - name: equipment-name
22845           in: path
22846           required: true
22847           type: string
22848           example: __EQUIPMENT-NAME__
22849         - name: interface-name
22850           in: path
22851           description: Name that identifies the physical interface
22852           required: true
22853           type: string
22854           example: __INTERFACE-NAME__
22855         - name: pf-pci-id
22856           in: path
22857           description: Identifier for the sriov-pf
22858           required: true
22859           type: string
22860           example: __PF-PCI-ID__
22861         - name: resource-version
22862           in: query
22863           description: resource-version for concurrency
22864           required: true
22865           type: string
22866   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
22867     get:
22868       tags:
22869         - Network
22870       summary: returns sriov-pfs
22871       description: returns sriov-pfs
22872       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
22873       produces:
22874         - application/json
22875         - application/xml
22876       responses:
22877         "200":
22878           description: successful operation
22879           schema:
22880               $ref: "#/getDefinitions/sriov-pfs"
22881         "default":
22882           description: Response codes found in [response codes](https://wiki.onap.org/).
22883       parameters:
22884         - name: equipment-name
22885           in: path
22886           required: true
22887           type: string
22888           example: __EQUIPMENT-NAME__
22889         - name: interface-name
22890           in: path
22891           description: Name that identifies the physical interface
22892           required: true
22893           type: string
22894           example: __INTERFACE-NAME__
22895         - name: pf-pci-id
22896           in: query
22897           description:
22898           required: false
22899           type: string
22900   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
22901     put:
22902       tags:
22903         - Network
22904       summary: see node definition for valid relationships
22905       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
22906       consumes:
22907         - application/json
22908         - application/xml
22909       produces:
22910         - application/json
22911         - application/xml
22912       responses:
22913         "default":
22914           description: Response codes found in [response codes](https://wiki.onap.org/).
22915       parameters:
22916         - name: equipment-name
22917           in: path
22918           required: true
22919           type: string
22920           example: __EQUIPMENT-NAME__
22921         - name: interface-name
22922           in: path
22923           description: Name that identifies the physical interface
22924           required: true
22925           type: string
22926           example: __INTERFACE-NAME__
22927         - name: interface-name
22928           in: path
22929           description: Name given to the interface
22930           required: true
22931           type: string
22932           example: __INTERFACE-NAME__
22933         - name: vlan-interface
22934           in: path
22935           description: String that identifies the interface
22936           required: true
22937           type: string
22938           example: __VLAN-INTERFACE__
22939         - name: body
22940           in: body
22941           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
22942           required: true
22943           schema:
22944             $ref: "#/definitions/relationship"
22945     delete:
22946       tags:
22947         - Network
22948       summary: delete an existing relationship
22949       description: delete an existing relationship
22950       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
22951       consumes:
22952         - application/json
22953         - application/xml
22954       produces:
22955         - application/json
22956         - application/xml
22957       responses:
22958         "default":
22959           description: Response codes found in [response codes](https://wiki.onap.org/).
22960       parameters:
22961         - name: equipment-name
22962           in: path
22963           required: true
22964           type: string
22965           example: __EQUIPMENT-NAME__
22966         - name: interface-name
22967           in: path
22968           description: Name that identifies the physical interface
22969           required: true
22970           type: string
22971           example: __INTERFACE-NAME__
22972         - name: interface-name
22973           in: path
22974           description: Name given to the interface
22975           required: true
22976           type: string
22977           example: __INTERFACE-NAME__
22978         - name: vlan-interface
22979           in: path
22980           description: String that identifies the interface
22981           required: true
22982           type: string
22983           example: __VLAN-INTERFACE__
22984   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
22985     put:
22986       tags:
22987         - Network
22988       summary: see node definition for valid relationships
22989       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
22990       consumes:
22991         - application/json
22992         - application/xml
22993       produces:
22994         - application/json
22995         - application/xml
22996       responses:
22997         "default":
22998           description: Response codes found in [response codes](https://wiki.onap.org/).
22999       parameters:
23000         - name: equipment-name
23001           in: path
23002           required: true
23003           type: string
23004           example: __EQUIPMENT-NAME__
23005         - name: interface-name
23006           in: path
23007           description: Name that identifies the physical interface
23008           required: true
23009           type: string
23010           example: __INTERFACE-NAME__
23011         - name: interface-name
23012           in: path
23013           description: Name given to the interface
23014           required: true
23015           type: string
23016           example: __INTERFACE-NAME__
23017         - name: vlan-interface
23018           in: path
23019           description: String that identifies the interface
23020           required: true
23021           type: string
23022           example: __VLAN-INTERFACE__
23023         - name: l3-interface-ipv4-address
23024           in: path
23025           description: IP address
23026           required: true
23027           type: string
23028           example: __L3-INTERFACE-IPV4-ADDRESS__
23029         - name: body
23030           in: body
23031           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
23032           required: true
23033           schema:
23034             $ref: "#/definitions/relationship"
23035     delete:
23036       tags:
23037         - Network
23038       summary: delete an existing relationship
23039       description: delete an existing relationship
23040       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
23041       consumes:
23042         - application/json
23043         - application/xml
23044       produces:
23045         - application/json
23046         - application/xml
23047       responses:
23048         "default":
23049           description: Response codes found in [response codes](https://wiki.onap.org/).
23050       parameters:
23051         - name: equipment-name
23052           in: path
23053           required: true
23054           type: string
23055           example: __EQUIPMENT-NAME__
23056         - name: interface-name
23057           in: path
23058           description: Name that identifies the physical interface
23059           required: true
23060           type: string
23061           example: __INTERFACE-NAME__
23062         - name: interface-name
23063           in: path
23064           description: Name given to the interface
23065           required: true
23066           type: string
23067           example: __INTERFACE-NAME__
23068         - name: vlan-interface
23069           in: path
23070           description: String that identifies the interface
23071           required: true
23072           type: string
23073           example: __VLAN-INTERFACE__
23074         - name: l3-interface-ipv4-address
23075           in: path
23076           description: IP address
23077           required: true
23078           type: string
23079           example: __L3-INTERFACE-IPV4-ADDRESS__
23080   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
23081     get:
23082       tags:
23083         - Network
23084       summary: returns l3-interface-ipv4-address-list
23085       description: returns l3-interface-ipv4-address-list
23086       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23087       produces:
23088         - application/json
23089         - application/xml
23090       responses:
23091         "200":
23092           description: successful operation
23093           schema:
23094               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
23095         "default":
23096           description: Response codes found in [response codes](https://wiki.onap.org/).
23097       parameters:
23098         - name: equipment-name
23099           in: path
23100           required: true
23101           type: string
23102           example: __EQUIPMENT-NAME__
23103         - name: interface-name
23104           in: path
23105           description: Name that identifies the physical interface
23106           required: true
23107           type: string
23108           example: __INTERFACE-NAME__
23109         - name: interface-name
23110           in: path
23111           description: Name given to the interface
23112           required: true
23113           type: string
23114           example: __INTERFACE-NAME__
23115         - name: vlan-interface
23116           in: path
23117           description: String that identifies the interface
23118           required: true
23119           type: string
23120           example: __VLAN-INTERFACE__
23121         - name: l3-interface-ipv4-address
23122           in: path
23123           description: IP address
23124           required: true
23125           type: string
23126           example: __L3-INTERFACE-IPV4-ADDRESS__
23127     put:
23128       tags:
23129         - Network
23130       summary: create or update an existing l3-interface-ipv4-address-list
23131       description: |
23132         Create or update an existing l3-interface-ipv4-address-list.
23133         #
23134         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23135       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23136       consumes:
23137         - application/json
23138         - application/xml
23139       produces:
23140         - application/json
23141         - application/xml
23142       responses:
23143         "default":
23144           description: Response codes found in [response codes](https://wiki.onap.org/).
23145       parameters:
23146         - name: equipment-name
23147           in: path
23148           required: true
23149           type: string
23150           example: __EQUIPMENT-NAME__
23151         - name: interface-name
23152           in: path
23153           description: Name that identifies the physical interface
23154           required: true
23155           type: string
23156           example: __INTERFACE-NAME__
23157         - name: interface-name
23158           in: path
23159           description: Name given to the interface
23160           required: true
23161           type: string
23162           example: __INTERFACE-NAME__
23163         - name: vlan-interface
23164           in: path
23165           description: String that identifies the interface
23166           required: true
23167           type: string
23168           example: __VLAN-INTERFACE__
23169         - name: l3-interface-ipv4-address
23170           in: path
23171           description: IP address
23172           required: true
23173           type: string
23174           example: __L3-INTERFACE-IPV4-ADDRESS__
23175         - name: body
23176           in: body
23177           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
23178           required: true
23179           schema:
23180             $ref: "#/definitions/l3-interface-ipv4-address-list"
23181     patch:
23182       tags:
23183         - Network
23184       summary: update an existing l3-interface-ipv4-address-list
23185       description: |
23186         Update an existing l3-interface-ipv4-address-list
23187         #
23188         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23189         The PUT operation will entirely replace an existing object.
23190         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23191         #
23192         Other differences between PUT and PATCH are:
23193         #
23194         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23195         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23196         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23197       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23198       consumes:
23199         - application/json
23200         - application/xml
23201       produces:
23202         - application/json
23203         - application/xml
23204       responses:
23205         "default":
23206           description: Response codes found in [response codes](https://wiki.onap.org/).
23207       parameters:
23208         - name: equipment-name
23209           in: path
23210           required: true
23211           type: string
23212           example: __EQUIPMENT-NAME__
23213         - name: interface-name
23214           in: path
23215           description: Name that identifies the physical interface
23216           required: true
23217           type: string
23218           example: __INTERFACE-NAME__
23219         - name: interface-name
23220           in: path
23221           description: Name given to the interface
23222           required: true
23223           type: string
23224           example: __INTERFACE-NAME__
23225         - name: vlan-interface
23226           in: path
23227           description: String that identifies the interface
23228           required: true
23229           type: string
23230           example: __VLAN-INTERFACE__
23231         - name: l3-interface-ipv4-address
23232           in: path
23233           description: IP address
23234           required: true
23235           type: string
23236           example: __L3-INTERFACE-IPV4-ADDRESS__
23237         - name: body
23238           in: body
23239           description: l3-interface-ipv4-address-list object that needs to be updated.
23240           required: true
23241           schema:
23242             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23243     delete:
23244       tags:
23245         - Network
23246       summary: delete an existing l3-interface-ipv4-address-list
23247       description: delete an existing l3-interface-ipv4-address-list
23248       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23249       consumes:
23250         - application/json
23251         - application/xml
23252       produces:
23253         - application/json
23254         - application/xml
23255       responses:
23256         "default":
23257           description: Response codes found in [response codes](https://wiki.onap.org/).
23258       parameters:
23259         - name: equipment-name
23260           in: path
23261           required: true
23262           type: string
23263           example: __EQUIPMENT-NAME__
23264         - name: interface-name
23265           in: path
23266           description: Name that identifies the physical interface
23267           required: true
23268           type: string
23269           example: __INTERFACE-NAME__
23270         - name: interface-name
23271           in: path
23272           description: Name given to the interface
23273           required: true
23274           type: string
23275           example: __INTERFACE-NAME__
23276         - name: vlan-interface
23277           in: path
23278           description: String that identifies the interface
23279           required: true
23280           type: string
23281           example: __VLAN-INTERFACE__
23282         - name: l3-interface-ipv4-address
23283           in: path
23284           description: IP address
23285           required: true
23286           type: string
23287           example: __L3-INTERFACE-IPV4-ADDRESS__
23288         - name: resource-version
23289           in: query
23290           description: resource-version for concurrency
23291           required: true
23292           type: string
23293   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
23294     put:
23295       tags:
23296         - Network
23297       summary: see node definition for valid relationships
23298       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
23299       consumes:
23300         - application/json
23301         - application/xml
23302       produces:
23303         - application/json
23304         - application/xml
23305       responses:
23306         "default":
23307           description: Response codes found in [response codes](https://wiki.onap.org/).
23308       parameters:
23309         - name: equipment-name
23310           in: path
23311           required: true
23312           type: string
23313           example: __EQUIPMENT-NAME__
23314         - name: interface-name
23315           in: path
23316           description: Name that identifies the physical interface
23317           required: true
23318           type: string
23319           example: __INTERFACE-NAME__
23320         - name: interface-name
23321           in: path
23322           description: Name given to the interface
23323           required: true
23324           type: string
23325           example: __INTERFACE-NAME__
23326         - name: vlan-interface
23327           in: path
23328           description: String that identifies the interface
23329           required: true
23330           type: string
23331           example: __VLAN-INTERFACE__
23332         - name: l3-interface-ipv6-address
23333           in: path
23334           description: IP address
23335           required: true
23336           type: string
23337           example: __L3-INTERFACE-IPV6-ADDRESS__
23338         - name: body
23339           in: body
23340           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
23341           required: true
23342           schema:
23343             $ref: "#/definitions/relationship"
23344     delete:
23345       tags:
23346         - Network
23347       summary: delete an existing relationship
23348       description: delete an existing relationship
23349       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
23350       consumes:
23351         - application/json
23352         - application/xml
23353       produces:
23354         - application/json
23355         - application/xml
23356       responses:
23357         "default":
23358           description: Response codes found in [response codes](https://wiki.onap.org/).
23359       parameters:
23360         - name: equipment-name
23361           in: path
23362           required: true
23363           type: string
23364           example: __EQUIPMENT-NAME__
23365         - name: interface-name
23366           in: path
23367           description: Name that identifies the physical interface
23368           required: true
23369           type: string
23370           example: __INTERFACE-NAME__
23371         - name: interface-name
23372           in: path
23373           description: Name given to the interface
23374           required: true
23375           type: string
23376           example: __INTERFACE-NAME__
23377         - name: vlan-interface
23378           in: path
23379           description: String that identifies the interface
23380           required: true
23381           type: string
23382           example: __VLAN-INTERFACE__
23383         - name: l3-interface-ipv6-address
23384           in: path
23385           description: IP address
23386           required: true
23387           type: string
23388           example: __L3-INTERFACE-IPV6-ADDRESS__
23389   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
23390     get:
23391       tags:
23392         - Network
23393       summary: returns l3-interface-ipv6-address-list
23394       description: returns l3-interface-ipv6-address-list
23395       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23396       produces:
23397         - application/json
23398         - application/xml
23399       responses:
23400         "200":
23401           description: successful operation
23402           schema:
23403               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
23404         "default":
23405           description: Response codes found in [response codes](https://wiki.onap.org/).
23406       parameters:
23407         - name: equipment-name
23408           in: path
23409           required: true
23410           type: string
23411           example: __EQUIPMENT-NAME__
23412         - name: interface-name
23413           in: path
23414           description: Name that identifies the physical interface
23415           required: true
23416           type: string
23417           example: __INTERFACE-NAME__
23418         - name: interface-name
23419           in: path
23420           description: Name given to the interface
23421           required: true
23422           type: string
23423           example: __INTERFACE-NAME__
23424         - name: vlan-interface
23425           in: path
23426           description: String that identifies the interface
23427           required: true
23428           type: string
23429           example: __VLAN-INTERFACE__
23430         - name: l3-interface-ipv6-address
23431           in: path
23432           description: IP address
23433           required: true
23434           type: string
23435           example: __L3-INTERFACE-IPV6-ADDRESS__
23436     put:
23437       tags:
23438         - Network
23439       summary: create or update an existing l3-interface-ipv6-address-list
23440       description: |
23441         Create or update an existing l3-interface-ipv6-address-list.
23442         #
23443         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23444       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23445       consumes:
23446         - application/json
23447         - application/xml
23448       produces:
23449         - application/json
23450         - application/xml
23451       responses:
23452         "default":
23453           description: Response codes found in [response codes](https://wiki.onap.org/).
23454       parameters:
23455         - name: equipment-name
23456           in: path
23457           required: true
23458           type: string
23459           example: __EQUIPMENT-NAME__
23460         - name: interface-name
23461           in: path
23462           description: Name that identifies the physical interface
23463           required: true
23464           type: string
23465           example: __INTERFACE-NAME__
23466         - name: interface-name
23467           in: path
23468           description: Name given to the interface
23469           required: true
23470           type: string
23471           example: __INTERFACE-NAME__
23472         - name: vlan-interface
23473           in: path
23474           description: String that identifies the interface
23475           required: true
23476           type: string
23477           example: __VLAN-INTERFACE__
23478         - name: l3-interface-ipv6-address
23479           in: path
23480           description: IP address
23481           required: true
23482           type: string
23483           example: __L3-INTERFACE-IPV6-ADDRESS__
23484         - name: body
23485           in: body
23486           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
23487           required: true
23488           schema:
23489             $ref: "#/definitions/l3-interface-ipv6-address-list"
23490     patch:
23491       tags:
23492         - Network
23493       summary: update an existing l3-interface-ipv6-address-list
23494       description: |
23495         Update an existing l3-interface-ipv6-address-list
23496         #
23497         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23498         The PUT operation will entirely replace an existing object.
23499         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23500         #
23501         Other differences between PUT and PATCH are:
23502         #
23503         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23504         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23505         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23506       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23507       consumes:
23508         - application/json
23509         - application/xml
23510       produces:
23511         - application/json
23512         - application/xml
23513       responses:
23514         "default":
23515           description: Response codes found in [response codes](https://wiki.onap.org/).
23516       parameters:
23517         - name: equipment-name
23518           in: path
23519           required: true
23520           type: string
23521           example: __EQUIPMENT-NAME__
23522         - name: interface-name
23523           in: path
23524           description: Name that identifies the physical interface
23525           required: true
23526           type: string
23527           example: __INTERFACE-NAME__
23528         - name: interface-name
23529           in: path
23530           description: Name given to the interface
23531           required: true
23532           type: string
23533           example: __INTERFACE-NAME__
23534         - name: vlan-interface
23535           in: path
23536           description: String that identifies the interface
23537           required: true
23538           type: string
23539           example: __VLAN-INTERFACE__
23540         - name: l3-interface-ipv6-address
23541           in: path
23542           description: IP address
23543           required: true
23544           type: string
23545           example: __L3-INTERFACE-IPV6-ADDRESS__
23546         - name: body
23547           in: body
23548           description: l3-interface-ipv6-address-list object that needs to be updated.
23549           required: true
23550           schema:
23551             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
23552     delete:
23553       tags:
23554         - Network
23555       summary: delete an existing l3-interface-ipv6-address-list
23556       description: delete an existing l3-interface-ipv6-address-list
23557       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23558       consumes:
23559         - application/json
23560         - application/xml
23561       produces:
23562         - application/json
23563         - application/xml
23564       responses:
23565         "default":
23566           description: Response codes found in [response codes](https://wiki.onap.org/).
23567       parameters:
23568         - name: equipment-name
23569           in: path
23570           required: true
23571           type: string
23572           example: __EQUIPMENT-NAME__
23573         - name: interface-name
23574           in: path
23575           description: Name that identifies the physical interface
23576           required: true
23577           type: string
23578           example: __INTERFACE-NAME__
23579         - name: interface-name
23580           in: path
23581           description: Name given to the interface
23582           required: true
23583           type: string
23584           example: __INTERFACE-NAME__
23585         - name: vlan-interface
23586           in: path
23587           description: String that identifies the interface
23588           required: true
23589           type: string
23590           example: __VLAN-INTERFACE__
23591         - name: l3-interface-ipv6-address
23592           in: path
23593           description: IP address
23594           required: true
23595           type: string
23596           example: __L3-INTERFACE-IPV6-ADDRESS__
23597         - name: resource-version
23598           in: query
23599           description: resource-version for concurrency
23600           required: true
23601           type: string
23602   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
23603     get:
23604       tags:
23605         - Network
23606       summary: returns vlan
23607       description: returns vlan
23608       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
23609       produces:
23610         - application/json
23611         - application/xml
23612       responses:
23613         "200":
23614           description: successful operation
23615           schema:
23616               $ref: "#/getDefinitions/vlan"
23617         "default":
23618           description: Response codes found in [response codes](https://wiki.onap.org/).
23619       parameters:
23620         - name: equipment-name
23621           in: path
23622           required: true
23623           type: string
23624           example: __EQUIPMENT-NAME__
23625         - name: interface-name
23626           in: path
23627           description: Name that identifies the physical interface
23628           required: true
23629           type: string
23630           example: __INTERFACE-NAME__
23631         - name: interface-name
23632           in: path
23633           description: Name given to the interface
23634           required: true
23635           type: string
23636           example: __INTERFACE-NAME__
23637         - name: vlan-interface
23638           in: path
23639           description: String that identifies the interface
23640           required: true
23641           type: string
23642           example: __VLAN-INTERFACE__
23643     put:
23644       tags:
23645         - Network
23646       summary: create or update an existing vlan
23647       description: |
23648         Create or update an existing vlan.
23649         #
23650         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23651       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
23652       consumes:
23653         - application/json
23654         - application/xml
23655       produces:
23656         - application/json
23657         - application/xml
23658       responses:
23659         "default":
23660           description: Response codes found in [response codes](https://wiki.onap.org/).
23661       parameters:
23662         - name: equipment-name
23663           in: path
23664           required: true
23665           type: string
23666           example: __EQUIPMENT-NAME__
23667         - name: interface-name
23668           in: path
23669           description: Name that identifies the physical interface
23670           required: true
23671           type: string
23672           example: __INTERFACE-NAME__
23673         - name: interface-name
23674           in: path
23675           description: Name given to the interface
23676           required: true
23677           type: string
23678           example: __INTERFACE-NAME__
23679         - name: vlan-interface
23680           in: path
23681           description: String that identifies the interface
23682           required: true
23683           type: string
23684           example: __VLAN-INTERFACE__
23685         - name: body
23686           in: body
23687           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
23688           required: true
23689           schema:
23690             $ref: "#/definitions/vlan"
23691     patch:
23692       tags:
23693         - Network
23694       summary: update an existing vlan
23695       description: |
23696         Update an existing vlan
23697         #
23698         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23699         The PUT operation will entirely replace an existing object.
23700         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23701         #
23702         Other differences between PUT and PATCH are:
23703         #
23704         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23705         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23706         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23707       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
23708       consumes:
23709         - application/json
23710         - application/xml
23711       produces:
23712         - application/json
23713         - application/xml
23714       responses:
23715         "default":
23716           description: Response codes found in [response codes](https://wiki.onap.org/).
23717       parameters:
23718         - name: equipment-name
23719           in: path
23720           required: true
23721           type: string
23722           example: __EQUIPMENT-NAME__
23723         - name: interface-name
23724           in: path
23725           description: Name that identifies the physical interface
23726           required: true
23727           type: string
23728           example: __INTERFACE-NAME__
23729         - name: interface-name
23730           in: path
23731           description: Name given to the interface
23732           required: true
23733           type: string
23734           example: __INTERFACE-NAME__
23735         - name: vlan-interface
23736           in: path
23737           description: String that identifies the interface
23738           required: true
23739           type: string
23740           example: __VLAN-INTERFACE__
23741         - name: body
23742           in: body
23743           description: vlan object that needs to be updated.
23744           required: true
23745           schema:
23746             $ref: "#/patchDefinitions/vlan"
23747     delete:
23748       tags:
23749         - Network
23750       summary: delete an existing vlan
23751       description: delete an existing vlan
23752       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
23753       consumes:
23754         - application/json
23755         - application/xml
23756       produces:
23757         - application/json
23758         - application/xml
23759       responses:
23760         "default":
23761           description: Response codes found in [response codes](https://wiki.onap.org/).
23762       parameters:
23763         - name: equipment-name
23764           in: path
23765           required: true
23766           type: string
23767           example: __EQUIPMENT-NAME__
23768         - name: interface-name
23769           in: path
23770           description: Name that identifies the physical interface
23771           required: true
23772           type: string
23773           example: __INTERFACE-NAME__
23774         - name: interface-name
23775           in: path
23776           description: Name given to the interface
23777           required: true
23778           type: string
23779           example: __INTERFACE-NAME__
23780         - name: vlan-interface
23781           in: path
23782           description: String that identifies the interface
23783           required: true
23784           type: string
23785           example: __VLAN-INTERFACE__
23786         - name: resource-version
23787           in: query
23788           description: resource-version for concurrency
23789           required: true
23790           type: string
23791   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
23792     get:
23793       tags:
23794         - Network
23795       summary: returns vlans
23796       description: returns vlans
23797       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
23798       produces:
23799         - application/json
23800         - application/xml
23801       responses:
23802         "200":
23803           description: successful operation
23804           schema:
23805               $ref: "#/getDefinitions/vlans"
23806         "default":
23807           description: Response codes found in [response codes](https://wiki.onap.org/).
23808       parameters:
23809         - name: equipment-name
23810           in: path
23811           required: true
23812           type: string
23813           example: __EQUIPMENT-NAME__
23814         - name: interface-name
23815           in: path
23816           description: Name that identifies the physical interface
23817           required: true
23818           type: string
23819           example: __INTERFACE-NAME__
23820         - name: interface-name
23821           in: path
23822           description: Name given to the interface
23823           required: true
23824           type: string
23825           example: __INTERFACE-NAME__
23826         - name: vlan-interface
23827           in: query
23828           description:
23829           required: false
23830           type: string
23831         - name: vlan-id-inner
23832           in: query
23833           description:
23834           required: false
23835           type: integer
23836           format: int64
23837         - name: vpn-key
23838           in: query
23839           description:
23840           required: false
23841           type: string
23842   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
23843     put:
23844       tags:
23845         - Network
23846       summary: see node definition for valid relationships
23847       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
23848       consumes:
23849         - application/json
23850         - application/xml
23851       produces:
23852         - application/json
23853         - application/xml
23854       responses:
23855         "default":
23856           description: Response codes found in [response codes](https://wiki.onap.org/).
23857       parameters:
23858         - name: equipment-name
23859           in: path
23860           required: true
23861           type: string
23862           example: __EQUIPMENT-NAME__
23863         - name: interface-name
23864           in: path
23865           description: Name that identifies the physical interface
23866           required: true
23867           type: string
23868           example: __INTERFACE-NAME__
23869         - name: interface-name
23870           in: path
23871           description: Name given to the interface
23872           required: true
23873           type: string
23874           example: __INTERFACE-NAME__
23875         - name: pci-id
23876           in: path
23877           description: PCI ID used to identify the sriov-vf
23878           required: true
23879           type: string
23880           example: __PCI-ID__
23881         - name: body
23882           in: body
23883           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
23884           required: true
23885           schema:
23886             $ref: "#/definitions/relationship"
23887     delete:
23888       tags:
23889         - Network
23890       summary: delete an existing relationship
23891       description: delete an existing relationship
23892       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
23893       consumes:
23894         - application/json
23895         - application/xml
23896       produces:
23897         - application/json
23898         - application/xml
23899       responses:
23900         "default":
23901           description: Response codes found in [response codes](https://wiki.onap.org/).
23902       parameters:
23903         - name: equipment-name
23904           in: path
23905           required: true
23906           type: string
23907           example: __EQUIPMENT-NAME__
23908         - name: interface-name
23909           in: path
23910           description: Name that identifies the physical interface
23911           required: true
23912           type: string
23913           example: __INTERFACE-NAME__
23914         - name: interface-name
23915           in: path
23916           description: Name given to the interface
23917           required: true
23918           type: string
23919           example: __INTERFACE-NAME__
23920         - name: pci-id
23921           in: path
23922           description: PCI ID used to identify the sriov-vf
23923           required: true
23924           type: string
23925           example: __PCI-ID__
23926   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
23927     get:
23928       tags:
23929         - Network
23930       summary: returns sriov-vf
23931       description: returns sriov-vf
23932       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23933       produces:
23934         - application/json
23935         - application/xml
23936       responses:
23937         "200":
23938           description: successful operation
23939           schema:
23940               $ref: "#/getDefinitions/sriov-vf"
23941         "default":
23942           description: Response codes found in [response codes](https://wiki.onap.org/).
23943       parameters:
23944         - name: equipment-name
23945           in: path
23946           required: true
23947           type: string
23948           example: __EQUIPMENT-NAME__
23949         - name: interface-name
23950           in: path
23951           description: Name that identifies the physical interface
23952           required: true
23953           type: string
23954           example: __INTERFACE-NAME__
23955         - name: interface-name
23956           in: path
23957           description: Name given to the interface
23958           required: true
23959           type: string
23960           example: __INTERFACE-NAME__
23961         - name: pci-id
23962           in: path
23963           description: PCI ID used to identify the sriov-vf
23964           required: true
23965           type: string
23966           example: __PCI-ID__
23967     put:
23968       tags:
23969         - Network
23970       summary: create or update an existing sriov-vf
23971       description: |
23972         Create or update an existing sriov-vf.
23973         #
23974         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23975       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23976       consumes:
23977         - application/json
23978         - application/xml
23979       produces:
23980         - application/json
23981         - application/xml
23982       responses:
23983         "default":
23984           description: Response codes found in [response codes](https://wiki.onap.org/).
23985       parameters:
23986         - name: equipment-name
23987           in: path
23988           required: true
23989           type: string
23990           example: __EQUIPMENT-NAME__
23991         - name: interface-name
23992           in: path
23993           description: Name that identifies the physical interface
23994           required: true
23995           type: string
23996           example: __INTERFACE-NAME__
23997         - name: interface-name
23998           in: path
23999           description: Name given to the interface
24000           required: true
24001           type: string
24002           example: __INTERFACE-NAME__
24003         - name: pci-id
24004           in: path
24005           description: PCI ID used to identify the sriov-vf
24006           required: true
24007           type: string
24008           example: __PCI-ID__
24009         - name: body
24010           in: body
24011           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
24012           required: true
24013           schema:
24014             $ref: "#/definitions/sriov-vf"
24015     patch:
24016       tags:
24017         - Network
24018       summary: update an existing sriov-vf
24019       description: |
24020         Update an existing sriov-vf
24021         #
24022         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24023         The PUT operation will entirely replace an existing object.
24024         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24025         #
24026         Other differences between PUT and PATCH are:
24027         #
24028         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24029         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24030         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24031       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
24032       consumes:
24033         - application/json
24034         - application/xml
24035       produces:
24036         - application/json
24037         - application/xml
24038       responses:
24039         "default":
24040           description: Response codes found in [response codes](https://wiki.onap.org/).
24041       parameters:
24042         - name: equipment-name
24043           in: path
24044           required: true
24045           type: string
24046           example: __EQUIPMENT-NAME__
24047         - name: interface-name
24048           in: path
24049           description: Name that identifies the physical interface
24050           required: true
24051           type: string
24052           example: __INTERFACE-NAME__
24053         - name: interface-name
24054           in: path
24055           description: Name given to the interface
24056           required: true
24057           type: string
24058           example: __INTERFACE-NAME__
24059         - name: pci-id
24060           in: path
24061           description: PCI ID used to identify the sriov-vf
24062           required: true
24063           type: string
24064           example: __PCI-ID__
24065         - name: body
24066           in: body
24067           description: sriov-vf object that needs to be updated.
24068           required: true
24069           schema:
24070             $ref: "#/patchDefinitions/sriov-vf"
24071     delete:
24072       tags:
24073         - Network
24074       summary: delete an existing sriov-vf
24075       description: delete an existing sriov-vf
24076       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
24077       consumes:
24078         - application/json
24079         - application/xml
24080       produces:
24081         - application/json
24082         - application/xml
24083       responses:
24084         "default":
24085           description: Response codes found in [response codes](https://wiki.onap.org/).
24086       parameters:
24087         - name: equipment-name
24088           in: path
24089           required: true
24090           type: string
24091           example: __EQUIPMENT-NAME__
24092         - name: interface-name
24093           in: path
24094           description: Name that identifies the physical interface
24095           required: true
24096           type: string
24097           example: __INTERFACE-NAME__
24098         - name: interface-name
24099           in: path
24100           description: Name given to the interface
24101           required: true
24102           type: string
24103           example: __INTERFACE-NAME__
24104         - name: pci-id
24105           in: path
24106           description: PCI ID used to identify the sriov-vf
24107           required: true
24108           type: string
24109           example: __PCI-ID__
24110         - name: resource-version
24111           in: query
24112           description: resource-version for concurrency
24113           required: true
24114           type: string
24115   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
24116     get:
24117       tags:
24118         - Network
24119       summary: returns sriov-vfs
24120       description: returns sriov-vfs
24121       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
24122       produces:
24123         - application/json
24124         - application/xml
24125       responses:
24126         "200":
24127           description: successful operation
24128           schema:
24129               $ref: "#/getDefinitions/sriov-vfs"
24130         "default":
24131           description: Response codes found in [response codes](https://wiki.onap.org/).
24132       parameters:
24133         - name: equipment-name
24134           in: path
24135           required: true
24136           type: string
24137           example: __EQUIPMENT-NAME__
24138         - name: interface-name
24139           in: path
24140           description: Name that identifies the physical interface
24141           required: true
24142           type: string
24143           example: __INTERFACE-NAME__
24144         - name: interface-name
24145           in: path
24146           description: Name given to the interface
24147           required: true
24148           type: string
24149           example: __INTERFACE-NAME__
24150         - name: pci-id
24151           in: query
24152           description:
24153           required: false
24154           type: string
24155         - name: vf-vlan-filter
24156           in: query
24157           description:
24158           required: false
24159           type: string
24160         - name: vf-mac-filter
24161           in: query
24162           description:
24163           required: false
24164           type: string
24165         - name: vf-vlan-strip
24166           in: query
24167           description:
24168           required: false
24169           type: boolean
24170         - name: neutron-network-id
24171           in: query
24172           description:
24173           required: false
24174           type: string
24175   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
24176     put:
24177       tags:
24178         - Network
24179       summary: see node definition for valid relationships
24180       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
24181       consumes:
24182         - application/json
24183         - application/xml
24184       produces:
24185         - application/json
24186         - application/xml
24187       responses:
24188         "default":
24189           description: Response codes found in [response codes](https://wiki.onap.org/).
24190       parameters:
24191         - name: equipment-name
24192           in: path
24193           required: true
24194           type: string
24195           example: __EQUIPMENT-NAME__
24196         - name: interface-name
24197           in: path
24198           description: Name that identifies the physical interface
24199           required: true
24200           type: string
24201           example: __INTERFACE-NAME__
24202         - name: interface-name
24203           in: path
24204           description: Name given to the interface
24205           required: true
24206           type: string
24207           example: __INTERFACE-NAME__
24208         - name: body
24209           in: body
24210           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
24211           required: true
24212           schema:
24213             $ref: "#/definitions/relationship"
24214     delete:
24215       tags:
24216         - Network
24217       summary: delete an existing relationship
24218       description: delete an existing relationship
24219       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
24220       consumes:
24221         - application/json
24222         - application/xml
24223       produces:
24224         - application/json
24225         - application/xml
24226       responses:
24227         "default":
24228           description: Response codes found in [response codes](https://wiki.onap.org/).
24229       parameters:
24230         - name: equipment-name
24231           in: path
24232           required: true
24233           type: string
24234           example: __EQUIPMENT-NAME__
24235         - name: interface-name
24236           in: path
24237           description: Name that identifies the physical interface
24238           required: true
24239           type: string
24240           example: __INTERFACE-NAME__
24241         - name: interface-name
24242           in: path
24243           description: Name given to the interface
24244           required: true
24245           type: string
24246           example: __INTERFACE-NAME__
24247   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
24248     put:
24249       tags:
24250         - Network
24251       summary: see node definition for valid relationships
24252       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
24253       consumes:
24254         - application/json
24255         - application/xml
24256       produces:
24257         - application/json
24258         - application/xml
24259       responses:
24260         "default":
24261           description: Response codes found in [response codes](https://wiki.onap.org/).
24262       parameters:
24263         - name: equipment-name
24264           in: path
24265           required: true
24266           type: string
24267           example: __EQUIPMENT-NAME__
24268         - name: interface-name
24269           in: path
24270           description: Name that identifies the physical interface
24271           required: true
24272           type: string
24273           example: __INTERFACE-NAME__
24274         - name: interface-name
24275           in: path
24276           description: Name given to the interface
24277           required: true
24278           type: string
24279           example: __INTERFACE-NAME__
24280         - name: l3-interface-ipv4-address
24281           in: path
24282           description: IP address
24283           required: true
24284           type: string
24285           example: __L3-INTERFACE-IPV4-ADDRESS__
24286         - name: body
24287           in: body
24288           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
24289           required: true
24290           schema:
24291             $ref: "#/definitions/relationship"
24292     delete:
24293       tags:
24294         - Network
24295       summary: delete an existing relationship
24296       description: delete an existing relationship
24297       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
24298       consumes:
24299         - application/json
24300         - application/xml
24301       produces:
24302         - application/json
24303         - application/xml
24304       responses:
24305         "default":
24306           description: Response codes found in [response codes](https://wiki.onap.org/).
24307       parameters:
24308         - name: equipment-name
24309           in: path
24310           required: true
24311           type: string
24312           example: __EQUIPMENT-NAME__
24313         - name: interface-name
24314           in: path
24315           description: Name that identifies the physical interface
24316           required: true
24317           type: string
24318           example: __INTERFACE-NAME__
24319         - name: interface-name
24320           in: path
24321           description: Name given to the interface
24322           required: true
24323           type: string
24324           example: __INTERFACE-NAME__
24325         - name: l3-interface-ipv4-address
24326           in: path
24327           description: IP address
24328           required: true
24329           type: string
24330           example: __L3-INTERFACE-IPV4-ADDRESS__
24331   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
24332     get:
24333       tags:
24334         - Network
24335       summary: returns l3-interface-ipv4-address-list
24336       description: returns l3-interface-ipv4-address-list
24337       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24338       produces:
24339         - application/json
24340         - application/xml
24341       responses:
24342         "200":
24343           description: successful operation
24344           schema:
24345               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
24346         "default":
24347           description: Response codes found in [response codes](https://wiki.onap.org/).
24348       parameters:
24349         - name: equipment-name
24350           in: path
24351           required: true
24352           type: string
24353           example: __EQUIPMENT-NAME__
24354         - name: interface-name
24355           in: path
24356           description: Name that identifies the physical interface
24357           required: true
24358           type: string
24359           example: __INTERFACE-NAME__
24360         - name: interface-name
24361           in: path
24362           description: Name given to the interface
24363           required: true
24364           type: string
24365           example: __INTERFACE-NAME__
24366         - name: l3-interface-ipv4-address
24367           in: path
24368           description: IP address
24369           required: true
24370           type: string
24371           example: __L3-INTERFACE-IPV4-ADDRESS__
24372     put:
24373       tags:
24374         - Network
24375       summary: create or update an existing l3-interface-ipv4-address-list
24376       description: |
24377         Create or update an existing l3-interface-ipv4-address-list.
24378         #
24379         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24380       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24381       consumes:
24382         - application/json
24383         - application/xml
24384       produces:
24385         - application/json
24386         - application/xml
24387       responses:
24388         "default":
24389           description: Response codes found in [response codes](https://wiki.onap.org/).
24390       parameters:
24391         - name: equipment-name
24392           in: path
24393           required: true
24394           type: string
24395           example: __EQUIPMENT-NAME__
24396         - name: interface-name
24397           in: path
24398           description: Name that identifies the physical interface
24399           required: true
24400           type: string
24401           example: __INTERFACE-NAME__
24402         - name: interface-name
24403           in: path
24404           description: Name given to the interface
24405           required: true
24406           type: string
24407           example: __INTERFACE-NAME__
24408         - name: l3-interface-ipv4-address
24409           in: path
24410           description: IP address
24411           required: true
24412           type: string
24413           example: __L3-INTERFACE-IPV4-ADDRESS__
24414         - name: body
24415           in: body
24416           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
24417           required: true
24418           schema:
24419             $ref: "#/definitions/l3-interface-ipv4-address-list"
24420     patch:
24421       tags:
24422         - Network
24423       summary: update an existing l3-interface-ipv4-address-list
24424       description: |
24425         Update an existing l3-interface-ipv4-address-list
24426         #
24427         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24428         The PUT operation will entirely replace an existing object.
24429         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24430         #
24431         Other differences between PUT and PATCH are:
24432         #
24433         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24434         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24435         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24436       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24437       consumes:
24438         - application/json
24439         - application/xml
24440       produces:
24441         - application/json
24442         - application/xml
24443       responses:
24444         "default":
24445           description: Response codes found in [response codes](https://wiki.onap.org/).
24446       parameters:
24447         - name: equipment-name
24448           in: path
24449           required: true
24450           type: string
24451           example: __EQUIPMENT-NAME__
24452         - name: interface-name
24453           in: path
24454           description: Name that identifies the physical interface
24455           required: true
24456           type: string
24457           example: __INTERFACE-NAME__
24458         - name: interface-name
24459           in: path
24460           description: Name given to the interface
24461           required: true
24462           type: string
24463           example: __INTERFACE-NAME__
24464         - name: l3-interface-ipv4-address
24465           in: path
24466           description: IP address
24467           required: true
24468           type: string
24469           example: __L3-INTERFACE-IPV4-ADDRESS__
24470         - name: body
24471           in: body
24472           description: l3-interface-ipv4-address-list object that needs to be updated.
24473           required: true
24474           schema:
24475             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
24476     delete:
24477       tags:
24478         - Network
24479       summary: delete an existing l3-interface-ipv4-address-list
24480       description: delete an existing l3-interface-ipv4-address-list
24481       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24482       consumes:
24483         - application/json
24484         - application/xml
24485       produces:
24486         - application/json
24487         - application/xml
24488       responses:
24489         "default":
24490           description: Response codes found in [response codes](https://wiki.onap.org/).
24491       parameters:
24492         - name: equipment-name
24493           in: path
24494           required: true
24495           type: string
24496           example: __EQUIPMENT-NAME__
24497         - name: interface-name
24498           in: path
24499           description: Name that identifies the physical interface
24500           required: true
24501           type: string
24502           example: __INTERFACE-NAME__
24503         - name: interface-name
24504           in: path
24505           description: Name given to the interface
24506           required: true
24507           type: string
24508           example: __INTERFACE-NAME__
24509         - name: l3-interface-ipv4-address
24510           in: path
24511           description: IP address
24512           required: true
24513           type: string
24514           example: __L3-INTERFACE-IPV4-ADDRESS__
24515         - name: resource-version
24516           in: query
24517           description: resource-version for concurrency
24518           required: true
24519           type: string
24520   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
24521     put:
24522       tags:
24523         - Network
24524       summary: see node definition for valid relationships
24525       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
24526       consumes:
24527         - application/json
24528         - application/xml
24529       produces:
24530         - application/json
24531         - application/xml
24532       responses:
24533         "default":
24534           description: Response codes found in [response codes](https://wiki.onap.org/).
24535       parameters:
24536         - name: equipment-name
24537           in: path
24538           required: true
24539           type: string
24540           example: __EQUIPMENT-NAME__
24541         - name: interface-name
24542           in: path
24543           description: Name that identifies the physical interface
24544           required: true
24545           type: string
24546           example: __INTERFACE-NAME__
24547         - name: interface-name
24548           in: path
24549           description: Name given to the interface
24550           required: true
24551           type: string
24552           example: __INTERFACE-NAME__
24553         - name: l3-interface-ipv6-address
24554           in: path
24555           description: IP address
24556           required: true
24557           type: string
24558           example: __L3-INTERFACE-IPV6-ADDRESS__
24559         - name: body
24560           in: body
24561           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
24562           required: true
24563           schema:
24564             $ref: "#/definitions/relationship"
24565     delete:
24566       tags:
24567         - Network
24568       summary: delete an existing relationship
24569       description: delete an existing relationship
24570       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
24571       consumes:
24572         - application/json
24573         - application/xml
24574       produces:
24575         - application/json
24576         - application/xml
24577       responses:
24578         "default":
24579           description: Response codes found in [response codes](https://wiki.onap.org/).
24580       parameters:
24581         - name: equipment-name
24582           in: path
24583           required: true
24584           type: string
24585           example: __EQUIPMENT-NAME__
24586         - name: interface-name
24587           in: path
24588           description: Name that identifies the physical interface
24589           required: true
24590           type: string
24591           example: __INTERFACE-NAME__
24592         - name: interface-name
24593           in: path
24594           description: Name given to the interface
24595           required: true
24596           type: string
24597           example: __INTERFACE-NAME__
24598         - name: l3-interface-ipv6-address
24599           in: path
24600           description: IP address
24601           required: true
24602           type: string
24603           example: __L3-INTERFACE-IPV6-ADDRESS__
24604   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
24605     get:
24606       tags:
24607         - Network
24608       summary: returns l3-interface-ipv6-address-list
24609       description: returns l3-interface-ipv6-address-list
24610       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24611       produces:
24612         - application/json
24613         - application/xml
24614       responses:
24615         "200":
24616           description: successful operation
24617           schema:
24618               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
24619         "default":
24620           description: Response codes found in [response codes](https://wiki.onap.org/).
24621       parameters:
24622         - name: equipment-name
24623           in: path
24624           required: true
24625           type: string
24626           example: __EQUIPMENT-NAME__
24627         - name: interface-name
24628           in: path
24629           description: Name that identifies the physical interface
24630           required: true
24631           type: string
24632           example: __INTERFACE-NAME__
24633         - name: interface-name
24634           in: path
24635           description: Name given to the interface
24636           required: true
24637           type: string
24638           example: __INTERFACE-NAME__
24639         - name: l3-interface-ipv6-address
24640           in: path
24641           description: IP address
24642           required: true
24643           type: string
24644           example: __L3-INTERFACE-IPV6-ADDRESS__
24645     put:
24646       tags:
24647         - Network
24648       summary: create or update an existing l3-interface-ipv6-address-list
24649       description: |
24650         Create or update an existing l3-interface-ipv6-address-list.
24651         #
24652         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24653       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24654       consumes:
24655         - application/json
24656         - application/xml
24657       produces:
24658         - application/json
24659         - application/xml
24660       responses:
24661         "default":
24662           description: Response codes found in [response codes](https://wiki.onap.org/).
24663       parameters:
24664         - name: equipment-name
24665           in: path
24666           required: true
24667           type: string
24668           example: __EQUIPMENT-NAME__
24669         - name: interface-name
24670           in: path
24671           description: Name that identifies the physical interface
24672           required: true
24673           type: string
24674           example: __INTERFACE-NAME__
24675         - name: interface-name
24676           in: path
24677           description: Name given to the interface
24678           required: true
24679           type: string
24680           example: __INTERFACE-NAME__
24681         - name: l3-interface-ipv6-address
24682           in: path
24683           description: IP address
24684           required: true
24685           type: string
24686           example: __L3-INTERFACE-IPV6-ADDRESS__
24687         - name: body
24688           in: body
24689           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
24690           required: true
24691           schema:
24692             $ref: "#/definitions/l3-interface-ipv6-address-list"
24693     patch:
24694       tags:
24695         - Network
24696       summary: update an existing l3-interface-ipv6-address-list
24697       description: |
24698         Update an existing l3-interface-ipv6-address-list
24699         #
24700         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24701         The PUT operation will entirely replace an existing object.
24702         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24703         #
24704         Other differences between PUT and PATCH are:
24705         #
24706         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24707         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24708         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24709       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24710       consumes:
24711         - application/json
24712         - application/xml
24713       produces:
24714         - application/json
24715         - application/xml
24716       responses:
24717         "default":
24718           description: Response codes found in [response codes](https://wiki.onap.org/).
24719       parameters:
24720         - name: equipment-name
24721           in: path
24722           required: true
24723           type: string
24724           example: __EQUIPMENT-NAME__
24725         - name: interface-name
24726           in: path
24727           description: Name that identifies the physical interface
24728           required: true
24729           type: string
24730           example: __INTERFACE-NAME__
24731         - name: interface-name
24732           in: path
24733           description: Name given to the interface
24734           required: true
24735           type: string
24736           example: __INTERFACE-NAME__
24737         - name: l3-interface-ipv6-address
24738           in: path
24739           description: IP address
24740           required: true
24741           type: string
24742           example: __L3-INTERFACE-IPV6-ADDRESS__
24743         - name: body
24744           in: body
24745           description: l3-interface-ipv6-address-list object that needs to be updated.
24746           required: true
24747           schema:
24748             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
24749     delete:
24750       tags:
24751         - Network
24752       summary: delete an existing l3-interface-ipv6-address-list
24753       description: delete an existing l3-interface-ipv6-address-list
24754       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24755       consumes:
24756         - application/json
24757         - application/xml
24758       produces:
24759         - application/json
24760         - application/xml
24761       responses:
24762         "default":
24763           description: Response codes found in [response codes](https://wiki.onap.org/).
24764       parameters:
24765         - name: equipment-name
24766           in: path
24767           required: true
24768           type: string
24769           example: __EQUIPMENT-NAME__
24770         - name: interface-name
24771           in: path
24772           description: Name that identifies the physical interface
24773           required: true
24774           type: string
24775           example: __INTERFACE-NAME__
24776         - name: interface-name
24777           in: path
24778           description: Name given to the interface
24779           required: true
24780           type: string
24781           example: __INTERFACE-NAME__
24782         - name: l3-interface-ipv6-address
24783           in: path
24784           description: IP address
24785           required: true
24786           type: string
24787           example: __L3-INTERFACE-IPV6-ADDRESS__
24788         - name: resource-version
24789           in: query
24790           description: resource-version for concurrency
24791           required: true
24792           type: string
24793   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
24794     get:
24795       tags:
24796         - Network
24797       summary: returns l-interface
24798       description: returns l-interface
24799       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24800       produces:
24801         - application/json
24802         - application/xml
24803       responses:
24804         "200":
24805           description: successful operation
24806           schema:
24807               $ref: "#/getDefinitions/l-interface"
24808         "default":
24809           description: Response codes found in [response codes](https://wiki.onap.org/).
24810       parameters:
24811         - name: equipment-name
24812           in: path
24813           required: true
24814           type: string
24815           example: __EQUIPMENT-NAME__
24816         - name: interface-name
24817           in: path
24818           description: Name that identifies the physical interface
24819           required: true
24820           type: string
24821           example: __INTERFACE-NAME__
24822         - name: interface-name
24823           in: path
24824           description: Name given to the interface
24825           required: true
24826           type: string
24827           example: __INTERFACE-NAME__
24828     put:
24829       tags:
24830         - Network
24831       summary: create or update an existing l-interface
24832       description: |
24833         Create or update an existing l-interface.
24834         #
24835         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24836       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24837       consumes:
24838         - application/json
24839         - application/xml
24840       produces:
24841         - application/json
24842         - application/xml
24843       responses:
24844         "default":
24845           description: Response codes found in [response codes](https://wiki.onap.org/).
24846       parameters:
24847         - name: equipment-name
24848           in: path
24849           required: true
24850           type: string
24851           example: __EQUIPMENT-NAME__
24852         - name: interface-name
24853           in: path
24854           description: Name that identifies the physical interface
24855           required: true
24856           type: string
24857           example: __INTERFACE-NAME__
24858         - name: interface-name
24859           in: path
24860           description: Name given to the interface
24861           required: true
24862           type: string
24863           example: __INTERFACE-NAME__
24864         - name: body
24865           in: body
24866           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
24867           required: true
24868           schema:
24869             $ref: "#/definitions/l-interface"
24870     patch:
24871       tags:
24872         - Network
24873       summary: update an existing l-interface
24874       description: |
24875         Update an existing l-interface
24876         #
24877         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24878         The PUT operation will entirely replace an existing object.
24879         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24880         #
24881         Other differences between PUT and PATCH are:
24882         #
24883         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24884         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24885         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24886       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24887       consumes:
24888         - application/json
24889         - application/xml
24890       produces:
24891         - application/json
24892         - application/xml
24893       responses:
24894         "default":
24895           description: Response codes found in [response codes](https://wiki.onap.org/).
24896       parameters:
24897         - name: equipment-name
24898           in: path
24899           required: true
24900           type: string
24901           example: __EQUIPMENT-NAME__
24902         - name: interface-name
24903           in: path
24904           description: Name that identifies the physical interface
24905           required: true
24906           type: string
24907           example: __INTERFACE-NAME__
24908         - name: interface-name
24909           in: path
24910           description: Name given to the interface
24911           required: true
24912           type: string
24913           example: __INTERFACE-NAME__
24914         - name: body
24915           in: body
24916           description: l-interface object that needs to be updated.
24917           required: true
24918           schema:
24919             $ref: "#/patchDefinitions/l-interface"
24920     delete:
24921       tags:
24922         - Network
24923       summary: delete an existing l-interface
24924       description: delete an existing l-interface
24925       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24926       consumes:
24927         - application/json
24928         - application/xml
24929       produces:
24930         - application/json
24931         - application/xml
24932       responses:
24933         "default":
24934           description: Response codes found in [response codes](https://wiki.onap.org/).
24935       parameters:
24936         - name: equipment-name
24937           in: path
24938           required: true
24939           type: string
24940           example: __EQUIPMENT-NAME__
24941         - name: interface-name
24942           in: path
24943           description: Name that identifies the physical interface
24944           required: true
24945           type: string
24946           example: __INTERFACE-NAME__
24947         - name: interface-name
24948           in: path
24949           description: Name given to the interface
24950           required: true
24951           type: string
24952           example: __INTERFACE-NAME__
24953         - name: resource-version
24954           in: query
24955           description: resource-version for concurrency
24956           required: true
24957           type: string
24958   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
24959     get:
24960       tags:
24961         - Network
24962       summary: returns l-interfaces
24963       description: returns l-interfaces
24964       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
24965       produces:
24966         - application/json
24967         - application/xml
24968       responses:
24969         "200":
24970           description: successful operation
24971           schema:
24972               $ref: "#/getDefinitions/l-interfaces"
24973         "default":
24974           description: Response codes found in [response codes](https://wiki.onap.org/).
24975       parameters:
24976         - name: equipment-name
24977           in: path
24978           required: true
24979           type: string
24980           example: __EQUIPMENT-NAME__
24981         - name: interface-name
24982           in: path
24983           description: Name that identifies the physical interface
24984           required: true
24985           type: string
24986           example: __INTERFACE-NAME__
24987         - name: interface-name
24988           in: query
24989           description:
24990           required: false
24991           type: string
24992         - name: interface-id
24993           in: query
24994           description:
24995           required: false
24996           type: string
24997         - name: macaddr
24998           in: query
24999           description:
25000           required: false
25001           type: string
25002         - name: network-name
25003           in: query
25004           description:
25005           required: false
25006           type: string
25007   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
25008     get:
25009       tags:
25010         - Network
25011       summary: returns p-interface
25012       description: returns p-interface
25013       operationId: getNetworkVplsPesVplsPePInterfacesPInterface
25014       produces:
25015         - application/json
25016         - application/xml
25017       responses:
25018         "200":
25019           description: successful operation
25020           schema:
25021               $ref: "#/getDefinitions/p-interface"
25022         "default":
25023           description: Response codes found in [response codes](https://wiki.onap.org/).
25024       parameters:
25025         - name: equipment-name
25026           in: path
25027           required: true
25028           type: string
25029           example: __EQUIPMENT-NAME__
25030         - name: interface-name
25031           in: path
25032           description: Name that identifies the physical interface
25033           required: true
25034           type: string
25035           example: __INTERFACE-NAME__
25036     put:
25037       tags:
25038         - Network
25039       summary: create or update an existing p-interface
25040       description: |
25041         Create or update an existing p-interface.
25042         #
25043         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25044       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
25045       consumes:
25046         - application/json
25047         - application/xml
25048       produces:
25049         - application/json
25050         - application/xml
25051       responses:
25052         "default":
25053           description: Response codes found in [response codes](https://wiki.onap.org/).
25054       parameters:
25055         - name: equipment-name
25056           in: path
25057           required: true
25058           type: string
25059           example: __EQUIPMENT-NAME__
25060         - name: interface-name
25061           in: path
25062           description: Name that identifies the physical interface
25063           required: true
25064           type: string
25065           example: __INTERFACE-NAME__
25066         - name: body
25067           in: body
25068           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json)
25069           required: true
25070           schema:
25071             $ref: "#/definitions/p-interface"
25072     patch:
25073       tags:
25074         - Network
25075       summary: update an existing p-interface
25076       description: |
25077         Update an existing p-interface
25078         #
25079         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25080         The PUT operation will entirely replace an existing object.
25081         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25082         #
25083         Other differences between PUT and PATCH are:
25084         #
25085         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25086         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25087         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25088       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
25089       consumes:
25090         - application/json
25091         - application/xml
25092       produces:
25093         - application/json
25094         - application/xml
25095       responses:
25096         "default":
25097           description: Response codes found in [response codes](https://wiki.onap.org/).
25098       parameters:
25099         - name: equipment-name
25100           in: path
25101           required: true
25102           type: string
25103           example: __EQUIPMENT-NAME__
25104         - name: interface-name
25105           in: path
25106           description: Name that identifies the physical interface
25107           required: true
25108           type: string
25109           example: __INTERFACE-NAME__
25110         - name: body
25111           in: body
25112           description: p-interface object that needs to be updated.
25113           required: true
25114           schema:
25115             $ref: "#/patchDefinitions/p-interface"
25116     delete:
25117       tags:
25118         - Network
25119       summary: delete an existing p-interface
25120       description: delete an existing p-interface
25121       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
25122       consumes:
25123         - application/json
25124         - application/xml
25125       produces:
25126         - application/json
25127         - application/xml
25128       responses:
25129         "default":
25130           description: Response codes found in [response codes](https://wiki.onap.org/).
25131       parameters:
25132         - name: equipment-name
25133           in: path
25134           required: true
25135           type: string
25136           example: __EQUIPMENT-NAME__
25137         - name: interface-name
25138           in: path
25139           description: Name that identifies the physical interface
25140           required: true
25141           type: string
25142           example: __INTERFACE-NAME__
25143         - name: resource-version
25144           in: query
25145           description: resource-version for concurrency
25146           required: true
25147           type: string
25148   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
25149     get:
25150       tags:
25151         - Network
25152       summary: returns p-interfaces
25153       description: returns p-interfaces
25154       operationId: getNetworkVplsPesVplsPePInterfaces
25155       produces:
25156         - application/json
25157         - application/xml
25158       responses:
25159         "200":
25160           description: successful operation
25161           schema:
25162               $ref: "#/getDefinitions/p-interfaces"
25163         "default":
25164           description: Response codes found in [response codes](https://wiki.onap.org/).
25165       parameters:
25166         - name: equipment-name
25167           in: path
25168           required: true
25169           type: string
25170           example: __EQUIPMENT-NAME__
25171         - name: interface-name
25172           in: query
25173           description:
25174           required: false
25175           type: string
25176         - name: prov-status
25177           in: query
25178           description:
25179           required: false
25180           type: string
25181   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
25182     put:
25183       tags:
25184         - Network
25185       summary: see node definition for valid relationships
25186       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
25187       consumes:
25188         - application/json
25189         - application/xml
25190       produces:
25191         - application/json
25192         - application/xml
25193       responses:
25194         "default":
25195           description: Response codes found in [response codes](https://wiki.onap.org/).
25196       parameters:
25197         - name: equipment-name
25198           in: path
25199           required: true
25200           type: string
25201           example: __EQUIPMENT-NAME__
25202         - name: interface-name
25203           in: path
25204           description: Name that identifies the link aggregate interface
25205           required: true
25206           type: string
25207           example: __INTERFACE-NAME__
25208         - name: body
25209           in: body
25210           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
25211           required: true
25212           schema:
25213             $ref: "#/definitions/relationship"
25214     delete:
25215       tags:
25216         - Network
25217       summary: delete an existing relationship
25218       description: delete an existing relationship
25219       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
25220       consumes:
25221         - application/json
25222         - application/xml
25223       produces:
25224         - application/json
25225         - application/xml
25226       responses:
25227         "default":
25228           description: Response codes found in [response codes](https://wiki.onap.org/).
25229       parameters:
25230         - name: equipment-name
25231           in: path
25232           required: true
25233           type: string
25234           example: __EQUIPMENT-NAME__
25235         - name: interface-name
25236           in: path
25237           description: Name that identifies the link aggregate interface
25238           required: true
25239           type: string
25240           example: __INTERFACE-NAME__
25241   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
25242     put:
25243       tags:
25244         - Network
25245       summary: see node definition for valid relationships
25246       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25247       consumes:
25248         - application/json
25249         - application/xml
25250       produces:
25251         - application/json
25252         - application/xml
25253       responses:
25254         "default":
25255           description: Response codes found in [response codes](https://wiki.onap.org/).
25256       parameters:
25257         - name: equipment-name
25258           in: path
25259           required: true
25260           type: string
25261           example: __EQUIPMENT-NAME__
25262         - name: interface-name
25263           in: path
25264           description: Name that identifies the link aggregate interface
25265           required: true
25266           type: string
25267           example: __INTERFACE-NAME__
25268         - name: interface-name
25269           in: path
25270           description: Name given to the interface
25271           required: true
25272           type: string
25273           example: __INTERFACE-NAME__
25274         - name: vlan-interface
25275           in: path
25276           description: String that identifies the interface
25277           required: true
25278           type: string
25279           example: __VLAN-INTERFACE__
25280         - name: body
25281           in: body
25282           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
25283           required: true
25284           schema:
25285             $ref: "#/definitions/relationship"
25286     delete:
25287       tags:
25288         - Network
25289       summary: delete an existing relationship
25290       description: delete an existing relationship
25291       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25292       consumes:
25293         - application/json
25294         - application/xml
25295       produces:
25296         - application/json
25297         - application/xml
25298       responses:
25299         "default":
25300           description: Response codes found in [response codes](https://wiki.onap.org/).
25301       parameters:
25302         - name: equipment-name
25303           in: path
25304           required: true
25305           type: string
25306           example: __EQUIPMENT-NAME__
25307         - name: interface-name
25308           in: path
25309           description: Name that identifies the link aggregate interface
25310           required: true
25311           type: string
25312           example: __INTERFACE-NAME__
25313         - name: interface-name
25314           in: path
25315           description: Name given to the interface
25316           required: true
25317           type: string
25318           example: __INTERFACE-NAME__
25319         - name: vlan-interface
25320           in: path
25321           description: String that identifies the interface
25322           required: true
25323           type: string
25324           example: __VLAN-INTERFACE__
25325   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
25326     put:
25327       tags:
25328         - Network
25329       summary: see node definition for valid relationships
25330       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25331       consumes:
25332         - application/json
25333         - application/xml
25334       produces:
25335         - application/json
25336         - application/xml
25337       responses:
25338         "default":
25339           description: Response codes found in [response codes](https://wiki.onap.org/).
25340       parameters:
25341         - name: equipment-name
25342           in: path
25343           required: true
25344           type: string
25345           example: __EQUIPMENT-NAME__
25346         - name: interface-name
25347           in: path
25348           description: Name that identifies the link aggregate interface
25349           required: true
25350           type: string
25351           example: __INTERFACE-NAME__
25352         - name: interface-name
25353           in: path
25354           description: Name given to the interface
25355           required: true
25356           type: string
25357           example: __INTERFACE-NAME__
25358         - name: vlan-interface
25359           in: path
25360           description: String that identifies the interface
25361           required: true
25362           type: string
25363           example: __VLAN-INTERFACE__
25364         - name: l3-interface-ipv4-address
25365           in: path
25366           description: IP address
25367           required: true
25368           type: string
25369           example: __L3-INTERFACE-IPV4-ADDRESS__
25370         - name: body
25371           in: body
25372           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25373           required: true
25374           schema:
25375             $ref: "#/definitions/relationship"
25376     delete:
25377       tags:
25378         - Network
25379       summary: delete an existing relationship
25380       description: delete an existing relationship
25381       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25382       consumes:
25383         - application/json
25384         - application/xml
25385       produces:
25386         - application/json
25387         - application/xml
25388       responses:
25389         "default":
25390           description: Response codes found in [response codes](https://wiki.onap.org/).
25391       parameters:
25392         - name: equipment-name
25393           in: path
25394           required: true
25395           type: string
25396           example: __EQUIPMENT-NAME__
25397         - name: interface-name
25398           in: path
25399           description: Name that identifies the link aggregate interface
25400           required: true
25401           type: string
25402           example: __INTERFACE-NAME__
25403         - name: interface-name
25404           in: path
25405           description: Name given to the interface
25406           required: true
25407           type: string
25408           example: __INTERFACE-NAME__
25409         - name: vlan-interface
25410           in: path
25411           description: String that identifies the interface
25412           required: true
25413           type: string
25414           example: __VLAN-INTERFACE__
25415         - name: l3-interface-ipv4-address
25416           in: path
25417           description: IP address
25418           required: true
25419           type: string
25420           example: __L3-INTERFACE-IPV4-ADDRESS__
25421   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
25422     get:
25423       tags:
25424         - Network
25425       summary: returns l3-interface-ipv4-address-list
25426       description: returns l3-interface-ipv4-address-list
25427       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25428       produces:
25429         - application/json
25430         - application/xml
25431       responses:
25432         "200":
25433           description: successful operation
25434           schema:
25435               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
25436         "default":
25437           description: Response codes found in [response codes](https://wiki.onap.org/).
25438       parameters:
25439         - name: equipment-name
25440           in: path
25441           required: true
25442           type: string
25443           example: __EQUIPMENT-NAME__
25444         - name: interface-name
25445           in: path
25446           description: Name that identifies the link aggregate interface
25447           required: true
25448           type: string
25449           example: __INTERFACE-NAME__
25450         - name: interface-name
25451           in: path
25452           description: Name given to the interface
25453           required: true
25454           type: string
25455           example: __INTERFACE-NAME__
25456         - name: vlan-interface
25457           in: path
25458           description: String that identifies the interface
25459           required: true
25460           type: string
25461           example: __VLAN-INTERFACE__
25462         - name: l3-interface-ipv4-address
25463           in: path
25464           description: IP address
25465           required: true
25466           type: string
25467           example: __L3-INTERFACE-IPV4-ADDRESS__
25468     put:
25469       tags:
25470         - Network
25471       summary: create or update an existing l3-interface-ipv4-address-list
25472       description: |
25473         Create or update an existing l3-interface-ipv4-address-list.
25474         #
25475         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25476       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25477       consumes:
25478         - application/json
25479         - application/xml
25480       produces:
25481         - application/json
25482         - application/xml
25483       responses:
25484         "default":
25485           description: Response codes found in [response codes](https://wiki.onap.org/).
25486       parameters:
25487         - name: equipment-name
25488           in: path
25489           required: true
25490           type: string
25491           example: __EQUIPMENT-NAME__
25492         - name: interface-name
25493           in: path
25494           description: Name that identifies the link aggregate interface
25495           required: true
25496           type: string
25497           example: __INTERFACE-NAME__
25498         - name: interface-name
25499           in: path
25500           description: Name given to the interface
25501           required: true
25502           type: string
25503           example: __INTERFACE-NAME__
25504         - name: vlan-interface
25505           in: path
25506           description: String that identifies the interface
25507           required: true
25508           type: string
25509           example: __VLAN-INTERFACE__
25510         - name: l3-interface-ipv4-address
25511           in: path
25512           description: IP address
25513           required: true
25514           type: string
25515           example: __L3-INTERFACE-IPV4-ADDRESS__
25516         - name: body
25517           in: body
25518           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25519           required: true
25520           schema:
25521             $ref: "#/definitions/l3-interface-ipv4-address-list"
25522     patch:
25523       tags:
25524         - Network
25525       summary: update an existing l3-interface-ipv4-address-list
25526       description: |
25527         Update an existing l3-interface-ipv4-address-list
25528         #
25529         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25530         The PUT operation will entirely replace an existing object.
25531         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25532         #
25533         Other differences between PUT and PATCH are:
25534         #
25535         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25536         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25537         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25538       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25539       consumes:
25540         - application/json
25541         - application/xml
25542       produces:
25543         - application/json
25544         - application/xml
25545       responses:
25546         "default":
25547           description: Response codes found in [response codes](https://wiki.onap.org/).
25548       parameters:
25549         - name: equipment-name
25550           in: path
25551           required: true
25552           type: string
25553           example: __EQUIPMENT-NAME__
25554         - name: interface-name
25555           in: path
25556           description: Name that identifies the link aggregate interface
25557           required: true
25558           type: string
25559           example: __INTERFACE-NAME__
25560         - name: interface-name
25561           in: path
25562           description: Name given to the interface
25563           required: true
25564           type: string
25565           example: __INTERFACE-NAME__
25566         - name: vlan-interface
25567           in: path
25568           description: String that identifies the interface
25569           required: true
25570           type: string
25571           example: __VLAN-INTERFACE__
25572         - name: l3-interface-ipv4-address
25573           in: path
25574           description: IP address
25575           required: true
25576           type: string
25577           example: __L3-INTERFACE-IPV4-ADDRESS__
25578         - name: body
25579           in: body
25580           description: l3-interface-ipv4-address-list object that needs to be updated.
25581           required: true
25582           schema:
25583             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
25584     delete:
25585       tags:
25586         - Network
25587       summary: delete an existing l3-interface-ipv4-address-list
25588       description: delete an existing l3-interface-ipv4-address-list
25589       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25590       consumes:
25591         - application/json
25592         - application/xml
25593       produces:
25594         - application/json
25595         - application/xml
25596       responses:
25597         "default":
25598           description: Response codes found in [response codes](https://wiki.onap.org/).
25599       parameters:
25600         - name: equipment-name
25601           in: path
25602           required: true
25603           type: string
25604           example: __EQUIPMENT-NAME__
25605         - name: interface-name
25606           in: path
25607           description: Name that identifies the link aggregate interface
25608           required: true
25609           type: string
25610           example: __INTERFACE-NAME__
25611         - name: interface-name
25612           in: path
25613           description: Name given to the interface
25614           required: true
25615           type: string
25616           example: __INTERFACE-NAME__
25617         - name: vlan-interface
25618           in: path
25619           description: String that identifies the interface
25620           required: true
25621           type: string
25622           example: __VLAN-INTERFACE__
25623         - name: l3-interface-ipv4-address
25624           in: path
25625           description: IP address
25626           required: true
25627           type: string
25628           example: __L3-INTERFACE-IPV4-ADDRESS__
25629         - name: resource-version
25630           in: query
25631           description: resource-version for concurrency
25632           required: true
25633           type: string
25634   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
25635     put:
25636       tags:
25637         - Network
25638       summary: see node definition for valid relationships
25639       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25640       consumes:
25641         - application/json
25642         - application/xml
25643       produces:
25644         - application/json
25645         - application/xml
25646       responses:
25647         "default":
25648           description: Response codes found in [response codes](https://wiki.onap.org/).
25649       parameters:
25650         - name: equipment-name
25651           in: path
25652           required: true
25653           type: string
25654           example: __EQUIPMENT-NAME__
25655         - name: interface-name
25656           in: path
25657           description: Name that identifies the link aggregate interface
25658           required: true
25659           type: string
25660           example: __INTERFACE-NAME__
25661         - name: interface-name
25662           in: path
25663           description: Name given to the interface
25664           required: true
25665           type: string
25666           example: __INTERFACE-NAME__
25667         - name: vlan-interface
25668           in: path
25669           description: String that identifies the interface
25670           required: true
25671           type: string
25672           example: __VLAN-INTERFACE__
25673         - name: l3-interface-ipv6-address
25674           in: path
25675           description: IP address
25676           required: true
25677           type: string
25678           example: __L3-INTERFACE-IPV6-ADDRESS__
25679         - name: body
25680           in: body
25681           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25682           required: true
25683           schema:
25684             $ref: "#/definitions/relationship"
25685     delete:
25686       tags:
25687         - Network
25688       summary: delete an existing relationship
25689       description: delete an existing relationship
25690       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25691       consumes:
25692         - application/json
25693         - application/xml
25694       produces:
25695         - application/json
25696         - application/xml
25697       responses:
25698         "default":
25699           description: Response codes found in [response codes](https://wiki.onap.org/).
25700       parameters:
25701         - name: equipment-name
25702           in: path
25703           required: true
25704           type: string
25705           example: __EQUIPMENT-NAME__
25706         - name: interface-name
25707           in: path
25708           description: Name that identifies the link aggregate interface
25709           required: true
25710           type: string
25711           example: __INTERFACE-NAME__
25712         - name: interface-name
25713           in: path
25714           description: Name given to the interface
25715           required: true
25716           type: string
25717           example: __INTERFACE-NAME__
25718         - name: vlan-interface
25719           in: path
25720           description: String that identifies the interface
25721           required: true
25722           type: string
25723           example: __VLAN-INTERFACE__
25724         - name: l3-interface-ipv6-address
25725           in: path
25726           description: IP address
25727           required: true
25728           type: string
25729           example: __L3-INTERFACE-IPV6-ADDRESS__
25730   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
25731     get:
25732       tags:
25733         - Network
25734       summary: returns l3-interface-ipv6-address-list
25735       description: returns l3-interface-ipv6-address-list
25736       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25737       produces:
25738         - application/json
25739         - application/xml
25740       responses:
25741         "200":
25742           description: successful operation
25743           schema:
25744               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
25745         "default":
25746           description: Response codes found in [response codes](https://wiki.onap.org/).
25747       parameters:
25748         - name: equipment-name
25749           in: path
25750           required: true
25751           type: string
25752           example: __EQUIPMENT-NAME__
25753         - name: interface-name
25754           in: path
25755           description: Name that identifies the link aggregate interface
25756           required: true
25757           type: string
25758           example: __INTERFACE-NAME__
25759         - name: interface-name
25760           in: path
25761           description: Name given to the interface
25762           required: true
25763           type: string
25764           example: __INTERFACE-NAME__
25765         - name: vlan-interface
25766           in: path
25767           description: String that identifies the interface
25768           required: true
25769           type: string
25770           example: __VLAN-INTERFACE__
25771         - name: l3-interface-ipv6-address
25772           in: path
25773           description: IP address
25774           required: true
25775           type: string
25776           example: __L3-INTERFACE-IPV6-ADDRESS__
25777     put:
25778       tags:
25779         - Network
25780       summary: create or update an existing l3-interface-ipv6-address-list
25781       description: |
25782         Create or update an existing l3-interface-ipv6-address-list.
25783         #
25784         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25785       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25786       consumes:
25787         - application/json
25788         - application/xml
25789       produces:
25790         - application/json
25791         - application/xml
25792       responses:
25793         "default":
25794           description: Response codes found in [response codes](https://wiki.onap.org/).
25795       parameters:
25796         - name: equipment-name
25797           in: path
25798           required: true
25799           type: string
25800           example: __EQUIPMENT-NAME__
25801         - name: interface-name
25802           in: path
25803           description: Name that identifies the link aggregate interface
25804           required: true
25805           type: string
25806           example: __INTERFACE-NAME__
25807         - name: interface-name
25808           in: path
25809           description: Name given to the interface
25810           required: true
25811           type: string
25812           example: __INTERFACE-NAME__
25813         - name: vlan-interface
25814           in: path
25815           description: String that identifies the interface
25816           required: true
25817           type: string
25818           example: __VLAN-INTERFACE__
25819         - name: l3-interface-ipv6-address
25820           in: path
25821           description: IP address
25822           required: true
25823           type: string
25824           example: __L3-INTERFACE-IPV6-ADDRESS__
25825         - name: body
25826           in: body
25827           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25828           required: true
25829           schema:
25830             $ref: "#/definitions/l3-interface-ipv6-address-list"
25831     patch:
25832       tags:
25833         - Network
25834       summary: update an existing l3-interface-ipv6-address-list
25835       description: |
25836         Update an existing l3-interface-ipv6-address-list
25837         #
25838         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25839         The PUT operation will entirely replace an existing object.
25840         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25841         #
25842         Other differences between PUT and PATCH are:
25843         #
25844         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25845         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25846         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25847       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25848       consumes:
25849         - application/json
25850         - application/xml
25851       produces:
25852         - application/json
25853         - application/xml
25854       responses:
25855         "default":
25856           description: Response codes found in [response codes](https://wiki.onap.org/).
25857       parameters:
25858         - name: equipment-name
25859           in: path
25860           required: true
25861           type: string
25862           example: __EQUIPMENT-NAME__
25863         - name: interface-name
25864           in: path
25865           description: Name that identifies the link aggregate interface
25866           required: true
25867           type: string
25868           example: __INTERFACE-NAME__
25869         - name: interface-name
25870           in: path
25871           description: Name given to the interface
25872           required: true
25873           type: string
25874           example: __INTERFACE-NAME__
25875         - name: vlan-interface
25876           in: path
25877           description: String that identifies the interface
25878           required: true
25879           type: string
25880           example: __VLAN-INTERFACE__
25881         - name: l3-interface-ipv6-address
25882           in: path
25883           description: IP address
25884           required: true
25885           type: string
25886           example: __L3-INTERFACE-IPV6-ADDRESS__
25887         - name: body
25888           in: body
25889           description: l3-interface-ipv6-address-list object that needs to be updated.
25890           required: true
25891           schema:
25892             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
25893     delete:
25894       tags:
25895         - Network
25896       summary: delete an existing l3-interface-ipv6-address-list
25897       description: delete an existing l3-interface-ipv6-address-list
25898       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25899       consumes:
25900         - application/json
25901         - application/xml
25902       produces:
25903         - application/json
25904         - application/xml
25905       responses:
25906         "default":
25907           description: Response codes found in [response codes](https://wiki.onap.org/).
25908       parameters:
25909         - name: equipment-name
25910           in: path
25911           required: true
25912           type: string
25913           example: __EQUIPMENT-NAME__
25914         - name: interface-name
25915           in: path
25916           description: Name that identifies the link aggregate interface
25917           required: true
25918           type: string
25919           example: __INTERFACE-NAME__
25920         - name: interface-name
25921           in: path
25922           description: Name given to the interface
25923           required: true
25924           type: string
25925           example: __INTERFACE-NAME__
25926         - name: vlan-interface
25927           in: path
25928           description: String that identifies the interface
25929           required: true
25930           type: string
25931           example: __VLAN-INTERFACE__
25932         - name: l3-interface-ipv6-address
25933           in: path
25934           description: IP address
25935           required: true
25936           type: string
25937           example: __L3-INTERFACE-IPV6-ADDRESS__
25938         - name: resource-version
25939           in: query
25940           description: resource-version for concurrency
25941           required: true
25942           type: string
25943   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
25944     get:
25945       tags:
25946         - Network
25947       summary: returns vlan
25948       description: returns vlan
25949       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25950       produces:
25951         - application/json
25952         - application/xml
25953       responses:
25954         "200":
25955           description: successful operation
25956           schema:
25957               $ref: "#/getDefinitions/vlan"
25958         "default":
25959           description: Response codes found in [response codes](https://wiki.onap.org/).
25960       parameters:
25961         - name: equipment-name
25962           in: path
25963           required: true
25964           type: string
25965           example: __EQUIPMENT-NAME__
25966         - name: interface-name
25967           in: path
25968           description: Name that identifies the link aggregate interface
25969           required: true
25970           type: string
25971           example: __INTERFACE-NAME__
25972         - name: interface-name
25973           in: path
25974           description: Name given to the interface
25975           required: true
25976           type: string
25977           example: __INTERFACE-NAME__
25978         - name: vlan-interface
25979           in: path
25980           description: String that identifies the interface
25981           required: true
25982           type: string
25983           example: __VLAN-INTERFACE__
25984     put:
25985       tags:
25986         - Network
25987       summary: create or update an existing vlan
25988       description: |
25989         Create or update an existing vlan.
25990         #
25991         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25992       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25993       consumes:
25994         - application/json
25995         - application/xml
25996       produces:
25997         - application/json
25998         - application/xml
25999       responses:
26000         "default":
26001           description: Response codes found in [response codes](https://wiki.onap.org/).
26002       parameters:
26003         - name: equipment-name
26004           in: path
26005           required: true
26006           type: string
26007           example: __EQUIPMENT-NAME__
26008         - name: interface-name
26009           in: path
26010           description: Name that identifies the link aggregate interface
26011           required: true
26012           type: string
26013           example: __INTERFACE-NAME__
26014         - name: interface-name
26015           in: path
26016           description: Name given to the interface
26017           required: true
26018           type: string
26019           example: __INTERFACE-NAME__
26020         - name: vlan-interface
26021           in: path
26022           description: String that identifies the interface
26023           required: true
26024           type: string
26025           example: __VLAN-INTERFACE__
26026         - name: body
26027           in: body
26028           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
26029           required: true
26030           schema:
26031             $ref: "#/definitions/vlan"
26032     patch:
26033       tags:
26034         - Network
26035       summary: update an existing vlan
26036       description: |
26037         Update an existing vlan
26038         #
26039         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26040         The PUT operation will entirely replace an existing object.
26041         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26042         #
26043         Other differences between PUT and PATCH are:
26044         #
26045         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26046         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26047         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26048       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
26049       consumes:
26050         - application/json
26051         - application/xml
26052       produces:
26053         - application/json
26054         - application/xml
26055       responses:
26056         "default":
26057           description: Response codes found in [response codes](https://wiki.onap.org/).
26058       parameters:
26059         - name: equipment-name
26060           in: path
26061           required: true
26062           type: string
26063           example: __EQUIPMENT-NAME__
26064         - name: interface-name
26065           in: path
26066           description: Name that identifies the link aggregate interface
26067           required: true
26068           type: string
26069           example: __INTERFACE-NAME__
26070         - name: interface-name
26071           in: path
26072           description: Name given to the interface
26073           required: true
26074           type: string
26075           example: __INTERFACE-NAME__
26076         - name: vlan-interface
26077           in: path
26078           description: String that identifies the interface
26079           required: true
26080           type: string
26081           example: __VLAN-INTERFACE__
26082         - name: body
26083           in: body
26084           description: vlan object that needs to be updated.
26085           required: true
26086           schema:
26087             $ref: "#/patchDefinitions/vlan"
26088     delete:
26089       tags:
26090         - Network
26091       summary: delete an existing vlan
26092       description: delete an existing vlan
26093       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
26094       consumes:
26095         - application/json
26096         - application/xml
26097       produces:
26098         - application/json
26099         - application/xml
26100       responses:
26101         "default":
26102           description: Response codes found in [response codes](https://wiki.onap.org/).
26103       parameters:
26104         - name: equipment-name
26105           in: path
26106           required: true
26107           type: string
26108           example: __EQUIPMENT-NAME__
26109         - name: interface-name
26110           in: path
26111           description: Name that identifies the link aggregate interface
26112           required: true
26113           type: string
26114           example: __INTERFACE-NAME__
26115         - name: interface-name
26116           in: path
26117           description: Name given to the interface
26118           required: true
26119           type: string
26120           example: __INTERFACE-NAME__
26121         - name: vlan-interface
26122           in: path
26123           description: String that identifies the interface
26124           required: true
26125           type: string
26126           example: __VLAN-INTERFACE__
26127         - name: resource-version
26128           in: query
26129           description: resource-version for concurrency
26130           required: true
26131           type: string
26132   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
26133     get:
26134       tags:
26135         - Network
26136       summary: returns vlans
26137       description: returns vlans
26138       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
26139       produces:
26140         - application/json
26141         - application/xml
26142       responses:
26143         "200":
26144           description: successful operation
26145           schema:
26146               $ref: "#/getDefinitions/vlans"
26147         "default":
26148           description: Response codes found in [response codes](https://wiki.onap.org/).
26149       parameters:
26150         - name: equipment-name
26151           in: path
26152           required: true
26153           type: string
26154           example: __EQUIPMENT-NAME__
26155         - name: interface-name
26156           in: path
26157           description: Name that identifies the link aggregate interface
26158           required: true
26159           type: string
26160           example: __INTERFACE-NAME__
26161         - name: interface-name
26162           in: path
26163           description: Name given to the interface
26164           required: true
26165           type: string
26166           example: __INTERFACE-NAME__
26167         - name: vlan-interface
26168           in: query
26169           description:
26170           required: false
26171           type: string
26172         - name: vlan-id-inner
26173           in: query
26174           description:
26175           required: false
26176           type: integer
26177           format: int64
26178         - name: vpn-key
26179           in: query
26180           description:
26181           required: false
26182           type: string
26183   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
26184     put:
26185       tags:
26186         - Network
26187       summary: see node definition for valid relationships
26188       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26189       consumes:
26190         - application/json
26191         - application/xml
26192       produces:
26193         - application/json
26194         - application/xml
26195       responses:
26196         "default":
26197           description: Response codes found in [response codes](https://wiki.onap.org/).
26198       parameters:
26199         - name: equipment-name
26200           in: path
26201           required: true
26202           type: string
26203           example: __EQUIPMENT-NAME__
26204         - name: interface-name
26205           in: path
26206           description: Name that identifies the link aggregate interface
26207           required: true
26208           type: string
26209           example: __INTERFACE-NAME__
26210         - name: interface-name
26211           in: path
26212           description: Name given to the interface
26213           required: true
26214           type: string
26215           example: __INTERFACE-NAME__
26216         - name: pci-id
26217           in: path
26218           description: PCI ID used to identify the sriov-vf
26219           required: true
26220           type: string
26221           example: __PCI-ID__
26222         - name: body
26223           in: body
26224           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
26225           required: true
26226           schema:
26227             $ref: "#/definitions/relationship"
26228     delete:
26229       tags:
26230         - Network
26231       summary: delete an existing relationship
26232       description: delete an existing relationship
26233       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26234       consumes:
26235         - application/json
26236         - application/xml
26237       produces:
26238         - application/json
26239         - application/xml
26240       responses:
26241         "default":
26242           description: Response codes found in [response codes](https://wiki.onap.org/).
26243       parameters:
26244         - name: equipment-name
26245           in: path
26246           required: true
26247           type: string
26248           example: __EQUIPMENT-NAME__
26249         - name: interface-name
26250           in: path
26251           description: Name that identifies the link aggregate interface
26252           required: true
26253           type: string
26254           example: __INTERFACE-NAME__
26255         - name: interface-name
26256           in: path
26257           description: Name given to the interface
26258           required: true
26259           type: string
26260           example: __INTERFACE-NAME__
26261         - name: pci-id
26262           in: path
26263           description: PCI ID used to identify the sriov-vf
26264           required: true
26265           type: string
26266           example: __PCI-ID__
26267   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
26268     get:
26269       tags:
26270         - Network
26271       summary: returns sriov-vf
26272       description: returns sriov-vf
26273       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26274       produces:
26275         - application/json
26276         - application/xml
26277       responses:
26278         "200":
26279           description: successful operation
26280           schema:
26281               $ref: "#/getDefinitions/sriov-vf"
26282         "default":
26283           description: Response codes found in [response codes](https://wiki.onap.org/).
26284       parameters:
26285         - name: equipment-name
26286           in: path
26287           required: true
26288           type: string
26289           example: __EQUIPMENT-NAME__
26290         - name: interface-name
26291           in: path
26292           description: Name that identifies the link aggregate interface
26293           required: true
26294           type: string
26295           example: __INTERFACE-NAME__
26296         - name: interface-name
26297           in: path
26298           description: Name given to the interface
26299           required: true
26300           type: string
26301           example: __INTERFACE-NAME__
26302         - name: pci-id
26303           in: path
26304           description: PCI ID used to identify the sriov-vf
26305           required: true
26306           type: string
26307           example: __PCI-ID__
26308     put:
26309       tags:
26310         - Network
26311       summary: create or update an existing sriov-vf
26312       description: |
26313         Create or update an existing sriov-vf.
26314         #
26315         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26316       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26317       consumes:
26318         - application/json
26319         - application/xml
26320       produces:
26321         - application/json
26322         - application/xml
26323       responses:
26324         "default":
26325           description: Response codes found in [response codes](https://wiki.onap.org/).
26326       parameters:
26327         - name: equipment-name
26328           in: path
26329           required: true
26330           type: string
26331           example: __EQUIPMENT-NAME__
26332         - name: interface-name
26333           in: path
26334           description: Name that identifies the link aggregate interface
26335           required: true
26336           type: string
26337           example: __INTERFACE-NAME__
26338         - name: interface-name
26339           in: path
26340           description: Name given to the interface
26341           required: true
26342           type: string
26343           example: __INTERFACE-NAME__
26344         - name: pci-id
26345           in: path
26346           description: PCI ID used to identify the sriov-vf
26347           required: true
26348           type: string
26349           example: __PCI-ID__
26350         - name: body
26351           in: body
26352           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
26353           required: true
26354           schema:
26355             $ref: "#/definitions/sriov-vf"
26356     patch:
26357       tags:
26358         - Network
26359       summary: update an existing sriov-vf
26360       description: |
26361         Update an existing sriov-vf
26362         #
26363         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26364         The PUT operation will entirely replace an existing object.
26365         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26366         #
26367         Other differences between PUT and PATCH are:
26368         #
26369         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26370         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26371         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26372       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26373       consumes:
26374         - application/json
26375         - application/xml
26376       produces:
26377         - application/json
26378         - application/xml
26379       responses:
26380         "default":
26381           description: Response codes found in [response codes](https://wiki.onap.org/).
26382       parameters:
26383         - name: equipment-name
26384           in: path
26385           required: true
26386           type: string
26387           example: __EQUIPMENT-NAME__
26388         - name: interface-name
26389           in: path
26390           description: Name that identifies the link aggregate interface
26391           required: true
26392           type: string
26393           example: __INTERFACE-NAME__
26394         - name: interface-name
26395           in: path
26396           description: Name given to the interface
26397           required: true
26398           type: string
26399           example: __INTERFACE-NAME__
26400         - name: pci-id
26401           in: path
26402           description: PCI ID used to identify the sriov-vf
26403           required: true
26404           type: string
26405           example: __PCI-ID__
26406         - name: body
26407           in: body
26408           description: sriov-vf object that needs to be updated.
26409           required: true
26410           schema:
26411             $ref: "#/patchDefinitions/sriov-vf"
26412     delete:
26413       tags:
26414         - Network
26415       summary: delete an existing sriov-vf
26416       description: delete an existing sriov-vf
26417       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26418       consumes:
26419         - application/json
26420         - application/xml
26421       produces:
26422         - application/json
26423         - application/xml
26424       responses:
26425         "default":
26426           description: Response codes found in [response codes](https://wiki.onap.org/).
26427       parameters:
26428         - name: equipment-name
26429           in: path
26430           required: true
26431           type: string
26432           example: __EQUIPMENT-NAME__
26433         - name: interface-name
26434           in: path
26435           description: Name that identifies the link aggregate interface
26436           required: true
26437           type: string
26438           example: __INTERFACE-NAME__
26439         - name: interface-name
26440           in: path
26441           description: Name given to the interface
26442           required: true
26443           type: string
26444           example: __INTERFACE-NAME__
26445         - name: pci-id
26446           in: path
26447           description: PCI ID used to identify the sriov-vf
26448           required: true
26449           type: string
26450           example: __PCI-ID__
26451         - name: resource-version
26452           in: query
26453           description: resource-version for concurrency
26454           required: true
26455           type: string
26456   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
26457     get:
26458       tags:
26459         - Network
26460       summary: returns sriov-vfs
26461       description: returns sriov-vfs
26462       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
26463       produces:
26464         - application/json
26465         - application/xml
26466       responses:
26467         "200":
26468           description: successful operation
26469           schema:
26470               $ref: "#/getDefinitions/sriov-vfs"
26471         "default":
26472           description: Response codes found in [response codes](https://wiki.onap.org/).
26473       parameters:
26474         - name: equipment-name
26475           in: path
26476           required: true
26477           type: string
26478           example: __EQUIPMENT-NAME__
26479         - name: interface-name
26480           in: path
26481           description: Name that identifies the link aggregate interface
26482           required: true
26483           type: string
26484           example: __INTERFACE-NAME__
26485         - name: interface-name
26486           in: path
26487           description: Name given to the interface
26488           required: true
26489           type: string
26490           example: __INTERFACE-NAME__
26491         - name: pci-id
26492           in: query
26493           description:
26494           required: false
26495           type: string
26496         - name: vf-vlan-filter
26497           in: query
26498           description:
26499           required: false
26500           type: string
26501         - name: vf-mac-filter
26502           in: query
26503           description:
26504           required: false
26505           type: string
26506         - name: vf-vlan-strip
26507           in: query
26508           description:
26509           required: false
26510           type: boolean
26511         - name: neutron-network-id
26512           in: query
26513           description:
26514           required: false
26515           type: string
26516   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
26517     put:
26518       tags:
26519         - Network
26520       summary: see node definition for valid relationships
26521       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
26522       consumes:
26523         - application/json
26524         - application/xml
26525       produces:
26526         - application/json
26527         - application/xml
26528       responses:
26529         "default":
26530           description: Response codes found in [response codes](https://wiki.onap.org/).
26531       parameters:
26532         - name: equipment-name
26533           in: path
26534           required: true
26535           type: string
26536           example: __EQUIPMENT-NAME__
26537         - name: interface-name
26538           in: path
26539           description: Name that identifies the link aggregate interface
26540           required: true
26541           type: string
26542           example: __INTERFACE-NAME__
26543         - name: interface-name
26544           in: path
26545           description: Name given to the interface
26546           required: true
26547           type: string
26548           example: __INTERFACE-NAME__
26549         - name: body
26550           in: body
26551           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
26552           required: true
26553           schema:
26554             $ref: "#/definitions/relationship"
26555     delete:
26556       tags:
26557         - Network
26558       summary: delete an existing relationship
26559       description: delete an existing relationship
26560       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
26561       consumes:
26562         - application/json
26563         - application/xml
26564       produces:
26565         - application/json
26566         - application/xml
26567       responses:
26568         "default":
26569           description: Response codes found in [response codes](https://wiki.onap.org/).
26570       parameters:
26571         - name: equipment-name
26572           in: path
26573           required: true
26574           type: string
26575           example: __EQUIPMENT-NAME__
26576         - name: interface-name
26577           in: path
26578           description: Name that identifies the link aggregate interface
26579           required: true
26580           type: string
26581           example: __INTERFACE-NAME__
26582         - name: interface-name
26583           in: path
26584           description: Name given to the interface
26585           required: true
26586           type: string
26587           example: __INTERFACE-NAME__
26588   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
26589     put:
26590       tags:
26591         - Network
26592       summary: see node definition for valid relationships
26593       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26594       consumes:
26595         - application/json
26596         - application/xml
26597       produces:
26598         - application/json
26599         - application/xml
26600       responses:
26601         "default":
26602           description: Response codes found in [response codes](https://wiki.onap.org/).
26603       parameters:
26604         - name: equipment-name
26605           in: path
26606           required: true
26607           type: string
26608           example: __EQUIPMENT-NAME__
26609         - name: interface-name
26610           in: path
26611           description: Name that identifies the link aggregate interface
26612           required: true
26613           type: string
26614           example: __INTERFACE-NAME__
26615         - name: interface-name
26616           in: path
26617           description: Name given to the interface
26618           required: true
26619           type: string
26620           example: __INTERFACE-NAME__
26621         - name: l3-interface-ipv4-address
26622           in: path
26623           description: IP address
26624           required: true
26625           type: string
26626           example: __L3-INTERFACE-IPV4-ADDRESS__
26627         - name: body
26628           in: body
26629           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26630           required: true
26631           schema:
26632             $ref: "#/definitions/relationship"
26633     delete:
26634       tags:
26635         - Network
26636       summary: delete an existing relationship
26637       description: delete an existing relationship
26638       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26639       consumes:
26640         - application/json
26641         - application/xml
26642       produces:
26643         - application/json
26644         - application/xml
26645       responses:
26646         "default":
26647           description: Response codes found in [response codes](https://wiki.onap.org/).
26648       parameters:
26649         - name: equipment-name
26650           in: path
26651           required: true
26652           type: string
26653           example: __EQUIPMENT-NAME__
26654         - name: interface-name
26655           in: path
26656           description: Name that identifies the link aggregate interface
26657           required: true
26658           type: string
26659           example: __INTERFACE-NAME__
26660         - name: interface-name
26661           in: path
26662           description: Name given to the interface
26663           required: true
26664           type: string
26665           example: __INTERFACE-NAME__
26666         - name: l3-interface-ipv4-address
26667           in: path
26668           description: IP address
26669           required: true
26670           type: string
26671           example: __L3-INTERFACE-IPV4-ADDRESS__
26672   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
26673     get:
26674       tags:
26675         - Network
26676       summary: returns l3-interface-ipv4-address-list
26677       description: returns l3-interface-ipv4-address-list
26678       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26679       produces:
26680         - application/json
26681         - application/xml
26682       responses:
26683         "200":
26684           description: successful operation
26685           schema:
26686               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
26687         "default":
26688           description: Response codes found in [response codes](https://wiki.onap.org/).
26689       parameters:
26690         - name: equipment-name
26691           in: path
26692           required: true
26693           type: string
26694           example: __EQUIPMENT-NAME__
26695         - name: interface-name
26696           in: path
26697           description: Name that identifies the link aggregate interface
26698           required: true
26699           type: string
26700           example: __INTERFACE-NAME__
26701         - name: interface-name
26702           in: path
26703           description: Name given to the interface
26704           required: true
26705           type: string
26706           example: __INTERFACE-NAME__
26707         - name: l3-interface-ipv4-address
26708           in: path
26709           description: IP address
26710           required: true
26711           type: string
26712           example: __L3-INTERFACE-IPV4-ADDRESS__
26713     put:
26714       tags:
26715         - Network
26716       summary: create or update an existing l3-interface-ipv4-address-list
26717       description: |
26718         Create or update an existing l3-interface-ipv4-address-list.
26719         #
26720         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26721       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26722       consumes:
26723         - application/json
26724         - application/xml
26725       produces:
26726         - application/json
26727         - application/xml
26728       responses:
26729         "default":
26730           description: Response codes found in [response codes](https://wiki.onap.org/).
26731       parameters:
26732         - name: equipment-name
26733           in: path
26734           required: true
26735           type: string
26736           example: __EQUIPMENT-NAME__
26737         - name: interface-name
26738           in: path
26739           description: Name that identifies the link aggregate interface
26740           required: true
26741           type: string
26742           example: __INTERFACE-NAME__
26743         - name: interface-name
26744           in: path
26745           description: Name given to the interface
26746           required: true
26747           type: string
26748           example: __INTERFACE-NAME__
26749         - name: l3-interface-ipv4-address
26750           in: path
26751           description: IP address
26752           required: true
26753           type: string
26754           example: __L3-INTERFACE-IPV4-ADDRESS__
26755         - name: body
26756           in: body
26757           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26758           required: true
26759           schema:
26760             $ref: "#/definitions/l3-interface-ipv4-address-list"
26761     patch:
26762       tags:
26763         - Network
26764       summary: update an existing l3-interface-ipv4-address-list
26765       description: |
26766         Update an existing l3-interface-ipv4-address-list
26767         #
26768         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26769         The PUT operation will entirely replace an existing object.
26770         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26771         #
26772         Other differences between PUT and PATCH are:
26773         #
26774         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26775         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26776         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26777       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26778       consumes:
26779         - application/json
26780         - application/xml
26781       produces:
26782         - application/json
26783         - application/xml
26784       responses:
26785         "default":
26786           description: Response codes found in [response codes](https://wiki.onap.org/).
26787       parameters:
26788         - name: equipment-name
26789           in: path
26790           required: true
26791           type: string
26792           example: __EQUIPMENT-NAME__
26793         - name: interface-name
26794           in: path
26795           description: Name that identifies the link aggregate interface
26796           required: true
26797           type: string
26798           example: __INTERFACE-NAME__
26799         - name: interface-name
26800           in: path
26801           description: Name given to the interface
26802           required: true
26803           type: string
26804           example: __INTERFACE-NAME__
26805         - name: l3-interface-ipv4-address
26806           in: path
26807           description: IP address
26808           required: true
26809           type: string
26810           example: __L3-INTERFACE-IPV4-ADDRESS__
26811         - name: body
26812           in: body
26813           description: l3-interface-ipv4-address-list object that needs to be updated.
26814           required: true
26815           schema:
26816             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
26817     delete:
26818       tags:
26819         - Network
26820       summary: delete an existing l3-interface-ipv4-address-list
26821       description: delete an existing l3-interface-ipv4-address-list
26822       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26823       consumes:
26824         - application/json
26825         - application/xml
26826       produces:
26827         - application/json
26828         - application/xml
26829       responses:
26830         "default":
26831           description: Response codes found in [response codes](https://wiki.onap.org/).
26832       parameters:
26833         - name: equipment-name
26834           in: path
26835           required: true
26836           type: string
26837           example: __EQUIPMENT-NAME__
26838         - name: interface-name
26839           in: path
26840           description: Name that identifies the link aggregate interface
26841           required: true
26842           type: string
26843           example: __INTERFACE-NAME__
26844         - name: interface-name
26845           in: path
26846           description: Name given to the interface
26847           required: true
26848           type: string
26849           example: __INTERFACE-NAME__
26850         - name: l3-interface-ipv4-address
26851           in: path
26852           description: IP address
26853           required: true
26854           type: string
26855           example: __L3-INTERFACE-IPV4-ADDRESS__
26856         - name: resource-version
26857           in: query
26858           description: resource-version for concurrency
26859           required: true
26860           type: string
26861   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
26862     put:
26863       tags:
26864         - Network
26865       summary: see node definition for valid relationships
26866       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26867       consumes:
26868         - application/json
26869         - application/xml
26870       produces:
26871         - application/json
26872         - application/xml
26873       responses:
26874         "default":
26875           description: Response codes found in [response codes](https://wiki.onap.org/).
26876       parameters:
26877         - name: equipment-name
26878           in: path
26879           required: true
26880           type: string
26881           example: __EQUIPMENT-NAME__
26882         - name: interface-name
26883           in: path
26884           description: Name that identifies the link aggregate interface
26885           required: true
26886           type: string
26887           example: __INTERFACE-NAME__
26888         - name: interface-name
26889           in: path
26890           description: Name given to the interface
26891           required: true
26892           type: string
26893           example: __INTERFACE-NAME__
26894         - name: l3-interface-ipv6-address
26895           in: path
26896           description: IP address
26897           required: true
26898           type: string
26899           example: __L3-INTERFACE-IPV6-ADDRESS__
26900         - name: body
26901           in: body
26902           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26903           required: true
26904           schema:
26905             $ref: "#/definitions/relationship"
26906     delete:
26907       tags:
26908         - Network
26909       summary: delete an existing relationship
26910       description: delete an existing relationship
26911       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26912       consumes:
26913         - application/json
26914         - application/xml
26915       produces:
26916         - application/json
26917         - application/xml
26918       responses:
26919         "default":
26920           description: Response codes found in [response codes](https://wiki.onap.org/).
26921       parameters:
26922         - name: equipment-name
26923           in: path
26924           required: true
26925           type: string
26926           example: __EQUIPMENT-NAME__
26927         - name: interface-name
26928           in: path
26929           description: Name that identifies the link aggregate interface
26930           required: true
26931           type: string
26932           example: __INTERFACE-NAME__
26933         - name: interface-name
26934           in: path
26935           description: Name given to the interface
26936           required: true
26937           type: string
26938           example: __INTERFACE-NAME__
26939         - name: l3-interface-ipv6-address
26940           in: path
26941           description: IP address
26942           required: true
26943           type: string
26944           example: __L3-INTERFACE-IPV6-ADDRESS__
26945   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
26946     get:
26947       tags:
26948         - Network
26949       summary: returns l3-interface-ipv6-address-list
26950       description: returns l3-interface-ipv6-address-list
26951       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26952       produces:
26953         - application/json
26954         - application/xml
26955       responses:
26956         "200":
26957           description: successful operation
26958           schema:
26959               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
26960         "default":
26961           description: Response codes found in [response codes](https://wiki.onap.org/).
26962       parameters:
26963         - name: equipment-name
26964           in: path
26965           required: true
26966           type: string
26967           example: __EQUIPMENT-NAME__
26968         - name: interface-name
26969           in: path
26970           description: Name that identifies the link aggregate interface
26971           required: true
26972           type: string
26973           example: __INTERFACE-NAME__
26974         - name: interface-name
26975           in: path
26976           description: Name given to the interface
26977           required: true
26978           type: string
26979           example: __INTERFACE-NAME__
26980         - name: l3-interface-ipv6-address
26981           in: path
26982           description: IP address
26983           required: true
26984           type: string
26985           example: __L3-INTERFACE-IPV6-ADDRESS__
26986     put:
26987       tags:
26988         - Network
26989       summary: create or update an existing l3-interface-ipv6-address-list
26990       description: |
26991         Create or update an existing l3-interface-ipv6-address-list.
26992         #
26993         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26994       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26995       consumes:
26996         - application/json
26997         - application/xml
26998       produces:
26999         - application/json
27000         - application/xml
27001       responses:
27002         "default":
27003           description: Response codes found in [response codes](https://wiki.onap.org/).
27004       parameters:
27005         - name: equipment-name
27006           in: path
27007           required: true
27008           type: string
27009           example: __EQUIPMENT-NAME__
27010         - name: interface-name
27011           in: path
27012           description: Name that identifies the link aggregate interface
27013           required: true
27014           type: string
27015           example: __INTERFACE-NAME__
27016         - name: interface-name
27017           in: path
27018           description: Name given to the interface
27019           required: true
27020           type: string
27021           example: __INTERFACE-NAME__
27022         - name: l3-interface-ipv6-address
27023           in: path
27024           description: IP address
27025           required: true
27026           type: string
27027           example: __L3-INTERFACE-IPV6-ADDRESS__
27028         - name: body
27029           in: body
27030           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
27031           required: true
27032           schema:
27033             $ref: "#/definitions/l3-interface-ipv6-address-list"
27034     patch:
27035       tags:
27036         - Network
27037       summary: update an existing l3-interface-ipv6-address-list
27038       description: |
27039         Update an existing l3-interface-ipv6-address-list
27040         #
27041         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27042         The PUT operation will entirely replace an existing object.
27043         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27044         #
27045         Other differences between PUT and PATCH are:
27046         #
27047         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27048         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27049         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27050       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27051       consumes:
27052         - application/json
27053         - application/xml
27054       produces:
27055         - application/json
27056         - application/xml
27057       responses:
27058         "default":
27059           description: Response codes found in [response codes](https://wiki.onap.org/).
27060       parameters:
27061         - name: equipment-name
27062           in: path
27063           required: true
27064           type: string
27065           example: __EQUIPMENT-NAME__
27066         - name: interface-name
27067           in: path
27068           description: Name that identifies the link aggregate interface
27069           required: true
27070           type: string
27071           example: __INTERFACE-NAME__
27072         - name: interface-name
27073           in: path
27074           description: Name given to the interface
27075           required: true
27076           type: string
27077           example: __INTERFACE-NAME__
27078         - name: l3-interface-ipv6-address
27079           in: path
27080           description: IP address
27081           required: true
27082           type: string
27083           example: __L3-INTERFACE-IPV6-ADDRESS__
27084         - name: body
27085           in: body
27086           description: l3-interface-ipv6-address-list object that needs to be updated.
27087           required: true
27088           schema:
27089             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27090     delete:
27091       tags:
27092         - Network
27093       summary: delete an existing l3-interface-ipv6-address-list
27094       description: delete an existing l3-interface-ipv6-address-list
27095       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27096       consumes:
27097         - application/json
27098         - application/xml
27099       produces:
27100         - application/json
27101         - application/xml
27102       responses:
27103         "default":
27104           description: Response codes found in [response codes](https://wiki.onap.org/).
27105       parameters:
27106         - name: equipment-name
27107           in: path
27108           required: true
27109           type: string
27110           example: __EQUIPMENT-NAME__
27111         - name: interface-name
27112           in: path
27113           description: Name that identifies the link aggregate interface
27114           required: true
27115           type: string
27116           example: __INTERFACE-NAME__
27117         - name: interface-name
27118           in: path
27119           description: Name given to the interface
27120           required: true
27121           type: string
27122           example: __INTERFACE-NAME__
27123         - name: l3-interface-ipv6-address
27124           in: path
27125           description: IP address
27126           required: true
27127           type: string
27128           example: __L3-INTERFACE-IPV6-ADDRESS__
27129         - name: resource-version
27130           in: query
27131           description: resource-version for concurrency
27132           required: true
27133           type: string
27134   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
27135     get:
27136       tags:
27137         - Network
27138       summary: returns l-interface
27139       description: returns l-interface
27140       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27141       produces:
27142         - application/json
27143         - application/xml
27144       responses:
27145         "200":
27146           description: successful operation
27147           schema:
27148               $ref: "#/getDefinitions/l-interface"
27149         "default":
27150           description: Response codes found in [response codes](https://wiki.onap.org/).
27151       parameters:
27152         - name: equipment-name
27153           in: path
27154           required: true
27155           type: string
27156           example: __EQUIPMENT-NAME__
27157         - name: interface-name
27158           in: path
27159           description: Name that identifies the link aggregate interface
27160           required: true
27161           type: string
27162           example: __INTERFACE-NAME__
27163         - name: interface-name
27164           in: path
27165           description: Name given to the interface
27166           required: true
27167           type: string
27168           example: __INTERFACE-NAME__
27169     put:
27170       tags:
27171         - Network
27172       summary: create or update an existing l-interface
27173       description: |
27174         Create or update an existing l-interface.
27175         #
27176         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27177       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27178       consumes:
27179         - application/json
27180         - application/xml
27181       produces:
27182         - application/json
27183         - application/xml
27184       responses:
27185         "default":
27186           description: Response codes found in [response codes](https://wiki.onap.org/).
27187       parameters:
27188         - name: equipment-name
27189           in: path
27190           required: true
27191           type: string
27192           example: __EQUIPMENT-NAME__
27193         - name: interface-name
27194           in: path
27195           description: Name that identifies the link aggregate interface
27196           required: true
27197           type: string
27198           example: __INTERFACE-NAME__
27199         - name: interface-name
27200           in: path
27201           description: Name given to the interface
27202           required: true
27203           type: string
27204           example: __INTERFACE-NAME__
27205         - name: body
27206           in: body
27207           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
27208           required: true
27209           schema:
27210             $ref: "#/definitions/l-interface"
27211     patch:
27212       tags:
27213         - Network
27214       summary: update an existing l-interface
27215       description: |
27216         Update an existing l-interface
27217         #
27218         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27219         The PUT operation will entirely replace an existing object.
27220         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27221         #
27222         Other differences between PUT and PATCH are:
27223         #
27224         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27225         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27226         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27227       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27228       consumes:
27229         - application/json
27230         - application/xml
27231       produces:
27232         - application/json
27233         - application/xml
27234       responses:
27235         "default":
27236           description: Response codes found in [response codes](https://wiki.onap.org/).
27237       parameters:
27238         - name: equipment-name
27239           in: path
27240           required: true
27241           type: string
27242           example: __EQUIPMENT-NAME__
27243         - name: interface-name
27244           in: path
27245           description: Name that identifies the link aggregate interface
27246           required: true
27247           type: string
27248           example: __INTERFACE-NAME__
27249         - name: interface-name
27250           in: path
27251           description: Name given to the interface
27252           required: true
27253           type: string
27254           example: __INTERFACE-NAME__
27255         - name: body
27256           in: body
27257           description: l-interface object that needs to be updated.
27258           required: true
27259           schema:
27260             $ref: "#/patchDefinitions/l-interface"
27261     delete:
27262       tags:
27263         - Network
27264       summary: delete an existing l-interface
27265       description: delete an existing l-interface
27266       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27267       consumes:
27268         - application/json
27269         - application/xml
27270       produces:
27271         - application/json
27272         - application/xml
27273       responses:
27274         "default":
27275           description: Response codes found in [response codes](https://wiki.onap.org/).
27276       parameters:
27277         - name: equipment-name
27278           in: path
27279           required: true
27280           type: string
27281           example: __EQUIPMENT-NAME__
27282         - name: interface-name
27283           in: path
27284           description: Name that identifies the link aggregate interface
27285           required: true
27286           type: string
27287           example: __INTERFACE-NAME__
27288         - name: interface-name
27289           in: path
27290           description: Name given to the interface
27291           required: true
27292           type: string
27293           example: __INTERFACE-NAME__
27294         - name: resource-version
27295           in: query
27296           description: resource-version for concurrency
27297           required: true
27298           type: string
27299   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
27300     get:
27301       tags:
27302         - Network
27303       summary: returns l-interfaces
27304       description: returns l-interfaces
27305       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
27306       produces:
27307         - application/json
27308         - application/xml
27309       responses:
27310         "200":
27311           description: successful operation
27312           schema:
27313               $ref: "#/getDefinitions/l-interfaces"
27314         "default":
27315           description: Response codes found in [response codes](https://wiki.onap.org/).
27316       parameters:
27317         - name: equipment-name
27318           in: path
27319           required: true
27320           type: string
27321           example: __EQUIPMENT-NAME__
27322         - name: interface-name
27323           in: path
27324           description: Name that identifies the link aggregate interface
27325           required: true
27326           type: string
27327           example: __INTERFACE-NAME__
27328         - name: interface-name
27329           in: query
27330           description:
27331           required: false
27332           type: string
27333         - name: interface-id
27334           in: query
27335           description:
27336           required: false
27337           type: string
27338         - name: macaddr
27339           in: query
27340           description:
27341           required: false
27342           type: string
27343         - name: network-name
27344           in: query
27345           description:
27346           required: false
27347           type: string
27348   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
27349     get:
27350       tags:
27351         - Network
27352       summary: returns lag-interface
27353       description: returns lag-interface
27354       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
27355       produces:
27356         - application/json
27357         - application/xml
27358       responses:
27359         "200":
27360           description: successful operation
27361           schema:
27362               $ref: "#/getDefinitions/lag-interface"
27363         "default":
27364           description: Response codes found in [response codes](https://wiki.onap.org/).
27365       parameters:
27366         - name: equipment-name
27367           in: path
27368           required: true
27369           type: string
27370           example: __EQUIPMENT-NAME__
27371         - name: interface-name
27372           in: path
27373           description: Name that identifies the link aggregate interface
27374           required: true
27375           type: string
27376           example: __INTERFACE-NAME__
27377     put:
27378       tags:
27379         - Network
27380       summary: create or update an existing lag-interface
27381       description: |
27382         Create or update an existing lag-interface.
27383         #
27384         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27385       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
27386       consumes:
27387         - application/json
27388         - application/xml
27389       produces:
27390         - application/json
27391         - application/xml
27392       responses:
27393         "default":
27394           description: Response codes found in [response codes](https://wiki.onap.org/).
27395       parameters:
27396         - name: equipment-name
27397           in: path
27398           required: true
27399           type: string
27400           example: __EQUIPMENT-NAME__
27401         - name: interface-name
27402           in: path
27403           description: Name that identifies the link aggregate interface
27404           required: true
27405           type: string
27406           example: __INTERFACE-NAME__
27407         - name: body
27408           in: body
27409           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
27410           required: true
27411           schema:
27412             $ref: "#/definitions/lag-interface"
27413     patch:
27414       tags:
27415         - Network
27416       summary: update an existing lag-interface
27417       description: |
27418         Update an existing lag-interface
27419         #
27420         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27421         The PUT operation will entirely replace an existing object.
27422         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27423         #
27424         Other differences between PUT and PATCH are:
27425         #
27426         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27427         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27428         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27429       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
27430       consumes:
27431         - application/json
27432         - application/xml
27433       produces:
27434         - application/json
27435         - application/xml
27436       responses:
27437         "default":
27438           description: Response codes found in [response codes](https://wiki.onap.org/).
27439       parameters:
27440         - name: equipment-name
27441           in: path
27442           required: true
27443           type: string
27444           example: __EQUIPMENT-NAME__
27445         - name: interface-name
27446           in: path
27447           description: Name that identifies the link aggregate interface
27448           required: true
27449           type: string
27450           example: __INTERFACE-NAME__
27451         - name: body
27452           in: body
27453           description: lag-interface object that needs to be updated.
27454           required: true
27455           schema:
27456             $ref: "#/patchDefinitions/lag-interface"
27457     delete:
27458       tags:
27459         - Network
27460       summary: delete an existing lag-interface
27461       description: delete an existing lag-interface
27462       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
27463       consumes:
27464         - application/json
27465         - application/xml
27466       produces:
27467         - application/json
27468         - application/xml
27469       responses:
27470         "default":
27471           description: Response codes found in [response codes](https://wiki.onap.org/).
27472       parameters:
27473         - name: equipment-name
27474           in: path
27475           required: true
27476           type: string
27477           example: __EQUIPMENT-NAME__
27478         - name: interface-name
27479           in: path
27480           description: Name that identifies the link aggregate interface
27481           required: true
27482           type: string
27483           example: __INTERFACE-NAME__
27484         - name: resource-version
27485           in: query
27486           description: resource-version for concurrency
27487           required: true
27488           type: string
27489   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
27490     get:
27491       tags:
27492         - Network
27493       summary: returns lag-interfaces
27494       description: returns lag-interfaces
27495       operationId: getNetworkVplsPesVplsPeLagInterfaces
27496       produces:
27497         - application/json
27498         - application/xml
27499       responses:
27500         "200":
27501           description: successful operation
27502           schema:
27503               $ref: "#/getDefinitions/lag-interfaces"
27504         "default":
27505           description: Response codes found in [response codes](https://wiki.onap.org/).
27506       parameters:
27507         - name: equipment-name
27508           in: path
27509           required: true
27510           type: string
27511           example: __EQUIPMENT-NAME__
27512         - name: interface-name
27513           in: query
27514           description:
27515           required: false
27516           type: string
27517         - name: interface-id
27518           in: query
27519           description:
27520           required: false
27521           type: string
27522         - name: interface-role
27523           in: query
27524           description:
27525           required: false
27526           type: string
27527   /network/vpls-pes/vpls-pe/{equipment-name}:
27528     get:
27529       tags:
27530         - Network
27531       summary: returns vpls-pe
27532       description: returns vpls-pe
27533       operationId: getNetworkVplsPesVplsPe
27534       produces:
27535         - application/json
27536         - application/xml
27537       responses:
27538         "200":
27539           description: successful operation
27540           schema:
27541               $ref: "#/getDefinitions/vpls-pe"
27542         "default":
27543           description: Response codes found in [response codes](https://wiki.onap.org/).
27544       parameters:
27545         - name: equipment-name
27546           in: path
27547           required: true
27548           type: string
27549           example: __EQUIPMENT-NAME__
27550     put:
27551       tags:
27552         - Network
27553       summary: create or update an existing vpls-pe
27554       description: |
27555         Create or update an existing vpls-pe.
27556         #
27557         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27558       operationId: createOrUpdateNetworkVplsPesVplsPe
27559       consumes:
27560         - application/json
27561         - application/xml
27562       produces:
27563         - application/json
27564         - application/xml
27565       responses:
27566         "default":
27567           description: Response codes found in [response codes](https://wiki.onap.org/).
27568       parameters:
27569         - name: equipment-name
27570           in: path
27571           required: true
27572           type: string
27573           example: __EQUIPMENT-NAME__
27574         - name: body
27575           in: body
27576           description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json)
27577           required: true
27578           schema:
27579             $ref: "#/definitions/vpls-pe"
27580     patch:
27581       tags:
27582         - Network
27583       summary: update an existing vpls-pe
27584       description: |
27585         Update an existing vpls-pe
27586         #
27587         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27588         The PUT operation will entirely replace an existing object.
27589         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27590         #
27591         Other differences between PUT and PATCH are:
27592         #
27593         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27594         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27595         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27596       operationId: UpdateNetworkVplsPesVplsPe
27597       consumes:
27598         - application/json
27599         - application/xml
27600       produces:
27601         - application/json
27602         - application/xml
27603       responses:
27604         "default":
27605           description: Response codes found in [response codes](https://wiki.onap.org/).
27606       parameters:
27607         - name: equipment-name
27608           in: path
27609           required: true
27610           type: string
27611           example: __EQUIPMENT-NAME__
27612         - name: body
27613           in: body
27614           description: vpls-pe object that needs to be updated.
27615           required: true
27616           schema:
27617             $ref: "#/patchDefinitions/vpls-pe"
27618     delete:
27619       tags:
27620         - Network
27621       summary: delete an existing vpls-pe
27622       description: delete an existing vpls-pe
27623       operationId: deleteNetworkVplsPesVplsPe
27624       consumes:
27625         - application/json
27626         - application/xml
27627       produces:
27628         - application/json
27629         - application/xml
27630       responses:
27631         "default":
27632           description: Response codes found in [response codes](https://wiki.onap.org/).
27633       parameters:
27634         - name: equipment-name
27635           in: path
27636           required: true
27637           type: string
27638           example: __EQUIPMENT-NAME__
27639         - name: resource-version
27640           in: query
27641           description: resource-version for concurrency
27642           required: true
27643           type: string
27644   /network/vpls-pes:
27645     get:
27646       tags:
27647         - Network
27648       summary: returns vpls-pes
27649       description: returns vpls-pes
27650       operationId: getNetworkVplsPes
27651       produces:
27652         - application/json
27653         - application/xml
27654       responses:
27655         "200":
27656           description: successful operation
27657           schema:
27658               $ref: "#/getDefinitions/vpls-pes"
27659         "default":
27660           description: Response codes found in [response codes](https://wiki.onap.org/).
27661       parameters:
27662         - name: equipment-name
27663           in: query
27664           description:
27665           required: false
27666           type: string
27667         - name: prov-status
27668           in: query
27669           description:
27670           required: false
27671           type: string
27672   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
27673     put:
27674       tags:
27675         - Network
27676       summary: see node definition for valid relationships
27677       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
27678       consumes:
27679         - application/json
27680         - application/xml
27681       produces:
27682         - application/json
27683         - application/xml
27684       responses:
27685         "default":
27686           description: Response codes found in [response codes](https://wiki.onap.org/).
27687       parameters:
27688         - name: multicast-configuration-id
27689           in: path
27690           description: Unique id of multicast configuration.
27691           required: true
27692           type: string
27693           example: __MULTICAST-CONFIGURATION-ID__
27694         - name: body
27695           in: body
27696           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json)
27697           required: true
27698           schema:
27699             $ref: "#/definitions/relationship"
27700     delete:
27701       tags:
27702         - Network
27703       summary: delete an existing relationship
27704       description: delete an existing relationship
27705       operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
27706       consumes:
27707         - application/json
27708         - application/xml
27709       produces:
27710         - application/json
27711         - application/xml
27712       responses:
27713         "default":
27714           description: Response codes found in [response codes](https://wiki.onap.org/).
27715       parameters:
27716         - name: multicast-configuration-id
27717           in: path
27718           description: Unique id of multicast configuration.
27719           required: true
27720           type: string
27721           example: __MULTICAST-CONFIGURATION-ID__
27722   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
27723     get:
27724       tags:
27725         - Network
27726       summary: returns multicast-configuration
27727       description: returns multicast-configuration
27728       operationId: getNetworkMulticastConfigurationsMulticastConfiguration
27729       produces:
27730         - application/json
27731         - application/xml
27732       responses:
27733         "200":
27734           description: successful operation
27735           schema:
27736               $ref: "#/getDefinitions/multicast-configuration"
27737         "default":
27738           description: Response codes found in [response codes](https://wiki.onap.org/).
27739       parameters:
27740         - name: multicast-configuration-id
27741           in: path
27742           description: Unique id of multicast configuration.
27743           required: true
27744           type: string
27745           example: __MULTICAST-CONFIGURATION-ID__
27746     put:
27747       tags:
27748         - Network
27749       summary: create or update an existing multicast-configuration
27750       description: |
27751         Create or update an existing multicast-configuration.
27752         #
27753         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27754       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
27755       consumes:
27756         - application/json
27757         - application/xml
27758       produces:
27759         - application/json
27760         - application/xml
27761       responses:
27762         "default":
27763           description: Response codes found in [response codes](https://wiki.onap.org/).
27764       parameters:
27765         - name: multicast-configuration-id
27766           in: path
27767           description: Unique id of multicast configuration.
27768           required: true
27769           type: string
27770           example: __MULTICAST-CONFIGURATION-ID__
27771         - name: body
27772           in: body
27773           description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json)
27774           required: true
27775           schema:
27776             $ref: "#/definitions/multicast-configuration"
27777     patch:
27778       tags:
27779         - Network
27780       summary: update an existing multicast-configuration
27781       description: |
27782         Update an existing multicast-configuration
27783         #
27784         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27785         The PUT operation will entirely replace an existing object.
27786         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27787         #
27788         Other differences between PUT and PATCH are:
27789         #
27790         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27791         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27792         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27793       operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
27794       consumes:
27795         - application/json
27796         - application/xml
27797       produces:
27798         - application/json
27799         - application/xml
27800       responses:
27801         "default":
27802           description: Response codes found in [response codes](https://wiki.onap.org/).
27803       parameters:
27804         - name: multicast-configuration-id
27805           in: path
27806           description: Unique id of multicast configuration.
27807           required: true
27808           type: string
27809           example: __MULTICAST-CONFIGURATION-ID__
27810         - name: body
27811           in: body
27812           description: multicast-configuration object that needs to be updated.
27813           required: true
27814           schema:
27815             $ref: "#/patchDefinitions/multicast-configuration"
27816     delete:
27817       tags:
27818         - Network
27819       summary: delete an existing multicast-configuration
27820       description: delete an existing multicast-configuration
27821       operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
27822       consumes:
27823         - application/json
27824         - application/xml
27825       produces:
27826         - application/json
27827         - application/xml
27828       responses:
27829         "default":
27830           description: Response codes found in [response codes](https://wiki.onap.org/).
27831       parameters:
27832         - name: multicast-configuration-id
27833           in: path
27834           description: Unique id of multicast configuration.
27835           required: true
27836           type: string
27837           example: __MULTICAST-CONFIGURATION-ID__
27838         - name: resource-version
27839           in: query
27840           description: resource-version for concurrency
27841           required: true
27842           type: string
27843   /network/multicast-configurations:
27844     get:
27845       tags:
27846         - Network
27847       summary: returns multicast-configurations
27848       description: returns multicast-configurations
27849       operationId: getNetworkMulticastConfigurations
27850       produces:
27851         - application/json
27852         - application/xml
27853       responses:
27854         "200":
27855           description: successful operation
27856           schema:
27857               $ref: "#/getDefinitions/multicast-configurations"
27858         "default":
27859           description: Response codes found in [response codes](https://wiki.onap.org/).
27860       parameters:
27861         - name: multicast-configuration-id
27862           in: query
27863           description:
27864           required: false
27865           type: string
27866   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
27867     put:
27868       tags:
27869         - Network
27870       summary: see node definition for valid relationships
27871       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
27872       consumes:
27873         - application/json
27874         - application/xml
27875       produces:
27876         - application/json
27877         - application/xml
27878       responses:
27879         "default":
27880           description: Response codes found in [response codes](https://wiki.onap.org/).
27881       parameters:
27882         - name: vnf-id
27883           in: path
27884           description: Unique id of VNF.  This is unique across the graph.
27885           required: true
27886           type: string
27887           example: __VNF-ID__
27888         - name: interface-id
27889           in: path
27890           description: Unique ID of the interface
27891           required: true
27892           type: string
27893           example: __INTERFACE-ID__
27894         - name: cvlan-tag
27895           in: path
27896           description: See mis-na-virtualization-platform.yang
27897           required: true
27898           type: integer
27899           format: int64
27900           example: __CVLAN-TAG__
27901         - name: body
27902           in: body
27903           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
27904           required: true
27905           schema:
27906             $ref: "#/definitions/relationship"
27907     delete:
27908       tags:
27909         - Network
27910       summary: delete an existing relationship
27911       description: delete an existing relationship
27912       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
27913       consumes:
27914         - application/json
27915         - application/xml
27916       produces:
27917         - application/json
27918         - application/xml
27919       responses:
27920         "default":
27921           description: Response codes found in [response codes](https://wiki.onap.org/).
27922       parameters:
27923         - name: vnf-id
27924           in: path
27925           description: Unique id of VNF.  This is unique across the graph.
27926           required: true
27927           type: string
27928           example: __VNF-ID__
27929         - name: interface-id
27930           in: path
27931           description: Unique ID of the interface
27932           required: true
27933           type: string
27934           example: __INTERFACE-ID__
27935         - name: cvlan-tag
27936           in: path
27937           description: See mis-na-virtualization-platform.yang
27938           required: true
27939           type: integer
27940           format: int64
27941           example: __CVLAN-TAG__
27942   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
27943     get:
27944       tags:
27945         - Network
27946       summary: returns cvlan-tag-entry
27947       description: returns cvlan-tag-entry
27948       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27949       produces:
27950         - application/json
27951         - application/xml
27952       responses:
27953         "200":
27954           description: successful operation
27955           schema:
27956               $ref: "#/getDefinitions/cvlan-tag-entry"
27957         "default":
27958           description: Response codes found in [response codes](https://wiki.onap.org/).
27959       parameters:
27960         - name: vnf-id
27961           in: path
27962           description: Unique id of VNF.  This is unique across the graph.
27963           required: true
27964           type: string
27965           example: __VNF-ID__
27966         - name: interface-id
27967           in: path
27968           description: Unique ID of the interface
27969           required: true
27970           type: string
27971           example: __INTERFACE-ID__
27972         - name: cvlan-tag
27973           in: path
27974           description: See mis-na-virtualization-platform.yang
27975           required: true
27976           type: integer
27977           format: int64
27978           example: __CVLAN-TAG__
27979     put:
27980       tags:
27981         - Network
27982       summary: create or update an existing cvlan-tag-entry
27983       description: |
27984         Create or update an existing cvlan-tag-entry.
27985         #
27986         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27987       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27988       consumes:
27989         - application/json
27990         - application/xml
27991       produces:
27992         - application/json
27993         - application/xml
27994       responses:
27995         "default":
27996           description: Response codes found in [response codes](https://wiki.onap.org/).
27997       parameters:
27998         - name: vnf-id
27999           in: path
28000           description: Unique id of VNF.  This is unique across the graph.
28001           required: true
28002           type: string
28003           example: __VNF-ID__
28004         - name: interface-id
28005           in: path
28006           description: Unique ID of the interface
28007           required: true
28008           type: string
28009           example: __INTERFACE-ID__
28010         - name: cvlan-tag
28011           in: path
28012           description: See mis-na-virtualization-platform.yang
28013           required: true
28014           type: integer
28015           format: int64
28016           example: __CVLAN-TAG__
28017         - name: body
28018           in: body
28019           description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
28020           required: true
28021           schema:
28022             $ref: "#/definitions/cvlan-tag-entry"
28023     patch:
28024       tags:
28025         - Network
28026       summary: update an existing cvlan-tag-entry
28027       description: |
28028         Update an existing cvlan-tag-entry
28029         #
28030         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28031         The PUT operation will entirely replace an existing object.
28032         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28033         #
28034         Other differences between PUT and PATCH are:
28035         #
28036         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28037         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28038         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28039       operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
28040       consumes:
28041         - application/json
28042         - application/xml
28043       produces:
28044         - application/json
28045         - application/xml
28046       responses:
28047         "default":
28048           description: Response codes found in [response codes](https://wiki.onap.org/).
28049       parameters:
28050         - name: vnf-id
28051           in: path
28052           description: Unique id of VNF.  This is unique across the graph.
28053           required: true
28054           type: string
28055           example: __VNF-ID__
28056         - name: interface-id
28057           in: path
28058           description: Unique ID of the interface
28059           required: true
28060           type: string
28061           example: __INTERFACE-ID__
28062         - name: cvlan-tag
28063           in: path
28064           description: See mis-na-virtualization-platform.yang
28065           required: true
28066           type: integer
28067           format: int64
28068           example: __CVLAN-TAG__
28069         - name: body
28070           in: body
28071           description: cvlan-tag-entry object that needs to be updated.
28072           required: true
28073           schema:
28074             $ref: "#/patchDefinitions/cvlan-tag-entry"
28075     delete:
28076       tags:
28077         - Network
28078       summary: delete an existing cvlan-tag-entry
28079       description: delete an existing cvlan-tag-entry
28080       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
28081       consumes:
28082         - application/json
28083         - application/xml
28084       produces:
28085         - application/json
28086         - application/xml
28087       responses:
28088         "default":
28089           description: Response codes found in [response codes](https://wiki.onap.org/).
28090       parameters:
28091         - name: vnf-id
28092           in: path
28093           description: Unique id of VNF.  This is unique across the graph.
28094           required: true
28095           type: string
28096           example: __VNF-ID__
28097         - name: interface-id
28098           in: path
28099           description: Unique ID of the interface
28100           required: true
28101           type: string
28102           example: __INTERFACE-ID__
28103         - name: cvlan-tag
28104           in: path
28105           description: See mis-na-virtualization-platform.yang
28106           required: true
28107           type: integer
28108           format: int64
28109           example: __CVLAN-TAG__
28110         - name: resource-version
28111           in: query
28112           description: resource-version for concurrency
28113           required: true
28114           type: string
28115   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
28116     get:
28117       tags:
28118         - Network
28119       summary: returns cvlan-tags
28120       description: returns cvlan-tags
28121       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
28122       produces:
28123         - application/json
28124         - application/xml
28125       responses:
28126         "200":
28127           description: successful operation
28128           schema:
28129               $ref: "#/getDefinitions/cvlan-tags"
28130         "default":
28131           description: Response codes found in [response codes](https://wiki.onap.org/).
28132       parameters:
28133         - name: vnf-id
28134           in: path
28135           description: Unique id of VNF.  This is unique across the graph.
28136           required: true
28137           type: string
28138           example: __VNF-ID__
28139         - name: interface-id
28140           in: path
28141           description: Unique ID of the interface
28142           required: true
28143           type: string
28144           example: __INTERFACE-ID__
28145         - name: cvlan-tag
28146           in: query
28147           description:
28148           required: false
28149           type: integer
28150           format: int64
28151   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
28152     put:
28153       tags:
28154         - Network
28155       summary: see node definition for valid relationships
28156       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
28157       consumes:
28158         - application/json
28159         - application/xml
28160       produces:
28161         - application/json
28162         - application/xml
28163       responses:
28164         "default":
28165           description: Response codes found in [response codes](https://wiki.onap.org/).
28166       parameters:
28167         - name: vnf-id
28168           in: path
28169           description: Unique id of VNF.  This is unique across the graph.
28170           required: true
28171           type: string
28172           example: __VNF-ID__
28173         - name: interface-id
28174           in: path
28175           description: Unique ID of the interface
28176           required: true
28177           type: string
28178           example: __INTERFACE-ID__
28179         - name: body
28180           in: body
28181           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json)
28182           required: true
28183           schema:
28184             $ref: "#/definitions/relationship"
28185     delete:
28186       tags:
28187         - Network
28188       summary: delete an existing relationship
28189       description: delete an existing relationship
28190       operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
28191       consumes:
28192         - application/json
28193         - application/xml
28194       produces:
28195         - application/json
28196         - application/xml
28197       responses:
28198         "default":
28199           description: Response codes found in [response codes](https://wiki.onap.org/).
28200       parameters:
28201         - name: vnf-id
28202           in: path
28203           description: Unique id of VNF.  This is unique across the graph.
28204           required: true
28205           type: string
28206           example: __VNF-ID__
28207         - name: interface-id
28208           in: path
28209           description: Unique ID of the interface
28210           required: true
28211           type: string
28212           example: __INTERFACE-ID__
28213   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
28214     get:
28215       tags:
28216         - Network
28217       summary: returns port-group
28218       description: returns port-group
28219       operationId: getNetworkVcesVcePortGroupsPortGroup
28220       produces:
28221         - application/json
28222         - application/xml
28223       responses:
28224         "200":
28225           description: successful operation
28226           schema:
28227               $ref: "#/getDefinitions/port-group"
28228         "default":
28229           description: Response codes found in [response codes](https://wiki.onap.org/).
28230       parameters:
28231         - name: vnf-id
28232           in: path
28233           description: Unique id of VNF.  This is unique across the graph.
28234           required: true
28235           type: string
28236           example: __VNF-ID__
28237         - name: interface-id
28238           in: path
28239           description: Unique ID of the interface
28240           required: true
28241           type: string
28242           example: __INTERFACE-ID__
28243     put:
28244       tags:
28245         - Network
28246       summary: create or update an existing port-group
28247       description: |
28248         Create or update an existing port-group.
28249         #
28250         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28251       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
28252       consumes:
28253         - application/json
28254         - application/xml
28255       produces:
28256         - application/json
28257         - application/xml
28258       responses:
28259         "default":
28260           description: Response codes found in [response codes](https://wiki.onap.org/).
28261       parameters:
28262         - name: vnf-id
28263           in: path
28264           description: Unique id of VNF.  This is unique across the graph.
28265           required: true
28266           type: string
28267           example: __VNF-ID__
28268         - name: interface-id
28269           in: path
28270           description: Unique ID of the interface
28271           required: true
28272           type: string
28273           example: __INTERFACE-ID__
28274         - name: body
28275           in: body
28276           description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json)
28277           required: true
28278           schema:
28279             $ref: "#/definitions/port-group"
28280     patch:
28281       tags:
28282         - Network
28283       summary: update an existing port-group
28284       description: |
28285         Update an existing port-group
28286         #
28287         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28288         The PUT operation will entirely replace an existing object.
28289         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28290         #
28291         Other differences between PUT and PATCH are:
28292         #
28293         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28294         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28295         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28296       operationId: UpdateNetworkVcesVcePortGroupsPortGroup
28297       consumes:
28298         - application/json
28299         - application/xml
28300       produces:
28301         - application/json
28302         - application/xml
28303       responses:
28304         "default":
28305           description: Response codes found in [response codes](https://wiki.onap.org/).
28306       parameters:
28307         - name: vnf-id
28308           in: path
28309           description: Unique id of VNF.  This is unique across the graph.
28310           required: true
28311           type: string
28312           example: __VNF-ID__
28313         - name: interface-id
28314           in: path
28315           description: Unique ID of the interface
28316           required: true
28317           type: string
28318           example: __INTERFACE-ID__
28319         - name: body
28320           in: body
28321           description: port-group object that needs to be updated.
28322           required: true
28323           schema:
28324             $ref: "#/patchDefinitions/port-group"
28325     delete:
28326       tags:
28327         - Network
28328       summary: delete an existing port-group
28329       description: delete an existing port-group
28330       operationId: deleteNetworkVcesVcePortGroupsPortGroup
28331       consumes:
28332         - application/json
28333         - application/xml
28334       produces:
28335         - application/json
28336         - application/xml
28337       responses:
28338         "default":
28339           description: Response codes found in [response codes](https://wiki.onap.org/).
28340       parameters:
28341         - name: vnf-id
28342           in: path
28343           description: Unique id of VNF.  This is unique across the graph.
28344           required: true
28345           type: string
28346           example: __VNF-ID__
28347         - name: interface-id
28348           in: path
28349           description: Unique ID of the interface
28350           required: true
28351           type: string
28352           example: __INTERFACE-ID__
28353         - name: resource-version
28354           in: query
28355           description: resource-version for concurrency
28356           required: true
28357           type: string
28358   /network/vces/vce/{vnf-id}/port-groups:
28359     get:
28360       tags:
28361         - Network
28362       summary: returns port-groups
28363       description: returns port-groups
28364       operationId: getNetworkVcesVcePortGroups
28365       produces:
28366         - application/json
28367         - application/xml
28368       responses:
28369         "200":
28370           description: successful operation
28371           schema:
28372               $ref: "#/getDefinitions/port-groups"
28373         "default":
28374           description: Response codes found in [response codes](https://wiki.onap.org/).
28375       parameters:
28376         - name: vnf-id
28377           in: path
28378           description: Unique id of VNF.  This is unique across the graph.
28379           required: true
28380           type: string
28381           example: __VNF-ID__
28382         - name: interface-id
28383           in: query
28384           description:
28385           required: false
28386           type: string
28387         - name: port-group-id
28388           in: query
28389           description:
28390           required: false
28391           type: string
28392         - name: switch-name
28393           in: query
28394           description:
28395           required: false
28396           type: string
28397         - name: heat-stack-id
28398           in: query
28399           description:
28400           required: false
28401           type: string
28402   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
28403     put:
28404       tags:
28405         - Network
28406       summary: see node definition for valid relationships
28407       operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
28408       consumes:
28409         - application/json
28410         - application/xml
28411       produces:
28412         - application/json
28413         - application/xml
28414       responses:
28415         "default":
28416           description: Response codes found in [response codes](https://wiki.onap.org/).
28417       parameters:
28418         - name: vnf-id
28419           in: path
28420           description: Unique id of VNF.  This is unique across the graph.
28421           required: true
28422           type: string
28423           example: __VNF-ID__
28424         - name: group-uuid
28425           in: path
28426           description: Unique ID for the license group the resource belongs to, should be uuid.
28427           required: true
28428           type: string
28429           example: __GROUP-UUID__
28430         - name: resource-uuid
28431           in: path
28432           description: Unique ID of a license resource.
28433           required: true
28434           type: string
28435           example: __RESOURCE-UUID__
28436         - name: body
28437           in: body
28438           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json)
28439           required: true
28440           schema:
28441             $ref: "#/definitions/relationship"
28442     delete:
28443       tags:
28444         - Network
28445       summary: delete an existing relationship
28446       description: delete an existing relationship
28447       operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
28448       consumes:
28449         - application/json
28450         - application/xml
28451       produces:
28452         - application/json
28453         - application/xml
28454       responses:
28455         "default":
28456           description: Response codes found in [response codes](https://wiki.onap.org/).
28457       parameters:
28458         - name: vnf-id
28459           in: path
28460           description: Unique id of VNF.  This is unique across the graph.
28461           required: true
28462           type: string
28463           example: __VNF-ID__
28464         - name: group-uuid
28465           in: path
28466           description: Unique ID for the license group the resource belongs to, should be uuid.
28467           required: true
28468           type: string
28469           example: __GROUP-UUID__
28470         - name: resource-uuid
28471           in: path
28472           description: Unique ID of a license resource.
28473           required: true
28474           type: string
28475           example: __RESOURCE-UUID__
28476   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
28477     get:
28478       tags:
28479         - Network
28480       summary: returns license
28481       description: returns license
28482       operationId: getNetworkVcesVceLicensesLicense
28483       produces:
28484         - application/json
28485         - application/xml
28486       responses:
28487         "200":
28488           description: successful operation
28489           schema:
28490               $ref: "#/getDefinitions/license"
28491         "default":
28492           description: Response codes found in [response codes](https://wiki.onap.org/).
28493       parameters:
28494         - name: vnf-id
28495           in: path
28496           description: Unique id of VNF.  This is unique across the graph.
28497           required: true
28498           type: string
28499           example: __VNF-ID__
28500         - name: group-uuid
28501           in: path
28502           description: Unique ID for the license group the resource belongs to, should be uuid.
28503           required: true
28504           type: string
28505           example: __GROUP-UUID__
28506         - name: resource-uuid
28507           in: path
28508           description: Unique ID of a license resource.
28509           required: true
28510           type: string
28511           example: __RESOURCE-UUID__
28512     put:
28513       tags:
28514         - Network
28515       summary: create or update an existing license
28516       description: |
28517         Create or update an existing license.
28518         #
28519         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28520       operationId: createOrUpdateNetworkVcesVceLicensesLicense
28521       consumes:
28522         - application/json
28523         - application/xml
28524       produces:
28525         - application/json
28526         - application/xml
28527       responses:
28528         "default":
28529           description: Response codes found in [response codes](https://wiki.onap.org/).
28530       parameters:
28531         - name: vnf-id
28532           in: path
28533           description: Unique id of VNF.  This is unique across the graph.
28534           required: true
28535           type: string
28536           example: __VNF-ID__
28537         - name: group-uuid
28538           in: path
28539           description: Unique ID for the license group the resource belongs to, should be uuid.
28540           required: true
28541           type: string
28542           example: __GROUP-UUID__
28543         - name: resource-uuid
28544           in: path
28545           description: Unique ID of a license resource.
28546           required: true
28547           type: string
28548           example: __RESOURCE-UUID__
28549         - name: body
28550           in: body
28551           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json)
28552           required: true
28553           schema:
28554             $ref: "#/definitions/license"
28555     patch:
28556       tags:
28557         - Network
28558       summary: update an existing license
28559       description: |
28560         Update an existing license
28561         #
28562         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28563         The PUT operation will entirely replace an existing object.
28564         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28565         #
28566         Other differences between PUT and PATCH are:
28567         #
28568         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28569         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28570         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28571       operationId: UpdateNetworkVcesVceLicensesLicense
28572       consumes:
28573         - application/json
28574         - application/xml
28575       produces:
28576         - application/json
28577         - application/xml
28578       responses:
28579         "default":
28580           description: Response codes found in [response codes](https://wiki.onap.org/).
28581       parameters:
28582         - name: vnf-id
28583           in: path
28584           description: Unique id of VNF.  This is unique across the graph.
28585           required: true
28586           type: string
28587           example: __VNF-ID__
28588         - name: group-uuid
28589           in: path
28590           description: Unique ID for the license group the resource belongs to, should be uuid.
28591           required: true
28592           type: string
28593           example: __GROUP-UUID__
28594         - name: resource-uuid
28595           in: path
28596           description: Unique ID of a license resource.
28597           required: true
28598           type: string
28599           example: __RESOURCE-UUID__
28600         - name: body
28601           in: body
28602           description: license object that needs to be updated.
28603           required: true
28604           schema:
28605             $ref: "#/patchDefinitions/license"
28606     delete:
28607       tags:
28608         - Network
28609       summary: delete an existing license
28610       description: delete an existing license
28611       operationId: deleteNetworkVcesVceLicensesLicense
28612       consumes:
28613         - application/json
28614         - application/xml
28615       produces:
28616         - application/json
28617         - application/xml
28618       responses:
28619         "default":
28620           description: Response codes found in [response codes](https://wiki.onap.org/).
28621       parameters:
28622         - name: vnf-id
28623           in: path
28624           description: Unique id of VNF.  This is unique across the graph.
28625           required: true
28626           type: string
28627           example: __VNF-ID__
28628         - name: group-uuid
28629           in: path
28630           description: Unique ID for the license group the resource belongs to, should be uuid.
28631           required: true
28632           type: string
28633           example: __GROUP-UUID__
28634         - name: resource-uuid
28635           in: path
28636           description: Unique ID of a license resource.
28637           required: true
28638           type: string
28639           example: __RESOURCE-UUID__
28640         - name: resource-version
28641           in: query
28642           description: resource-version for concurrency
28643           required: true
28644           type: string
28645   /network/vces/vce/{vnf-id}/licenses:
28646     get:
28647       tags:
28648         - Network
28649       summary: returns licenses
28650       description: returns licenses
28651       operationId: getNetworkVcesVceLicenses
28652       produces:
28653         - application/json
28654         - application/xml
28655       responses:
28656         "200":
28657           description: successful operation
28658           schema:
28659               $ref: "#/getDefinitions/licenses"
28660         "default":
28661           description: Response codes found in [response codes](https://wiki.onap.org/).
28662       parameters:
28663         - name: vnf-id
28664           in: path
28665           description: Unique id of VNF.  This is unique across the graph.
28666           required: true
28667           type: string
28668           example: __VNF-ID__
28669         - name: group-uuid
28670           in: query
28671           description:
28672           required: false
28673           type: string
28674         - name: resource-uuid
28675           in: query
28676           description:
28677           required: false
28678           type: string
28679   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
28680     put:
28681       tags:
28682         - Network
28683       summary: see node definition for valid relationships
28684       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
28685       consumes:
28686         - application/json
28687         - application/xml
28688       produces:
28689         - application/json
28690         - application/xml
28691       responses:
28692         "default":
28693           description: Response codes found in [response codes](https://wiki.onap.org/).
28694       parameters:
28695         - name: vnf-id
28696           in: path
28697           description: Unique id of VNF.  This is unique across the graph.
28698           required: true
28699           type: string
28700           example: __VNF-ID__
28701         - name: group-uuid
28702           in: path
28703           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28704           required: true
28705           type: string
28706           example: __GROUP-UUID__
28707         - name: resource-uuid
28708           in: path
28709           description: Unique ID of an entitlement resource.
28710           required: true
28711           type: string
28712           example: __RESOURCE-UUID__
28713         - name: body
28714           in: body
28715           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json)
28716           required: true
28717           schema:
28718             $ref: "#/definitions/relationship"
28719     delete:
28720       tags:
28721         - Network
28722       summary: delete an existing relationship
28723       description: delete an existing relationship
28724       operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
28725       consumes:
28726         - application/json
28727         - application/xml
28728       produces:
28729         - application/json
28730         - application/xml
28731       responses:
28732         "default":
28733           description: Response codes found in [response codes](https://wiki.onap.org/).
28734       parameters:
28735         - name: vnf-id
28736           in: path
28737           description: Unique id of VNF.  This is unique across the graph.
28738           required: true
28739           type: string
28740           example: __VNF-ID__
28741         - name: group-uuid
28742           in: path
28743           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28744           required: true
28745           type: string
28746           example: __GROUP-UUID__
28747         - name: resource-uuid
28748           in: path
28749           description: Unique ID of an entitlement resource.
28750           required: true
28751           type: string
28752           example: __RESOURCE-UUID__
28753   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
28754     get:
28755       tags:
28756         - Network
28757       summary: returns entitlement
28758       description: returns entitlement
28759       operationId: getNetworkVcesVceEntitlementsEntitlement
28760       produces:
28761         - application/json
28762         - application/xml
28763       responses:
28764         "200":
28765           description: successful operation
28766           schema:
28767               $ref: "#/getDefinitions/entitlement"
28768         "default":
28769           description: Response codes found in [response codes](https://wiki.onap.org/).
28770       parameters:
28771         - name: vnf-id
28772           in: path
28773           description: Unique id of VNF.  This is unique across the graph.
28774           required: true
28775           type: string
28776           example: __VNF-ID__
28777         - name: group-uuid
28778           in: path
28779           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28780           required: true
28781           type: string
28782           example: __GROUP-UUID__
28783         - name: resource-uuid
28784           in: path
28785           description: Unique ID of an entitlement resource.
28786           required: true
28787           type: string
28788           example: __RESOURCE-UUID__
28789     put:
28790       tags:
28791         - Network
28792       summary: create or update an existing entitlement
28793       description: |
28794         Create or update an existing entitlement.
28795         #
28796         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28797       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
28798       consumes:
28799         - application/json
28800         - application/xml
28801       produces:
28802         - application/json
28803         - application/xml
28804       responses:
28805         "default":
28806           description: Response codes found in [response codes](https://wiki.onap.org/).
28807       parameters:
28808         - name: vnf-id
28809           in: path
28810           description: Unique id of VNF.  This is unique across the graph.
28811           required: true
28812           type: string
28813           example: __VNF-ID__
28814         - name: group-uuid
28815           in: path
28816           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28817           required: true
28818           type: string
28819           example: __GROUP-UUID__
28820         - name: resource-uuid
28821           in: path
28822           description: Unique ID of an entitlement resource.
28823           required: true
28824           type: string
28825           example: __RESOURCE-UUID__
28826         - name: body
28827           in: body
28828           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json)
28829           required: true
28830           schema:
28831             $ref: "#/definitions/entitlement"
28832     patch:
28833       tags:
28834         - Network
28835       summary: update an existing entitlement
28836       description: |
28837         Update an existing entitlement
28838         #
28839         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28840         The PUT operation will entirely replace an existing object.
28841         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28842         #
28843         Other differences between PUT and PATCH are:
28844         #
28845         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28846         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28847         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28848       operationId: UpdateNetworkVcesVceEntitlementsEntitlement
28849       consumes:
28850         - application/json
28851         - application/xml
28852       produces:
28853         - application/json
28854         - application/xml
28855       responses:
28856         "default":
28857           description: Response codes found in [response codes](https://wiki.onap.org/).
28858       parameters:
28859         - name: vnf-id
28860           in: path
28861           description: Unique id of VNF.  This is unique across the graph.
28862           required: true
28863           type: string
28864           example: __VNF-ID__
28865         - name: group-uuid
28866           in: path
28867           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28868           required: true
28869           type: string
28870           example: __GROUP-UUID__
28871         - name: resource-uuid
28872           in: path
28873           description: Unique ID of an entitlement resource.
28874           required: true
28875           type: string
28876           example: __RESOURCE-UUID__
28877         - name: body
28878           in: body
28879           description: entitlement object that needs to be updated.
28880           required: true
28881           schema:
28882             $ref: "#/patchDefinitions/entitlement"
28883     delete:
28884       tags:
28885         - Network
28886       summary: delete an existing entitlement
28887       description: delete an existing entitlement
28888       operationId: deleteNetworkVcesVceEntitlementsEntitlement
28889       consumes:
28890         - application/json
28891         - application/xml
28892       produces:
28893         - application/json
28894         - application/xml
28895       responses:
28896         "default":
28897           description: Response codes found in [response codes](https://wiki.onap.org/).
28898       parameters:
28899         - name: vnf-id
28900           in: path
28901           description: Unique id of VNF.  This is unique across the graph.
28902           required: true
28903           type: string
28904           example: __VNF-ID__
28905         - name: group-uuid
28906           in: path
28907           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28908           required: true
28909           type: string
28910           example: __GROUP-UUID__
28911         - name: resource-uuid
28912           in: path
28913           description: Unique ID of an entitlement resource.
28914           required: true
28915           type: string
28916           example: __RESOURCE-UUID__
28917         - name: resource-version
28918           in: query
28919           description: resource-version for concurrency
28920           required: true
28921           type: string
28922   /network/vces/vce/{vnf-id}/entitlements:
28923     get:
28924       tags:
28925         - Network
28926       summary: returns entitlements
28927       description: returns entitlements
28928       operationId: getNetworkVcesVceEntitlements
28929       produces:
28930         - application/json
28931         - application/xml
28932       responses:
28933         "200":
28934           description: successful operation
28935           schema:
28936               $ref: "#/getDefinitions/entitlements"
28937         "default":
28938           description: Response codes found in [response codes](https://wiki.onap.org/).
28939       parameters:
28940         - name: vnf-id
28941           in: path
28942           description: Unique id of VNF.  This is unique across the graph.
28943           required: true
28944           type: string
28945           example: __VNF-ID__
28946         - name: group-uuid
28947           in: query
28948           description:
28949           required: false
28950           type: string
28951         - name: resource-uuid
28952           in: query
28953           description:
28954           required: false
28955           type: string
28956   /network/vces/vce/{vnf-id}/relationship-list/relationship:
28957     put:
28958       tags:
28959         - Network
28960       summary: see node definition for valid relationships
28961       operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
28962       consumes:
28963         - application/json
28964         - application/xml
28965       produces:
28966         - application/json
28967         - application/xml
28968       responses:
28969         "default":
28970           description: Response codes found in [response codes](https://wiki.onap.org/).
28971       parameters:
28972         - name: vnf-id
28973           in: path
28974           description: Unique id of VNF.  This is unique across the graph.
28975           required: true
28976           type: string
28977           example: __VNF-ID__
28978         - name: body
28979           in: body
28980           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json)
28981           required: true
28982           schema:
28983             $ref: "#/definitions/relationship"
28984     delete:
28985       tags:
28986         - Network
28987       summary: delete an existing relationship
28988       description: delete an existing relationship
28989       operationId: deleteNetworkVcesVceRelationshipListRelationship
28990       consumes:
28991         - application/json
28992         - application/xml
28993       produces:
28994         - application/json
28995         - application/xml
28996       responses:
28997         "default":
28998           description: Response codes found in [response codes](https://wiki.onap.org/).
28999       parameters:
29000         - name: vnf-id
29001           in: path
29002           description: Unique id of VNF.  This is unique across the graph.
29003           required: true
29004           type: string
29005           example: __VNF-ID__
29006   /network/vces/vce/{vnf-id}:
29007     get:
29008       tags:
29009         - Network
29010       summary: returns vce
29011       description: returns vce
29012       operationId: getNetworkVcesVce
29013       produces:
29014         - application/json
29015         - application/xml
29016       responses:
29017         "200":
29018           description: successful operation
29019           schema:
29020               $ref: "#/getDefinitions/vce"
29021         "default":
29022           description: Response codes found in [response codes](https://wiki.onap.org/).
29023       parameters:
29024         - name: vnf-id
29025           in: path
29026           description: Unique id of VNF.  This is unique across the graph.
29027           required: true
29028           type: string
29029           example: __VNF-ID__
29030     put:
29031       tags:
29032         - Network
29033       summary: create or update an existing vce
29034       description: |
29035         Create or update an existing vce.
29036         #
29037         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29038       operationId: createOrUpdateNetworkVcesVce
29039       consumes:
29040         - application/json
29041         - application/xml
29042       produces:
29043         - application/json
29044         - application/xml
29045       responses:
29046         "default":
29047           description: Response codes found in [response codes](https://wiki.onap.org/).
29048       parameters:
29049         - name: vnf-id
29050           in: path
29051           description: Unique id of VNF.  This is unique across the graph.
29052           required: true
29053           type: string
29054           example: __VNF-ID__
29055         - name: body
29056           in: body
29057           description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json)
29058           required: true
29059           schema:
29060             $ref: "#/definitions/vce"
29061     patch:
29062       tags:
29063         - Network
29064       summary: update an existing vce
29065       description: |
29066         Update an existing vce
29067         #
29068         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29069         The PUT operation will entirely replace an existing object.
29070         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29071         #
29072         Other differences between PUT and PATCH are:
29073         #
29074         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29075         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29076         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29077       operationId: UpdateNetworkVcesVce
29078       consumes:
29079         - application/json
29080         - application/xml
29081       produces:
29082         - application/json
29083         - application/xml
29084       responses:
29085         "default":
29086           description: Response codes found in [response codes](https://wiki.onap.org/).
29087       parameters:
29088         - name: vnf-id
29089           in: path
29090           description: Unique id of VNF.  This is unique across the graph.
29091           required: true
29092           type: string
29093           example: __VNF-ID__
29094         - name: body
29095           in: body
29096           description: vce object that needs to be updated.
29097           required: true
29098           schema:
29099             $ref: "#/patchDefinitions/vce"
29100     delete:
29101       tags:
29102         - Network
29103       summary: delete an existing vce
29104       description: delete an existing vce
29105       operationId: deleteNetworkVcesVce
29106       consumes:
29107         - application/json
29108         - application/xml
29109       produces:
29110         - application/json
29111         - application/xml
29112       responses:
29113         "default":
29114           description: Response codes found in [response codes](https://wiki.onap.org/).
29115       parameters:
29116         - name: vnf-id
29117           in: path
29118           description: Unique id of VNF.  This is unique across the graph.
29119           required: true
29120           type: string
29121           example: __VNF-ID__
29122         - name: resource-version
29123           in: query
29124           description: resource-version for concurrency
29125           required: true
29126           type: string
29127   /network/vces:
29128     get:
29129       tags:
29130         - Network
29131       summary: returns vces
29132       description: returns vces
29133       operationId: getNetworkVces
29134       produces:
29135         - application/json
29136         - application/xml
29137       responses:
29138         "200":
29139           description: successful operation
29140           schema:
29141               $ref: "#/getDefinitions/vces"
29142         "default":
29143           description: Response codes found in [response codes](https://wiki.onap.org/).
29144       parameters:
29145         - name: vnf-id
29146           in: query
29147           description:
29148           required: false
29149           type: string
29150         - name: vnf-name
29151           in: query
29152           description:
29153           required: false
29154           type: string
29155         - name: vnf-name2
29156           in: query
29157           description:
29158           required: false
29159           type: string
29160         - name: vnf-type
29161           in: query
29162           description:
29163           required: false
29164           type: string
29165         - name: service-id
29166           in: query
29167           description:
29168           required: false
29169           type: string
29170         - name: regional-resource-zone
29171           in: query
29172           description:
29173           required: false
29174           type: string
29175         - name: prov-status
29176           in: query
29177           description:
29178           required: false
29179           type: string
29180         - name: heat-stack-id
29181           in: query
29182           description:
29183           required: false
29184           type: string
29185         - name: vpe-id
29186           in: query
29187           description:
29188           required: false
29189           type: string
29190   /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
29191     put:
29192       tags:
29193         - Network
29194       summary: see node definition for valid relationships
29195       operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
29196       consumes:
29197         - application/json
29198         - application/xml
29199       produces:
29200         - application/json
29201         - application/xml
29202       responses:
29203         "default":
29204           description: Response codes found in [response codes](https://wiki.onap.org/).
29205       parameters:
29206         - name: vnfc-name
29207           in: path
29208           description: Unique ID of vnfc.
29209           required: true
29210           type: string
29211           example: __VNFC-NAME__
29212         - name: body
29213           in: body
29214           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json)
29215           required: true
29216           schema:
29217             $ref: "#/definitions/relationship"
29218     delete:
29219       tags:
29220         - Network
29221       summary: delete an existing relationship
29222       description: delete an existing relationship
29223       operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
29224       consumes:
29225         - application/json
29226         - application/xml
29227       produces:
29228         - application/json
29229         - application/xml
29230       responses:
29231         "default":
29232           description: Response codes found in [response codes](https://wiki.onap.org/).
29233       parameters:
29234         - name: vnfc-name
29235           in: path
29236           description: Unique ID of vnfc.
29237           required: true
29238           type: string
29239           example: __VNFC-NAME__
29240   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
29241     put:
29242       tags:
29243         - Network
29244       summary: see node definition for valid relationships
29245       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
29246       consumes:
29247         - application/json
29248         - application/xml
29249       produces:
29250         - application/json
29251         - application/xml
29252       responses:
29253         "default":
29254           description: Response codes found in [response codes](https://wiki.onap.org/).
29255       parameters:
29256         - name: vnfc-name
29257           in: path
29258           description: Unique ID of vnfc.
29259           required: true
29260           type: string
29261           example: __VNFC-NAME__
29262         - name: l3-interface-ipv4-address
29263           in: path
29264           description: IP address
29265           required: true
29266           type: string
29267           example: __L3-INTERFACE-IPV4-ADDRESS__
29268         - name: body
29269           in: body
29270           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
29271           required: true
29272           schema:
29273             $ref: "#/definitions/relationship"
29274     delete:
29275       tags:
29276         - Network
29277       summary: delete an existing relationship
29278       description: delete an existing relationship
29279       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
29280       consumes:
29281         - application/json
29282         - application/xml
29283       produces:
29284         - application/json
29285         - application/xml
29286       responses:
29287         "default":
29288           description: Response codes found in [response codes](https://wiki.onap.org/).
29289       parameters:
29290         - name: vnfc-name
29291           in: path
29292           description: Unique ID of vnfc.
29293           required: true
29294           type: string
29295           example: __VNFC-NAME__
29296         - name: l3-interface-ipv4-address
29297           in: path
29298           description: IP address
29299           required: true
29300           type: string
29301           example: __L3-INTERFACE-IPV4-ADDRESS__
29302   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
29303     get:
29304       tags:
29305         - Network
29306       summary: returns l3-interface-ipv4-address-list
29307       description: returns l3-interface-ipv4-address-list
29308       operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29309       produces:
29310         - application/json
29311         - application/xml
29312       responses:
29313         "200":
29314           description: successful operation
29315           schema:
29316               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
29317         "default":
29318           description: Response codes found in [response codes](https://wiki.onap.org/).
29319       parameters:
29320         - name: vnfc-name
29321           in: path
29322           description: Unique ID of vnfc.
29323           required: true
29324           type: string
29325           example: __VNFC-NAME__
29326         - name: l3-interface-ipv4-address
29327           in: path
29328           description: IP address
29329           required: true
29330           type: string
29331           example: __L3-INTERFACE-IPV4-ADDRESS__
29332     put:
29333       tags:
29334         - Network
29335       summary: create or update an existing l3-interface-ipv4-address-list
29336       description: |
29337         Create or update an existing l3-interface-ipv4-address-list.
29338         #
29339         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29340       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29341       consumes:
29342         - application/json
29343         - application/xml
29344       produces:
29345         - application/json
29346         - application/xml
29347       responses:
29348         "default":
29349           description: Response codes found in [response codes](https://wiki.onap.org/).
29350       parameters:
29351         - name: vnfc-name
29352           in: path
29353           description: Unique ID of vnfc.
29354           required: true
29355           type: string
29356           example: __VNFC-NAME__
29357         - name: l3-interface-ipv4-address
29358           in: path
29359           description: IP address
29360           required: true
29361           type: string
29362           example: __L3-INTERFACE-IPV4-ADDRESS__
29363         - name: body
29364           in: body
29365           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
29366           required: true
29367           schema:
29368             $ref: "#/definitions/l3-interface-ipv4-address-list"
29369     patch:
29370       tags:
29371         - Network
29372       summary: update an existing l3-interface-ipv4-address-list
29373       description: |
29374         Update an existing l3-interface-ipv4-address-list
29375         #
29376         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29377         The PUT operation will entirely replace an existing object.
29378         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29379         #
29380         Other differences between PUT and PATCH are:
29381         #
29382         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29383         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29384         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29385       operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29386       consumes:
29387         - application/json
29388         - application/xml
29389       produces:
29390         - application/json
29391         - application/xml
29392       responses:
29393         "default":
29394           description: Response codes found in [response codes](https://wiki.onap.org/).
29395       parameters:
29396         - name: vnfc-name
29397           in: path
29398           description: Unique ID of vnfc.
29399           required: true
29400           type: string
29401           example: __VNFC-NAME__
29402         - name: l3-interface-ipv4-address
29403           in: path
29404           description: IP address
29405           required: true
29406           type: string
29407           example: __L3-INTERFACE-IPV4-ADDRESS__
29408         - name: body
29409           in: body
29410           description: l3-interface-ipv4-address-list object that needs to be updated.
29411           required: true
29412           schema:
29413             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
29414     delete:
29415       tags:
29416         - Network
29417       summary: delete an existing l3-interface-ipv4-address-list
29418       description: delete an existing l3-interface-ipv4-address-list
29419       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29420       consumes:
29421         - application/json
29422         - application/xml
29423       produces:
29424         - application/json
29425         - application/xml
29426       responses:
29427         "default":
29428           description: Response codes found in [response codes](https://wiki.onap.org/).
29429       parameters:
29430         - name: vnfc-name
29431           in: path
29432           description: Unique ID of vnfc.
29433           required: true
29434           type: string
29435           example: __VNFC-NAME__
29436         - name: l3-interface-ipv4-address
29437           in: path
29438           description: IP address
29439           required: true
29440           type: string
29441           example: __L3-INTERFACE-IPV4-ADDRESS__
29442         - name: resource-version
29443           in: query
29444           description: resource-version for concurrency
29445           required: true
29446           type: string
29447   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
29448     put:
29449       tags:
29450         - Network
29451       summary: see node definition for valid relationships
29452       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
29453       consumes:
29454         - application/json
29455         - application/xml
29456       produces:
29457         - application/json
29458         - application/xml
29459       responses:
29460         "default":
29461           description: Response codes found in [response codes](https://wiki.onap.org/).
29462       parameters:
29463         - name: vnfc-name
29464           in: path
29465           description: Unique ID of vnfc.
29466           required: true
29467           type: string
29468           example: __VNFC-NAME__
29469         - name: l3-interface-ipv6-address
29470           in: path
29471           description: IP address
29472           required: true
29473           type: string
29474           example: __L3-INTERFACE-IPV6-ADDRESS__
29475         - name: body
29476           in: body
29477           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
29478           required: true
29479           schema:
29480             $ref: "#/definitions/relationship"
29481     delete:
29482       tags:
29483         - Network
29484       summary: delete an existing relationship
29485       description: delete an existing relationship
29486       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
29487       consumes:
29488         - application/json
29489         - application/xml
29490       produces:
29491         - application/json
29492         - application/xml
29493       responses:
29494         "default":
29495           description: Response codes found in [response codes](https://wiki.onap.org/).
29496       parameters:
29497         - name: vnfc-name
29498           in: path
29499           description: Unique ID of vnfc.
29500           required: true
29501           type: string
29502           example: __VNFC-NAME__
29503         - name: l3-interface-ipv6-address
29504           in: path
29505           description: IP address
29506           required: true
29507           type: string
29508           example: __L3-INTERFACE-IPV6-ADDRESS__
29509   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
29510     get:
29511       tags:
29512         - Network
29513       summary: returns l3-interface-ipv6-address-list
29514       description: returns l3-interface-ipv6-address-list
29515       operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29516       produces:
29517         - application/json
29518         - application/xml
29519       responses:
29520         "200":
29521           description: successful operation
29522           schema:
29523               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
29524         "default":
29525           description: Response codes found in [response codes](https://wiki.onap.org/).
29526       parameters:
29527         - name: vnfc-name
29528           in: path
29529           description: Unique ID of vnfc.
29530           required: true
29531           type: string
29532           example: __VNFC-NAME__
29533         - name: l3-interface-ipv6-address
29534           in: path
29535           description: IP address
29536           required: true
29537           type: string
29538           example: __L3-INTERFACE-IPV6-ADDRESS__
29539     put:
29540       tags:
29541         - Network
29542       summary: create or update an existing l3-interface-ipv6-address-list
29543       description: |
29544         Create or update an existing l3-interface-ipv6-address-list.
29545         #
29546         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29547       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29548       consumes:
29549         - application/json
29550         - application/xml
29551       produces:
29552         - application/json
29553         - application/xml
29554       responses:
29555         "default":
29556           description: Response codes found in [response codes](https://wiki.onap.org/).
29557       parameters:
29558         - name: vnfc-name
29559           in: path
29560           description: Unique ID of vnfc.
29561           required: true
29562           type: string
29563           example: __VNFC-NAME__
29564         - name: l3-interface-ipv6-address
29565           in: path
29566           description: IP address
29567           required: true
29568           type: string
29569           example: __L3-INTERFACE-IPV6-ADDRESS__
29570         - name: body
29571           in: body
29572           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
29573           required: true
29574           schema:
29575             $ref: "#/definitions/l3-interface-ipv6-address-list"
29576     patch:
29577       tags:
29578         - Network
29579       summary: update an existing l3-interface-ipv6-address-list
29580       description: |
29581         Update an existing l3-interface-ipv6-address-list
29582         #
29583         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29584         The PUT operation will entirely replace an existing object.
29585         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29586         #
29587         Other differences between PUT and PATCH are:
29588         #
29589         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29590         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29591         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29592       operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29593       consumes:
29594         - application/json
29595         - application/xml
29596       produces:
29597         - application/json
29598         - application/xml
29599       responses:
29600         "default":
29601           description: Response codes found in [response codes](https://wiki.onap.org/).
29602       parameters:
29603         - name: vnfc-name
29604           in: path
29605           description: Unique ID of vnfc.
29606           required: true
29607           type: string
29608           example: __VNFC-NAME__
29609         - name: l3-interface-ipv6-address
29610           in: path
29611           description: IP address
29612           required: true
29613           type: string
29614           example: __L3-INTERFACE-IPV6-ADDRESS__
29615         - name: body
29616           in: body
29617           description: l3-interface-ipv6-address-list object that needs to be updated.
29618           required: true
29619           schema:
29620             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
29621     delete:
29622       tags:
29623         - Network
29624       summary: delete an existing l3-interface-ipv6-address-list
29625       description: delete an existing l3-interface-ipv6-address-list
29626       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29627       consumes:
29628         - application/json
29629         - application/xml
29630       produces:
29631         - application/json
29632         - application/xml
29633       responses:
29634         "default":
29635           description: Response codes found in [response codes](https://wiki.onap.org/).
29636       parameters:
29637         - name: vnfc-name
29638           in: path
29639           description: Unique ID of vnfc.
29640           required: true
29641           type: string
29642           example: __VNFC-NAME__
29643         - name: l3-interface-ipv6-address
29644           in: path
29645           description: IP address
29646           required: true
29647           type: string
29648           example: __L3-INTERFACE-IPV6-ADDRESS__
29649         - name: resource-version
29650           in: query
29651           description: resource-version for concurrency
29652           required: true
29653           type: string
29654   /network/vnfcs/vnfc/{vnfc-name}:
29655     get:
29656       tags:
29657         - Network
29658       summary: returns vnfc
29659       description: returns vnfc
29660       operationId: getNetworkVnfcsVnfc
29661       produces:
29662         - application/json
29663         - application/xml
29664       responses:
29665         "200":
29666           description: successful operation
29667           schema:
29668               $ref: "#/getDefinitions/vnfc"
29669         "default":
29670           description: Response codes found in [response codes](https://wiki.onap.org/).
29671       parameters:
29672         - name: vnfc-name
29673           in: path
29674           description: Unique ID of vnfc.
29675           required: true
29676           type: string
29677           example: __VNFC-NAME__
29678     put:
29679       tags:
29680         - Network
29681       summary: create or update an existing vnfc
29682       description: |
29683         Create or update an existing vnfc.
29684         #
29685         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29686       operationId: createOrUpdateNetworkVnfcsVnfc
29687       consumes:
29688         - application/json
29689         - application/xml
29690       produces:
29691         - application/json
29692         - application/xml
29693       responses:
29694         "default":
29695           description: Response codes found in [response codes](https://wiki.onap.org/).
29696       parameters:
29697         - name: vnfc-name
29698           in: path
29699           description: Unique ID of vnfc.
29700           required: true
29701           type: string
29702           example: __VNFC-NAME__
29703         - name: body
29704           in: body
29705           description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json)
29706           required: true
29707           schema:
29708             $ref: "#/definitions/vnfc"
29709     patch:
29710       tags:
29711         - Network
29712       summary: update an existing vnfc
29713       description: |
29714         Update an existing vnfc
29715         #
29716         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29717         The PUT operation will entirely replace an existing object.
29718         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29719         #
29720         Other differences between PUT and PATCH are:
29721         #
29722         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29723         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29724         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29725       operationId: UpdateNetworkVnfcsVnfc
29726       consumes:
29727         - application/json
29728         - application/xml
29729       produces:
29730         - application/json
29731         - application/xml
29732       responses:
29733         "default":
29734           description: Response codes found in [response codes](https://wiki.onap.org/).
29735       parameters:
29736         - name: vnfc-name
29737           in: path
29738           description: Unique ID of vnfc.
29739           required: true
29740           type: string
29741           example: __VNFC-NAME__
29742         - name: body
29743           in: body
29744           description: vnfc object that needs to be updated.
29745           required: true
29746           schema:
29747             $ref: "#/patchDefinitions/vnfc"
29748     delete:
29749       tags:
29750         - Network
29751       summary: delete an existing vnfc
29752       description: delete an existing vnfc
29753       operationId: deleteNetworkVnfcsVnfc
29754       consumes:
29755         - application/json
29756         - application/xml
29757       produces:
29758         - application/json
29759         - application/xml
29760       responses:
29761         "default":
29762           description: Response codes found in [response codes](https://wiki.onap.org/).
29763       parameters:
29764         - name: vnfc-name
29765           in: path
29766           description: Unique ID of vnfc.
29767           required: true
29768           type: string
29769           example: __VNFC-NAME__
29770         - name: resource-version
29771           in: query
29772           description: resource-version for concurrency
29773           required: true
29774           type: string
29775   /network/vnfcs:
29776     get:
29777       tags:
29778         - Network
29779       summary: returns vnfcs
29780       description: returns vnfcs
29781       operationId: getNetworkVnfcs
29782       produces:
29783         - application/json
29784         - application/xml
29785       responses:
29786         "200":
29787           description: successful operation
29788           schema:
29789               $ref: "#/getDefinitions/vnfcs"
29790         "default":
29791           description: Response codes found in [response codes](https://wiki.onap.org/).
29792       parameters:
29793         - name: vnfc-name
29794           in: query
29795           description:
29796           required: false
29797           type: string
29798         - name: nfc-naming-code
29799           in: query
29800           description:
29801           required: false
29802           type: string
29803         - name: nfc-function
29804           in: query
29805           description:
29806           required: false
29807           type: string
29808         - name: prov-status
29809           in: query
29810           description:
29811           required: false
29812           type: string
29813         - name: ipaddress-v4-oam-vip
29814           in: query
29815           description:
29816           required: false
29817           type: string
29818         - name: in-maint
29819           in: query
29820           description:
29821           required: false
29822           type: boolean
29823         - name: is-closed-loop-disabled
29824           in: query
29825           description:
29826           required: false
29827           type: boolean
29828         - name: group-notation
29829           in: query
29830           description:
29831           required: false
29832           type: string
29833         - name: model-invariant-id
29834           in: query
29835           description:
29836           required: false
29837           type: string
29838         - name: model-version-id
29839           in: query
29840           description:
29841           required: false
29842           type: string
29843   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
29844     put:
29845       tags:
29846         - Network
29847       summary: see node definition for valid relationships
29848       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
29849       consumes:
29850         - application/json
29851         - application/xml
29852       produces:
29853         - application/json
29854         - application/xml
29855       responses:
29856         "default":
29857           description: Response codes found in [response codes](https://wiki.onap.org/).
29858       parameters:
29859         - name: network-id
29860           in: path
29861           description: Network ID, should be uuid. Unique across A&AI.
29862           required: true
29863           type: string
29864           example: __NETWORK-ID__
29865         - name: subnet-id
29866           in: path
29867           description: Subnet ID, should be UUID.
29868           required: true
29869           type: string
29870           example: __SUBNET-ID__
29871         - name: host-route-id
29872           in: path
29873           description: host-route id
29874           required: true
29875           type: string
29876           example: __HOST-ROUTE-ID__
29877         - name: body
29878           in: body
29879           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
29880           required: true
29881           schema:
29882             $ref: "#/definitions/relationship"
29883     delete:
29884       tags:
29885         - Network
29886       summary: delete an existing relationship
29887       description: delete an existing relationship
29888       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
29889       consumes:
29890         - application/json
29891         - application/xml
29892       produces:
29893         - application/json
29894         - application/xml
29895       responses:
29896         "default":
29897           description: Response codes found in [response codes](https://wiki.onap.org/).
29898       parameters:
29899         - name: network-id
29900           in: path
29901           description: Network ID, should be uuid. Unique across A&AI.
29902           required: true
29903           type: string
29904           example: __NETWORK-ID__
29905         - name: subnet-id
29906           in: path
29907           description: Subnet ID, should be UUID.
29908           required: true
29909           type: string
29910           example: __SUBNET-ID__
29911         - name: host-route-id
29912           in: path
29913           description: host-route id
29914           required: true
29915           type: string
29916           example: __HOST-ROUTE-ID__
29917   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
29918     get:
29919       tags:
29920         - Network
29921       summary: returns host-route
29922       description: returns host-route
29923       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
29924       produces:
29925         - application/json
29926         - application/xml
29927       responses:
29928         "200":
29929           description: successful operation
29930           schema:
29931               $ref: "#/getDefinitions/host-route"
29932         "default":
29933           description: Response codes found in [response codes](https://wiki.onap.org/).
29934       parameters:
29935         - name: network-id
29936           in: path
29937           description: Network ID, should be uuid. Unique across A&AI.
29938           required: true
29939           type: string
29940           example: __NETWORK-ID__
29941         - name: subnet-id
29942           in: path
29943           description: Subnet ID, should be UUID.
29944           required: true
29945           type: string
29946           example: __SUBNET-ID__
29947         - name: host-route-id
29948           in: path
29949           description: host-route id
29950           required: true
29951           type: string
29952           example: __HOST-ROUTE-ID__
29953     put:
29954       tags:
29955         - Network
29956       summary: create or update an existing host-route
29957       description: |
29958         Create or update an existing host-route.
29959         #
29960         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29961       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
29962       consumes:
29963         - application/json
29964         - application/xml
29965       produces:
29966         - application/json
29967         - application/xml
29968       responses:
29969         "default":
29970           description: Response codes found in [response codes](https://wiki.onap.org/).
29971       parameters:
29972         - name: network-id
29973           in: path
29974           description: Network ID, should be uuid. Unique across A&AI.
29975           required: true
29976           type: string
29977           example: __NETWORK-ID__
29978         - name: subnet-id
29979           in: path
29980           description: Subnet ID, should be UUID.
29981           required: true
29982           type: string
29983           example: __SUBNET-ID__
29984         - name: host-route-id
29985           in: path
29986           description: host-route id
29987           required: true
29988           type: string
29989           example: __HOST-ROUTE-ID__
29990         - name: body
29991           in: body
29992           description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
29993           required: true
29994           schema:
29995             $ref: "#/definitions/host-route"
29996     patch:
29997       tags:
29998         - Network
29999       summary: update an existing host-route
30000       description: |
30001         Update an existing host-route
30002         #
30003         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30004         The PUT operation will entirely replace an existing object.
30005         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30006         #
30007         Other differences between PUT and PATCH are:
30008         #
30009         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30010         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30011         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30012       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
30013       consumes:
30014         - application/json
30015         - application/xml
30016       produces:
30017         - application/json
30018         - application/xml
30019       responses:
30020         "default":
30021           description: Response codes found in [response codes](https://wiki.onap.org/).
30022       parameters:
30023         - name: network-id
30024           in: path
30025           description: Network ID, should be uuid. Unique across A&AI.
30026           required: true
30027           type: string
30028           example: __NETWORK-ID__
30029         - name: subnet-id
30030           in: path
30031           description: Subnet ID, should be UUID.
30032           required: true
30033           type: string
30034           example: __SUBNET-ID__
30035         - name: host-route-id
30036           in: path
30037           description: host-route id
30038           required: true
30039           type: string
30040           example: __HOST-ROUTE-ID__
30041         - name: body
30042           in: body
30043           description: host-route object that needs to be updated.
30044           required: true
30045           schema:
30046             $ref: "#/patchDefinitions/host-route"
30047     delete:
30048       tags:
30049         - Network
30050       summary: delete an existing host-route
30051       description: delete an existing host-route
30052       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
30053       consumes:
30054         - application/json
30055         - application/xml
30056       produces:
30057         - application/json
30058         - application/xml
30059       responses:
30060         "default":
30061           description: Response codes found in [response codes](https://wiki.onap.org/).
30062       parameters:
30063         - name: network-id
30064           in: path
30065           description: Network ID, should be uuid. Unique across A&AI.
30066           required: true
30067           type: string
30068           example: __NETWORK-ID__
30069         - name: subnet-id
30070           in: path
30071           description: Subnet ID, should be UUID.
30072           required: true
30073           type: string
30074           example: __SUBNET-ID__
30075         - name: host-route-id
30076           in: path
30077           description: host-route id
30078           required: true
30079           type: string
30080           example: __HOST-ROUTE-ID__
30081         - name: resource-version
30082           in: query
30083           description: resource-version for concurrency
30084           required: true
30085           type: string
30086   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes:
30087     get:
30088       tags:
30089         - Network
30090       summary: returns host-routes
30091       description: returns host-routes
30092       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes
30093       produces:
30094         - application/json
30095         - application/xml
30096       responses:
30097         "200":
30098           description: successful operation
30099           schema:
30100               $ref: "#/getDefinitions/host-routes"
30101         "default":
30102           description: Response codes found in [response codes](https://wiki.onap.org/).
30103       parameters:
30104         - name: network-id
30105           in: path
30106           description: Network ID, should be uuid. Unique across A&AI.
30107           required: true
30108           type: string
30109           example: __NETWORK-ID__
30110         - name: subnet-id
30111           in: path
30112           description: Subnet ID, should be UUID.
30113           required: true
30114           type: string
30115           example: __SUBNET-ID__
30116         - name: host-route-id
30117           in: query
30118           description:
30119           required: false
30120           type: string
30121   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
30122     put:
30123       tags:
30124         - Network
30125       summary: see node definition for valid relationships
30126       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
30127       consumes:
30128         - application/json
30129         - application/xml
30130       produces:
30131         - application/json
30132         - application/xml
30133       responses:
30134         "default":
30135           description: Response codes found in [response codes](https://wiki.onap.org/).
30136       parameters:
30137         - name: network-id
30138           in: path
30139           description: Network ID, should be uuid. Unique across A&AI.
30140           required: true
30141           type: string
30142           example: __NETWORK-ID__
30143         - name: subnet-id
30144           in: path
30145           description: Subnet ID, should be UUID.
30146           required: true
30147           type: string
30148           example: __SUBNET-ID__
30149         - name: body
30150           in: body
30151           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
30152           required: true
30153           schema:
30154             $ref: "#/definitions/relationship"
30155     delete:
30156       tags:
30157         - Network
30158       summary: delete an existing relationship
30159       description: delete an existing relationship
30160       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
30161       consumes:
30162         - application/json
30163         - application/xml
30164       produces:
30165         - application/json
30166         - application/xml
30167       responses:
30168         "default":
30169           description: Response codes found in [response codes](https://wiki.onap.org/).
30170       parameters:
30171         - name: network-id
30172           in: path
30173           description: Network ID, should be uuid. Unique across A&AI.
30174           required: true
30175           type: string
30176           example: __NETWORK-ID__
30177         - name: subnet-id
30178           in: path
30179           description: Subnet ID, should be UUID.
30180           required: true
30181           type: string
30182           example: __SUBNET-ID__
30183   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
30184     get:
30185       tags:
30186         - Network
30187       summary: returns subnet
30188       description: returns subnet
30189       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
30190       produces:
30191         - application/json
30192         - application/xml
30193       responses:
30194         "200":
30195           description: successful operation
30196           schema:
30197               $ref: "#/getDefinitions/subnet"
30198         "default":
30199           description: Response codes found in [response codes](https://wiki.onap.org/).
30200       parameters:
30201         - name: network-id
30202           in: path
30203           description: Network ID, should be uuid. Unique across A&AI.
30204           required: true
30205           type: string
30206           example: __NETWORK-ID__
30207         - name: subnet-id
30208           in: path
30209           description: Subnet ID, should be UUID.
30210           required: true
30211           type: string
30212           example: __SUBNET-ID__
30213     put:
30214       tags:
30215         - Network
30216       summary: create or update an existing subnet
30217       description: |
30218         Create or update an existing subnet.
30219         #
30220         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30221       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
30222       consumes:
30223         - application/json
30224         - application/xml
30225       produces:
30226         - application/json
30227         - application/xml
30228       responses:
30229         "default":
30230           description: Response codes found in [response codes](https://wiki.onap.org/).
30231       parameters:
30232         - name: network-id
30233           in: path
30234           description: Network ID, should be uuid. Unique across A&AI.
30235           required: true
30236           type: string
30237           example: __NETWORK-ID__
30238         - name: subnet-id
30239           in: path
30240           description: Subnet ID, should be UUID.
30241           required: true
30242           type: string
30243           example: __SUBNET-ID__
30244         - name: body
30245           in: body
30246           description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
30247           required: true
30248           schema:
30249             $ref: "#/definitions/subnet"
30250     patch:
30251       tags:
30252         - Network
30253       summary: update an existing subnet
30254       description: |
30255         Update an existing subnet
30256         #
30257         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30258         The PUT operation will entirely replace an existing object.
30259         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30260         #
30261         Other differences between PUT and PATCH are:
30262         #
30263         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30264         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30265         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30266       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
30267       consumes:
30268         - application/json
30269         - application/xml
30270       produces:
30271         - application/json
30272         - application/xml
30273       responses:
30274         "default":
30275           description: Response codes found in [response codes](https://wiki.onap.org/).
30276       parameters:
30277         - name: network-id
30278           in: path
30279           description: Network ID, should be uuid. Unique across A&AI.
30280           required: true
30281           type: string
30282           example: __NETWORK-ID__
30283         - name: subnet-id
30284           in: path
30285           description: Subnet ID, should be UUID.
30286           required: true
30287           type: string
30288           example: __SUBNET-ID__
30289         - name: body
30290           in: body
30291           description: subnet object that needs to be updated.
30292           required: true
30293           schema:
30294             $ref: "#/patchDefinitions/subnet"
30295     delete:
30296       tags:
30297         - Network
30298       summary: delete an existing subnet
30299       description: delete an existing subnet
30300       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
30301       consumes:
30302         - application/json
30303         - application/xml
30304       produces:
30305         - application/json
30306         - application/xml
30307       responses:
30308         "default":
30309           description: Response codes found in [response codes](https://wiki.onap.org/).
30310       parameters:
30311         - name: network-id
30312           in: path
30313           description: Network ID, should be uuid. Unique across A&AI.
30314           required: true
30315           type: string
30316           example: __NETWORK-ID__
30317         - name: subnet-id
30318           in: path
30319           description: Subnet ID, should be UUID.
30320           required: true
30321           type: string
30322           example: __SUBNET-ID__
30323         - name: resource-version
30324           in: query
30325           description: resource-version for concurrency
30326           required: true
30327           type: string
30328   /network/l3-networks/l3-network/{network-id}/subnets:
30329     get:
30330       tags:
30331         - Network
30332       summary: returns subnets
30333       description: returns subnets
30334       operationId: getNetworkL3NetworksL3NetworkSubnets
30335       produces:
30336         - application/json
30337         - application/xml
30338       responses:
30339         "200":
30340           description: successful operation
30341           schema:
30342               $ref: "#/getDefinitions/subnets"
30343         "default":
30344           description: Response codes found in [response codes](https://wiki.onap.org/).
30345       parameters:
30346         - name: network-id
30347           in: path
30348           description: Network ID, should be uuid. Unique across A&AI.
30349           required: true
30350           type: string
30351           example: __NETWORK-ID__
30352         - name: subnet-id
30353           in: query
30354           description:
30355           required: false
30356           type: string
30357         - name: subnet-name
30358           in: query
30359           description:
30360           required: false
30361           type: string
30362   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
30363     put:
30364       tags:
30365         - Network
30366       summary: see node definition for valid relationships
30367       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
30368       consumes:
30369         - application/json
30370         - application/xml
30371       produces:
30372         - application/json
30373         - application/xml
30374       responses:
30375         "default":
30376           description: Response codes found in [response codes](https://wiki.onap.org/).
30377       parameters:
30378         - name: network-id
30379           in: path
30380           description: Network ID, should be uuid. Unique across A&AI.
30381           required: true
30382           type: string
30383           example: __NETWORK-ID__
30384         - name: vlan-id-inner
30385           in: path
30386           description: id.
30387           required: true
30388           type: integer
30389           format: int64
30390           example: __VLAN-ID-INNER__
30391         - name: body
30392           in: body
30393           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
30394           required: true
30395           schema:
30396             $ref: "#/definitions/relationship"
30397     delete:
30398       tags:
30399         - Network
30400       summary: delete an existing relationship
30401       description: delete an existing relationship
30402       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
30403       consumes:
30404         - application/json
30405         - application/xml
30406       produces:
30407         - application/json
30408         - application/xml
30409       responses:
30410         "default":
30411           description: Response codes found in [response codes](https://wiki.onap.org/).
30412       parameters:
30413         - name: network-id
30414           in: path
30415           description: Network ID, should be uuid. Unique across A&AI.
30416           required: true
30417           type: string
30418           example: __NETWORK-ID__
30419         - name: vlan-id-inner
30420           in: path
30421           description: id.
30422           required: true
30423           type: integer
30424           format: int64
30425           example: __VLAN-ID-INNER__
30426   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
30427     get:
30428       tags:
30429         - Network
30430       summary: returns ctag-assignment
30431       description: returns ctag-assignment
30432       operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30433       produces:
30434         - application/json
30435         - application/xml
30436       responses:
30437         "200":
30438           description: successful operation
30439           schema:
30440               $ref: "#/getDefinitions/ctag-assignment"
30441         "default":
30442           description: Response codes found in [response codes](https://wiki.onap.org/).
30443       parameters:
30444         - name: network-id
30445           in: path
30446           description: Network ID, should be uuid. Unique across A&AI.
30447           required: true
30448           type: string
30449           example: __NETWORK-ID__
30450         - name: vlan-id-inner
30451           in: path
30452           description: id.
30453           required: true
30454           type: integer
30455           format: int64
30456           example: __VLAN-ID-INNER__
30457     put:
30458       tags:
30459         - Network
30460       summary: create or update an existing ctag-assignment
30461       description: |
30462         Create or update an existing ctag-assignment.
30463         #
30464         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30465       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30466       consumes:
30467         - application/json
30468         - application/xml
30469       produces:
30470         - application/json
30471         - application/xml
30472       responses:
30473         "default":
30474           description: Response codes found in [response codes](https://wiki.onap.org/).
30475       parameters:
30476         - name: network-id
30477           in: path
30478           description: Network ID, should be uuid. Unique across A&AI.
30479           required: true
30480           type: string
30481           example: __NETWORK-ID__
30482         - name: vlan-id-inner
30483           in: path
30484           description: id.
30485           required: true
30486           type: integer
30487           format: int64
30488           example: __VLAN-ID-INNER__
30489         - name: body
30490           in: body
30491           description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
30492           required: true
30493           schema:
30494             $ref: "#/definitions/ctag-assignment"
30495     patch:
30496       tags:
30497         - Network
30498       summary: update an existing ctag-assignment
30499       description: |
30500         Update an existing ctag-assignment
30501         #
30502         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30503         The PUT operation will entirely replace an existing object.
30504         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30505         #
30506         Other differences between PUT and PATCH are:
30507         #
30508         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30509         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30510         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30511       operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30512       consumes:
30513         - application/json
30514         - application/xml
30515       produces:
30516         - application/json
30517         - application/xml
30518       responses:
30519         "default":
30520           description: Response codes found in [response codes](https://wiki.onap.org/).
30521       parameters:
30522         - name: network-id
30523           in: path
30524           description: Network ID, should be uuid. Unique across A&AI.
30525           required: true
30526           type: string
30527           example: __NETWORK-ID__
30528         - name: vlan-id-inner
30529           in: path
30530           description: id.
30531           required: true
30532           type: integer
30533           format: int64
30534           example: __VLAN-ID-INNER__
30535         - name: body
30536           in: body
30537           description: ctag-assignment object that needs to be updated.
30538           required: true
30539           schema:
30540             $ref: "#/patchDefinitions/ctag-assignment"
30541     delete:
30542       tags:
30543         - Network
30544       summary: delete an existing ctag-assignment
30545       description: delete an existing ctag-assignment
30546       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30547       consumes:
30548         - application/json
30549         - application/xml
30550       produces:
30551         - application/json
30552         - application/xml
30553       responses:
30554         "default":
30555           description: Response codes found in [response codes](https://wiki.onap.org/).
30556       parameters:
30557         - name: network-id
30558           in: path
30559           description: Network ID, should be uuid. Unique across A&AI.
30560           required: true
30561           type: string
30562           example: __NETWORK-ID__
30563         - name: vlan-id-inner
30564           in: path
30565           description: id.
30566           required: true
30567           type: integer
30568           format: int64
30569           example: __VLAN-ID-INNER__
30570         - name: resource-version
30571           in: query
30572           description: resource-version for concurrency
30573           required: true
30574           type: string
30575   /network/l3-networks/l3-network/{network-id}/ctag-assignments:
30576     get:
30577       tags:
30578         - Network
30579       summary: returns ctag-assignments
30580       description: returns ctag-assignments
30581       operationId: getNetworkL3NetworksL3NetworkCtagAssignments
30582       produces:
30583         - application/json
30584         - application/xml
30585       responses:
30586         "200":
30587           description: successful operation
30588           schema:
30589               $ref: "#/getDefinitions/ctag-assignments"
30590         "default":
30591           description: Response codes found in [response codes](https://wiki.onap.org/).
30592       parameters:
30593         - name: network-id
30594           in: path
30595           description: Network ID, should be uuid. Unique across A&AI.
30596           required: true
30597           type: string
30598           example: __NETWORK-ID__
30599         - name: vlan-id-inner
30600           in: query
30601           description:
30602           required: false
30603           type: integer
30604           format: int64
30605   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
30606     put:
30607       tags:
30608         - Network
30609       summary: see node definition for valid relationships
30610       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
30611       consumes:
30612         - application/json
30613         - application/xml
30614       produces:
30615         - application/json
30616         - application/xml
30617       responses:
30618         "default":
30619           description: Response codes found in [response codes](https://wiki.onap.org/).
30620       parameters:
30621         - name: network-id
30622           in: path
30623           description: Network ID, should be uuid. Unique across A&AI.
30624           required: true
30625           type: string
30626           example: __NETWORK-ID__
30627         - name: segmentation-id
30628           in: path
30629           description: Route Table Reference id, UUID assigned to this instance.
30630           required: true
30631           type: string
30632           example: __SEGMENTATION-ID__
30633         - name: body
30634           in: body
30635           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
30636           required: true
30637           schema:
30638             $ref: "#/definitions/relationship"
30639     delete:
30640       tags:
30641         - Network
30642       summary: delete an existing relationship
30643       description: delete an existing relationship
30644       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
30645       consumes:
30646         - application/json
30647         - application/xml
30648       produces:
30649         - application/json
30650         - application/xml
30651       responses:
30652         "default":
30653           description: Response codes found in [response codes](https://wiki.onap.org/).
30654       parameters:
30655         - name: network-id
30656           in: path
30657           description: Network ID, should be uuid. Unique across A&AI.
30658           required: true
30659           type: string
30660           example: __NETWORK-ID__
30661         - name: segmentation-id
30662           in: path
30663           description: Route Table Reference id, UUID assigned to this instance.
30664           required: true
30665           type: string
30666           example: __SEGMENTATION-ID__
30667   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
30668     get:
30669       tags:
30670         - Network
30671       summary: returns segmentation-assignment
30672       description: returns segmentation-assignment
30673       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30674       produces:
30675         - application/json
30676         - application/xml
30677       responses:
30678         "200":
30679           description: successful operation
30680           schema:
30681               $ref: "#/getDefinitions/segmentation-assignment"
30682         "default":
30683           description: Response codes found in [response codes](https://wiki.onap.org/).
30684       parameters:
30685         - name: network-id
30686           in: path
30687           description: Network ID, should be uuid. Unique across A&AI.
30688           required: true
30689           type: string
30690           example: __NETWORK-ID__
30691         - name: segmentation-id
30692           in: path
30693           description: Route Table Reference id, UUID assigned to this instance.
30694           required: true
30695           type: string
30696           example: __SEGMENTATION-ID__
30697     put:
30698       tags:
30699         - Network
30700       summary: create or update an existing segmentation-assignment
30701       description: |
30702         Create or update an existing segmentation-assignment.
30703         #
30704         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30705       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30706       consumes:
30707         - application/json
30708         - application/xml
30709       produces:
30710         - application/json
30711         - application/xml
30712       responses:
30713         "default":
30714           description: Response codes found in [response codes](https://wiki.onap.org/).
30715       parameters:
30716         - name: network-id
30717           in: path
30718           description: Network ID, should be uuid. Unique across A&AI.
30719           required: true
30720           type: string
30721           example: __NETWORK-ID__
30722         - name: segmentation-id
30723           in: path
30724           description: Route Table Reference id, UUID assigned to this instance.
30725           required: true
30726           type: string
30727           example: __SEGMENTATION-ID__
30728         - name: body
30729           in: body
30730           description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
30731           required: true
30732           schema:
30733             $ref: "#/definitions/segmentation-assignment"
30734     patch:
30735       tags:
30736         - Network
30737       summary: update an existing segmentation-assignment
30738       description: |
30739         Update an existing segmentation-assignment
30740         #
30741         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30742         The PUT operation will entirely replace an existing object.
30743         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30744         #
30745         Other differences between PUT and PATCH are:
30746         #
30747         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30748         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30749         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30750       operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30751       consumes:
30752         - application/json
30753         - application/xml
30754       produces:
30755         - application/json
30756         - application/xml
30757       responses:
30758         "default":
30759           description: Response codes found in [response codes](https://wiki.onap.org/).
30760       parameters:
30761         - name: network-id
30762           in: path
30763           description: Network ID, should be uuid. Unique across A&AI.
30764           required: true
30765           type: string
30766           example: __NETWORK-ID__
30767         - name: segmentation-id
30768           in: path
30769           description: Route Table Reference id, UUID assigned to this instance.
30770           required: true
30771           type: string
30772           example: __SEGMENTATION-ID__
30773         - name: body
30774           in: body
30775           description: segmentation-assignment object that needs to be updated.
30776           required: true
30777           schema:
30778             $ref: "#/patchDefinitions/segmentation-assignment"
30779     delete:
30780       tags:
30781         - Network
30782       summary: delete an existing segmentation-assignment
30783       description: delete an existing segmentation-assignment
30784       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30785       consumes:
30786         - application/json
30787         - application/xml
30788       produces:
30789         - application/json
30790         - application/xml
30791       responses:
30792         "default":
30793           description: Response codes found in [response codes](https://wiki.onap.org/).
30794       parameters:
30795         - name: network-id
30796           in: path
30797           description: Network ID, should be uuid. Unique across A&AI.
30798           required: true
30799           type: string
30800           example: __NETWORK-ID__
30801         - name: segmentation-id
30802           in: path
30803           description: Route Table Reference id, UUID assigned to this instance.
30804           required: true
30805           type: string
30806           example: __SEGMENTATION-ID__
30807         - name: resource-version
30808           in: query
30809           description: resource-version for concurrency
30810           required: true
30811           type: string
30812   /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
30813     get:
30814       tags:
30815         - Network
30816       summary: returns segmentation-assignments
30817       description: returns segmentation-assignments
30818       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
30819       produces:
30820         - application/json
30821         - application/xml
30822       responses:
30823         "200":
30824           description: successful operation
30825           schema:
30826               $ref: "#/getDefinitions/segmentation-assignments"
30827         "default":
30828           description: Response codes found in [response codes](https://wiki.onap.org/).
30829       parameters:
30830         - name: network-id
30831           in: path
30832           description: Network ID, should be uuid. Unique across A&AI.
30833           required: true
30834           type: string
30835           example: __NETWORK-ID__
30836         - name: segmentation-id
30837           in: query
30838           description:
30839           required: false
30840           type: string
30841   /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
30842     put:
30843       tags:
30844         - Network
30845       summary: see node definition for valid relationships
30846       operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
30847       consumes:
30848         - application/json
30849         - application/xml
30850       produces:
30851         - application/json
30852         - application/xml
30853       responses:
30854         "default":
30855           description: Response codes found in [response codes](https://wiki.onap.org/).
30856       parameters:
30857         - name: network-id
30858           in: path
30859           description: Network ID, should be uuid. Unique across A&AI.
30860           required: true
30861           type: string
30862           example: __NETWORK-ID__
30863         - name: body
30864           in: body
30865           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json)
30866           required: true
30867           schema:
30868             $ref: "#/definitions/relationship"
30869     delete:
30870       tags:
30871         - Network
30872       summary: delete an existing relationship
30873       description: delete an existing relationship
30874       operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
30875       consumes:
30876         - application/json
30877         - application/xml
30878       produces:
30879         - application/json
30880         - application/xml
30881       responses:
30882         "default":
30883           description: Response codes found in [response codes](https://wiki.onap.org/).
30884       parameters:
30885         - name: network-id
30886           in: path
30887           description: Network ID, should be uuid. Unique across A&AI.
30888           required: true
30889           type: string
30890           example: __NETWORK-ID__
30891   /network/l3-networks/l3-network/{network-id}:
30892     get:
30893       tags:
30894         - Network
30895       summary: returns l3-network
30896       description: returns l3-network
30897       operationId: getNetworkL3NetworksL3Network
30898       produces:
30899         - application/json
30900         - application/xml
30901       responses:
30902         "200":
30903           description: successful operation
30904           schema:
30905               $ref: "#/getDefinitions/l3-network"
30906         "default":
30907           description: Response codes found in [response codes](https://wiki.onap.org/).
30908       parameters:
30909         - name: network-id
30910           in: path
30911           description: Network ID, should be uuid. Unique across A&AI.
30912           required: true
30913           type: string
30914           example: __NETWORK-ID__
30915     put:
30916       tags:
30917         - Network
30918       summary: create or update an existing l3-network
30919       description: |
30920         Create or update an existing l3-network.
30921         #
30922         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30923       operationId: createOrUpdateNetworkL3NetworksL3Network
30924       consumes:
30925         - application/json
30926         - application/xml
30927       produces:
30928         - application/json
30929         - application/xml
30930       responses:
30931         "default":
30932           description: Response codes found in [response codes](https://wiki.onap.org/).
30933       parameters:
30934         - name: network-id
30935           in: path
30936           description: Network ID, should be uuid. Unique across A&AI.
30937           required: true
30938           type: string
30939           example: __NETWORK-ID__
30940         - name: body
30941           in: body
30942           description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json)
30943           required: true
30944           schema:
30945             $ref: "#/definitions/l3-network"
30946     patch:
30947       tags:
30948         - Network
30949       summary: update an existing l3-network
30950       description: |
30951         Update an existing l3-network
30952         #
30953         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30954         The PUT operation will entirely replace an existing object.
30955         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30956         #
30957         Other differences between PUT and PATCH are:
30958         #
30959         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30960         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30961         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30962       operationId: UpdateNetworkL3NetworksL3Network
30963       consumes:
30964         - application/json
30965         - application/xml
30966       produces:
30967         - application/json
30968         - application/xml
30969       responses:
30970         "default":
30971           description: Response codes found in [response codes](https://wiki.onap.org/).
30972       parameters:
30973         - name: network-id
30974           in: path
30975           description: Network ID, should be uuid. Unique across A&AI.
30976           required: true
30977           type: string
30978           example: __NETWORK-ID__
30979         - name: body
30980           in: body
30981           description: l3-network object that needs to be updated.
30982           required: true
30983           schema:
30984             $ref: "#/patchDefinitions/l3-network"
30985     delete:
30986       tags:
30987         - Network
30988       summary: delete an existing l3-network
30989       description: delete an existing l3-network
30990       operationId: deleteNetworkL3NetworksL3Network
30991       consumes:
30992         - application/json
30993         - application/xml
30994       produces:
30995         - application/json
30996         - application/xml
30997       responses:
30998         "default":
30999           description: Response codes found in [response codes](https://wiki.onap.org/).
31000       parameters:
31001         - name: network-id
31002           in: path
31003           description: Network ID, should be uuid. Unique across A&AI.
31004           required: true
31005           type: string
31006           example: __NETWORK-ID__
31007         - name: resource-version
31008           in: query
31009           description: resource-version for concurrency
31010           required: true
31011           type: string
31012   /network/l3-networks:
31013     get:
31014       tags:
31015         - Network
31016       summary: returns l3-networks
31017       description: returns l3-networks
31018       operationId: getNetworkL3Networks
31019       produces:
31020         - application/json
31021         - application/xml
31022       responses:
31023         "200":
31024           description: successful operation
31025           schema:
31026               $ref: "#/getDefinitions/l3-networks"
31027         "default":
31028           description: Response codes found in [response codes](https://wiki.onap.org/).
31029       parameters:
31030         - name: network-id
31031           in: query
31032           description:
31033           required: false
31034           type: string
31035         - name: network-name
31036           in: query
31037           description:
31038           required: false
31039           type: string
31040         - name: network-role
31041           in: query
31042           description:
31043           required: false
31044           type: string
31045         - name: service-id
31046           in: query
31047           description:
31048           required: false
31049           type: string
31050         - name: heat-stack-id
31051           in: query
31052           description:
31053           required: false
31054           type: string
31055         - name: contrail-network-fqdn
31056           in: query
31057           description:
31058           required: false
31059           type: string
31060         - name: model-invariant-id
31061           in: query
31062           description:
31063           required: false
31064           type: string
31065         - name: model-version-id
31066           in: query
31067           description:
31068           required: false
31069           type: string
31070         - name: widget-model-id
31071           in: query
31072           description:
31073           required: false
31074           type: string
31075         - name: widget-model-version
31076           in: query
31077           description:
31078           required: false
31079           type: string
31080   /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
31081     put:
31082       tags:
31083         - Network
31084       summary: see node definition for valid relationships
31085       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
31086       consumes:
31087         - application/json
31088         - application/xml
31089       produces:
31090         - application/json
31091         - application/xml
31092       responses:
31093         "default":
31094           description: Response codes found in [response codes](https://wiki.onap.org/).
31095       parameters:
31096         - name: network-policy-id
31097           in: path
31098           description: UUID representing unique key to this instance
31099           required: true
31100           type: string
31101           example: __NETWORK-POLICY-ID__
31102         - name: body
31103           in: body
31104           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json)
31105           required: true
31106           schema:
31107             $ref: "#/definitions/relationship"
31108     delete:
31109       tags:
31110         - Network
31111       summary: delete an existing relationship
31112       description: delete an existing relationship
31113       operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
31114       consumes:
31115         - application/json
31116         - application/xml
31117       produces:
31118         - application/json
31119         - application/xml
31120       responses:
31121         "default":
31122           description: Response codes found in [response codes](https://wiki.onap.org/).
31123       parameters:
31124         - name: network-policy-id
31125           in: path
31126           description: UUID representing unique key to this instance
31127           required: true
31128           type: string
31129           example: __NETWORK-POLICY-ID__
31130   /network/network-policies/network-policy/{network-policy-id}:
31131     get:
31132       tags:
31133         - Network
31134       summary: returns network-policy
31135       description: returns network-policy
31136       operationId: getNetworkNetworkPoliciesNetworkPolicy
31137       produces:
31138         - application/json
31139         - application/xml
31140       responses:
31141         "200":
31142           description: successful operation
31143           schema:
31144               $ref: "#/getDefinitions/network-policy"
31145         "default":
31146           description: Response codes found in [response codes](https://wiki.onap.org/).
31147       parameters:
31148         - name: network-policy-id
31149           in: path
31150           description: UUID representing unique key to this instance
31151           required: true
31152           type: string
31153           example: __NETWORK-POLICY-ID__
31154     put:
31155       tags:
31156         - Network
31157       summary: create or update an existing network-policy
31158       description: |
31159         Create or update an existing network-policy.
31160         #
31161         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31162       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
31163       consumes:
31164         - application/json
31165         - application/xml
31166       produces:
31167         - application/json
31168         - application/xml
31169       responses:
31170         "default":
31171           description: Response codes found in [response codes](https://wiki.onap.org/).
31172       parameters:
31173         - name: network-policy-id
31174           in: path
31175           description: UUID representing unique key to this instance
31176           required: true
31177           type: string
31178           example: __NETWORK-POLICY-ID__
31179         - name: body
31180           in: body
31181           description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json)
31182           required: true
31183           schema:
31184             $ref: "#/definitions/network-policy"
31185     patch:
31186       tags:
31187         - Network
31188       summary: update an existing network-policy
31189       description: |
31190         Update an existing network-policy
31191         #
31192         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31193         The PUT operation will entirely replace an existing object.
31194         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31195         #
31196         Other differences between PUT and PATCH are:
31197         #
31198         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31199         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31200         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31201       operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
31202       consumes:
31203         - application/json
31204         - application/xml
31205       produces:
31206         - application/json
31207         - application/xml
31208       responses:
31209         "default":
31210           description: Response codes found in [response codes](https://wiki.onap.org/).
31211       parameters:
31212         - name: network-policy-id
31213           in: path
31214           description: UUID representing unique key to this instance
31215           required: true
31216           type: string
31217           example: __NETWORK-POLICY-ID__
31218         - name: body
31219           in: body
31220           description: network-policy object that needs to be updated.
31221           required: true
31222           schema:
31223             $ref: "#/patchDefinitions/network-policy"
31224     delete:
31225       tags:
31226         - Network
31227       summary: delete an existing network-policy
31228       description: delete an existing network-policy
31229       operationId: deleteNetworkNetworkPoliciesNetworkPolicy
31230       consumes:
31231         - application/json
31232         - application/xml
31233       produces:
31234         - application/json
31235         - application/xml
31236       responses:
31237         "default":
31238           description: Response codes found in [response codes](https://wiki.onap.org/).
31239       parameters:
31240         - name: network-policy-id
31241           in: path
31242           description: UUID representing unique key to this instance
31243           required: true
31244           type: string
31245           example: __NETWORK-POLICY-ID__
31246         - name: resource-version
31247           in: query
31248           description: resource-version for concurrency
31249           required: true
31250           type: string
31251   /network/network-policies:
31252     get:
31253       tags:
31254         - Network
31255       summary: returns network-policies
31256       description: returns network-policies
31257       operationId: getNetworkNetworkPolicies
31258       produces:
31259         - application/json
31260         - application/xml
31261       responses:
31262         "200":
31263           description: successful operation
31264           schema:
31265               $ref: "#/getDefinitions/network-policies"
31266         "default":
31267           description: Response codes found in [response codes](https://wiki.onap.org/).
31268       parameters:
31269         - name: network-policy-id
31270           in: query
31271           description:
31272           required: false
31273           type: string
31274         - name: network-policy-fqdn
31275           in: query
31276           description:
31277           required: false
31278           type: string
31279   /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
31280     put:
31281       tags:
31282         - Network
31283       summary: see node definition for valid relationships
31284       operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
31285       consumes:
31286         - application/json
31287         - application/xml
31288       produces:
31289         - application/json
31290         - application/xml
31291       responses:
31292         "default":
31293           description: Response codes found in [response codes](https://wiki.onap.org/).
31294       parameters:
31295         - name: vnf-id
31296           in: path
31297           description: Unique id of VNF.  This is unique across the graph.
31298           required: true
31299           type: string
31300           example: __VNF-ID__
31301         - name: body
31302           in: body
31303           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json)
31304           required: true
31305           schema:
31306             $ref: "#/definitions/relationship"
31307     delete:
31308       tags:
31309         - Network
31310       summary: delete an existing relationship
31311       description: delete an existing relationship
31312       operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
31313       consumes:
31314         - application/json
31315         - application/xml
31316       produces:
31317         - application/json
31318         - application/xml
31319       responses:
31320         "default":
31321           description: Response codes found in [response codes](https://wiki.onap.org/).
31322       parameters:
31323         - name: vnf-id
31324           in: path
31325           description: Unique id of VNF.  This is unique across the graph.
31326           required: true
31327           type: string
31328           example: __VNF-ID__
31329   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
31330     put:
31331       tags:
31332         - Network
31333       summary: see node definition for valid relationships
31334       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
31335       consumes:
31336         - application/json
31337         - application/xml
31338       produces:
31339         - application/json
31340         - application/xml
31341       responses:
31342         "default":
31343           description: Response codes found in [response codes](https://wiki.onap.org/).
31344       parameters:
31345         - name: vnf-id
31346           in: path
31347           description: Unique id of VNF.  This is unique across the graph.
31348           required: true
31349           type: string
31350           example: __VNF-ID__
31351         - name: interface-name
31352           in: path
31353           description: Name given to the interface
31354           required: true
31355           type: string
31356           example: __INTERFACE-NAME__
31357         - name: vlan-interface
31358           in: path
31359           description: String that identifies the interface
31360           required: true
31361           type: string
31362           example: __VLAN-INTERFACE__
31363         - name: body
31364           in: body
31365           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
31366           required: true
31367           schema:
31368             $ref: "#/definitions/relationship"
31369     delete:
31370       tags:
31371         - Network
31372       summary: delete an existing relationship
31373       description: delete an existing relationship
31374       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
31375       consumes:
31376         - application/json
31377         - application/xml
31378       produces:
31379         - application/json
31380         - application/xml
31381       responses:
31382         "default":
31383           description: Response codes found in [response codes](https://wiki.onap.org/).
31384       parameters:
31385         - name: vnf-id
31386           in: path
31387           description: Unique id of VNF.  This is unique across the graph.
31388           required: true
31389           type: string
31390           example: __VNF-ID__
31391         - name: interface-name
31392           in: path
31393           description: Name given to the interface
31394           required: true
31395           type: string
31396           example: __INTERFACE-NAME__
31397         - name: vlan-interface
31398           in: path
31399           description: String that identifies the interface
31400           required: true
31401           type: string
31402           example: __VLAN-INTERFACE__
31403   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
31404     put:
31405       tags:
31406         - Network
31407       summary: see node definition for valid relationships
31408       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
31409       consumes:
31410         - application/json
31411         - application/xml
31412       produces:
31413         - application/json
31414         - application/xml
31415       responses:
31416         "default":
31417           description: Response codes found in [response codes](https://wiki.onap.org/).
31418       parameters:
31419         - name: vnf-id
31420           in: path
31421           description: Unique id of VNF.  This is unique across the graph.
31422           required: true
31423           type: string
31424           example: __VNF-ID__
31425         - name: interface-name
31426           in: path
31427           description: Name given to the interface
31428           required: true
31429           type: string
31430           example: __INTERFACE-NAME__
31431         - name: vlan-interface
31432           in: path
31433           description: String that identifies the interface
31434           required: true
31435           type: string
31436           example: __VLAN-INTERFACE__
31437         - name: l3-interface-ipv4-address
31438           in: path
31439           description: IP address
31440           required: true
31441           type: string
31442           example: __L3-INTERFACE-IPV4-ADDRESS__
31443         - name: body
31444           in: body
31445           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
31446           required: true
31447           schema:
31448             $ref: "#/definitions/relationship"
31449     delete:
31450       tags:
31451         - Network
31452       summary: delete an existing relationship
31453       description: delete an existing relationship
31454       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
31455       consumes:
31456         - application/json
31457         - application/xml
31458       produces:
31459         - application/json
31460         - application/xml
31461       responses:
31462         "default":
31463           description: Response codes found in [response codes](https://wiki.onap.org/).
31464       parameters:
31465         - name: vnf-id
31466           in: path
31467           description: Unique id of VNF.  This is unique across the graph.
31468           required: true
31469           type: string
31470           example: __VNF-ID__
31471         - name: interface-name
31472           in: path
31473           description: Name given to the interface
31474           required: true
31475           type: string
31476           example: __INTERFACE-NAME__
31477         - name: vlan-interface
31478           in: path
31479           description: String that identifies the interface
31480           required: true
31481           type: string
31482           example: __VLAN-INTERFACE__
31483         - name: l3-interface-ipv4-address
31484           in: path
31485           description: IP address
31486           required: true
31487           type: string
31488           example: __L3-INTERFACE-IPV4-ADDRESS__
31489   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
31490     get:
31491       tags:
31492         - Network
31493       summary: returns l3-interface-ipv4-address-list
31494       description: returns l3-interface-ipv4-address-list
31495       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31496       produces:
31497         - application/json
31498         - application/xml
31499       responses:
31500         "200":
31501           description: successful operation
31502           schema:
31503               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
31504         "default":
31505           description: Response codes found in [response codes](https://wiki.onap.org/).
31506       parameters:
31507         - name: vnf-id
31508           in: path
31509           description: Unique id of VNF.  This is unique across the graph.
31510           required: true
31511           type: string
31512           example: __VNF-ID__
31513         - name: interface-name
31514           in: path
31515           description: Name given to the interface
31516           required: true
31517           type: string
31518           example: __INTERFACE-NAME__
31519         - name: vlan-interface
31520           in: path
31521           description: String that identifies the interface
31522           required: true
31523           type: string
31524           example: __VLAN-INTERFACE__
31525         - name: l3-interface-ipv4-address
31526           in: path
31527           description: IP address
31528           required: true
31529           type: string
31530           example: __L3-INTERFACE-IPV4-ADDRESS__
31531     put:
31532       tags:
31533         - Network
31534       summary: create or update an existing l3-interface-ipv4-address-list
31535       description: |
31536         Create or update an existing l3-interface-ipv4-address-list.
31537         #
31538         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31539       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31540       consumes:
31541         - application/json
31542         - application/xml
31543       produces:
31544         - application/json
31545         - application/xml
31546       responses:
31547         "default":
31548           description: Response codes found in [response codes](https://wiki.onap.org/).
31549       parameters:
31550         - name: vnf-id
31551           in: path
31552           description: Unique id of VNF.  This is unique across the graph.
31553           required: true
31554           type: string
31555           example: __VNF-ID__
31556         - name: interface-name
31557           in: path
31558           description: Name given to the interface
31559           required: true
31560           type: string
31561           example: __INTERFACE-NAME__
31562         - name: vlan-interface
31563           in: path
31564           description: String that identifies the interface
31565           required: true
31566           type: string
31567           example: __VLAN-INTERFACE__
31568         - name: l3-interface-ipv4-address
31569           in: path
31570           description: IP address
31571           required: true
31572           type: string
31573           example: __L3-INTERFACE-IPV4-ADDRESS__
31574         - name: body
31575           in: body
31576           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
31577           required: true
31578           schema:
31579             $ref: "#/definitions/l3-interface-ipv4-address-list"
31580     patch:
31581       tags:
31582         - Network
31583       summary: update an existing l3-interface-ipv4-address-list
31584       description: |
31585         Update an existing l3-interface-ipv4-address-list
31586         #
31587         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31588         The PUT operation will entirely replace an existing object.
31589         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31590         #
31591         Other differences between PUT and PATCH are:
31592         #
31593         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31594         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31595         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31596       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31597       consumes:
31598         - application/json
31599         - application/xml
31600       produces:
31601         - application/json
31602         - application/xml
31603       responses:
31604         "default":
31605           description: Response codes found in [response codes](https://wiki.onap.org/).
31606       parameters:
31607         - name: vnf-id
31608           in: path
31609           description: Unique id of VNF.  This is unique across the graph.
31610           required: true
31611           type: string
31612           example: __VNF-ID__
31613         - name: interface-name
31614           in: path
31615           description: Name given to the interface
31616           required: true
31617           type: string
31618           example: __INTERFACE-NAME__
31619         - name: vlan-interface
31620           in: path
31621           description: String that identifies the interface
31622           required: true
31623           type: string
31624           example: __VLAN-INTERFACE__
31625         - name: l3-interface-ipv4-address
31626           in: path
31627           description: IP address
31628           required: true
31629           type: string
31630           example: __L3-INTERFACE-IPV4-ADDRESS__
31631         - name: body
31632           in: body
31633           description: l3-interface-ipv4-address-list object that needs to be updated.
31634           required: true
31635           schema:
31636             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
31637     delete:
31638       tags:
31639         - Network
31640       summary: delete an existing l3-interface-ipv4-address-list
31641       description: delete an existing l3-interface-ipv4-address-list
31642       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31643       consumes:
31644         - application/json
31645         - application/xml
31646       produces:
31647         - application/json
31648         - application/xml
31649       responses:
31650         "default":
31651           description: Response codes found in [response codes](https://wiki.onap.org/).
31652       parameters:
31653         - name: vnf-id
31654           in: path
31655           description: Unique id of VNF.  This is unique across the graph.
31656           required: true
31657           type: string
31658           example: __VNF-ID__
31659         - name: interface-name
31660           in: path
31661           description: Name given to the interface
31662           required: true
31663           type: string
31664           example: __INTERFACE-NAME__
31665         - name: vlan-interface
31666           in: path
31667           description: String that identifies the interface
31668           required: true
31669           type: string
31670           example: __VLAN-INTERFACE__
31671         - name: l3-interface-ipv4-address
31672           in: path
31673           description: IP address
31674           required: true
31675           type: string
31676           example: __L3-INTERFACE-IPV4-ADDRESS__
31677         - name: resource-version
31678           in: query
31679           description: resource-version for concurrency
31680           required: true
31681           type: string
31682   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
31683     put:
31684       tags:
31685         - Network
31686       summary: see node definition for valid relationships
31687       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31688       consumes:
31689         - application/json
31690         - application/xml
31691       produces:
31692         - application/json
31693         - application/xml
31694       responses:
31695         "default":
31696           description: Response codes found in [response codes](https://wiki.onap.org/).
31697       parameters:
31698         - name: vnf-id
31699           in: path
31700           description: Unique id of VNF.  This is unique across the graph.
31701           required: true
31702           type: string
31703           example: __VNF-ID__
31704         - name: interface-name
31705           in: path
31706           description: Name given to the interface
31707           required: true
31708           type: string
31709           example: __INTERFACE-NAME__
31710         - name: vlan-interface
31711           in: path
31712           description: String that identifies the interface
31713           required: true
31714           type: string
31715           example: __VLAN-INTERFACE__
31716         - name: l3-interface-ipv6-address
31717           in: path
31718           description: IP address
31719           required: true
31720           type: string
31721           example: __L3-INTERFACE-IPV6-ADDRESS__
31722         - name: body
31723           in: body
31724           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31725           required: true
31726           schema:
31727             $ref: "#/definitions/relationship"
31728     delete:
31729       tags:
31730         - Network
31731       summary: delete an existing relationship
31732       description: delete an existing relationship
31733       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31734       consumes:
31735         - application/json
31736         - application/xml
31737       produces:
31738         - application/json
31739         - application/xml
31740       responses:
31741         "default":
31742           description: Response codes found in [response codes](https://wiki.onap.org/).
31743       parameters:
31744         - name: vnf-id
31745           in: path
31746           description: Unique id of VNF.  This is unique across the graph.
31747           required: true
31748           type: string
31749           example: __VNF-ID__
31750         - name: interface-name
31751           in: path
31752           description: Name given to the interface
31753           required: true
31754           type: string
31755           example: __INTERFACE-NAME__
31756         - name: vlan-interface
31757           in: path
31758           description: String that identifies the interface
31759           required: true
31760           type: string
31761           example: __VLAN-INTERFACE__
31762         - name: l3-interface-ipv6-address
31763           in: path
31764           description: IP address
31765           required: true
31766           type: string
31767           example: __L3-INTERFACE-IPV6-ADDRESS__
31768   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
31769     get:
31770       tags:
31771         - Network
31772       summary: returns l3-interface-ipv6-address-list
31773       description: returns l3-interface-ipv6-address-list
31774       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31775       produces:
31776         - application/json
31777         - application/xml
31778       responses:
31779         "200":
31780           description: successful operation
31781           schema:
31782               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31783         "default":
31784           description: Response codes found in [response codes](https://wiki.onap.org/).
31785       parameters:
31786         - name: vnf-id
31787           in: path
31788           description: Unique id of VNF.  This is unique across the graph.
31789           required: true
31790           type: string
31791           example: __VNF-ID__
31792         - name: interface-name
31793           in: path
31794           description: Name given to the interface
31795           required: true
31796           type: string
31797           example: __INTERFACE-NAME__
31798         - name: vlan-interface
31799           in: path
31800           description: String that identifies the interface
31801           required: true
31802           type: string
31803           example: __VLAN-INTERFACE__
31804         - name: l3-interface-ipv6-address
31805           in: path
31806           description: IP address
31807           required: true
31808           type: string
31809           example: __L3-INTERFACE-IPV6-ADDRESS__
31810     put:
31811       tags:
31812         - Network
31813       summary: create or update an existing l3-interface-ipv6-address-list
31814       description: |
31815         Create or update an existing l3-interface-ipv6-address-list.
31816         #
31817         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31818       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31819       consumes:
31820         - application/json
31821         - application/xml
31822       produces:
31823         - application/json
31824         - application/xml
31825       responses:
31826         "default":
31827           description: Response codes found in [response codes](https://wiki.onap.org/).
31828       parameters:
31829         - name: vnf-id
31830           in: path
31831           description: Unique id of VNF.  This is unique across the graph.
31832           required: true
31833           type: string
31834           example: __VNF-ID__
31835         - name: interface-name
31836           in: path
31837           description: Name given to the interface
31838           required: true
31839           type: string
31840           example: __INTERFACE-NAME__
31841         - name: vlan-interface
31842           in: path
31843           description: String that identifies the interface
31844           required: true
31845           type: string
31846           example: __VLAN-INTERFACE__
31847         - name: l3-interface-ipv6-address
31848           in: path
31849           description: IP address
31850           required: true
31851           type: string
31852           example: __L3-INTERFACE-IPV6-ADDRESS__
31853         - name: body
31854           in: body
31855           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31856           required: true
31857           schema:
31858             $ref: "#/definitions/l3-interface-ipv6-address-list"
31859     patch:
31860       tags:
31861         - Network
31862       summary: update an existing l3-interface-ipv6-address-list
31863       description: |
31864         Update an existing l3-interface-ipv6-address-list
31865         #
31866         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31867         The PUT operation will entirely replace an existing object.
31868         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31869         #
31870         Other differences between PUT and PATCH are:
31871         #
31872         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31873         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31874         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31875       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31876       consumes:
31877         - application/json
31878         - application/xml
31879       produces:
31880         - application/json
31881         - application/xml
31882       responses:
31883         "default":
31884           description: Response codes found in [response codes](https://wiki.onap.org/).
31885       parameters:
31886         - name: vnf-id
31887           in: path
31888           description: Unique id of VNF.  This is unique across the graph.
31889           required: true
31890           type: string
31891           example: __VNF-ID__
31892         - name: interface-name
31893           in: path
31894           description: Name given to the interface
31895           required: true
31896           type: string
31897           example: __INTERFACE-NAME__
31898         - name: vlan-interface
31899           in: path
31900           description: String that identifies the interface
31901           required: true
31902           type: string
31903           example: __VLAN-INTERFACE__
31904         - name: l3-interface-ipv6-address
31905           in: path
31906           description: IP address
31907           required: true
31908           type: string
31909           example: __L3-INTERFACE-IPV6-ADDRESS__
31910         - name: body
31911           in: body
31912           description: l3-interface-ipv6-address-list object that needs to be updated.
31913           required: true
31914           schema:
31915             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
31916     delete:
31917       tags:
31918         - Network
31919       summary: delete an existing l3-interface-ipv6-address-list
31920       description: delete an existing l3-interface-ipv6-address-list
31921       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31922       consumes:
31923         - application/json
31924         - application/xml
31925       produces:
31926         - application/json
31927         - application/xml
31928       responses:
31929         "default":
31930           description: Response codes found in [response codes](https://wiki.onap.org/).
31931       parameters:
31932         - name: vnf-id
31933           in: path
31934           description: Unique id of VNF.  This is unique across the graph.
31935           required: true
31936           type: string
31937           example: __VNF-ID__
31938         - name: interface-name
31939           in: path
31940           description: Name given to the interface
31941           required: true
31942           type: string
31943           example: __INTERFACE-NAME__
31944         - name: vlan-interface
31945           in: path
31946           description: String that identifies the interface
31947           required: true
31948           type: string
31949           example: __VLAN-INTERFACE__
31950         - name: l3-interface-ipv6-address
31951           in: path
31952           description: IP address
31953           required: true
31954           type: string
31955           example: __L3-INTERFACE-IPV6-ADDRESS__
31956         - name: resource-version
31957           in: query
31958           description: resource-version for concurrency
31959           required: true
31960           type: string
31961   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
31962     get:
31963       tags:
31964         - Network
31965       summary: returns vlan
31966       description: returns vlan
31967       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31968       produces:
31969         - application/json
31970         - application/xml
31971       responses:
31972         "200":
31973           description: successful operation
31974           schema:
31975               $ref: "#/getDefinitions/vlan"
31976         "default":
31977           description: Response codes found in [response codes](https://wiki.onap.org/).
31978       parameters:
31979         - name: vnf-id
31980           in: path
31981           description: Unique id of VNF.  This is unique across the graph.
31982           required: true
31983           type: string
31984           example: __VNF-ID__
31985         - name: interface-name
31986           in: path
31987           description: Name given to the interface
31988           required: true
31989           type: string
31990           example: __INTERFACE-NAME__
31991         - name: vlan-interface
31992           in: path
31993           description: String that identifies the interface
31994           required: true
31995           type: string
31996           example: __VLAN-INTERFACE__
31997     put:
31998       tags:
31999         - Network
32000       summary: create or update an existing vlan
32001       description: |
32002         Create or update an existing vlan.
32003         #
32004         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32005       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
32006       consumes:
32007         - application/json
32008         - application/xml
32009       produces:
32010         - application/json
32011         - application/xml
32012       responses:
32013         "default":
32014           description: Response codes found in [response codes](https://wiki.onap.org/).
32015       parameters:
32016         - name: vnf-id
32017           in: path
32018           description: Unique id of VNF.  This is unique across the graph.
32019           required: true
32020           type: string
32021           example: __VNF-ID__
32022         - name: interface-name
32023           in: path
32024           description: Name given to the interface
32025           required: true
32026           type: string
32027           example: __INTERFACE-NAME__
32028         - name: vlan-interface
32029           in: path
32030           description: String that identifies the interface
32031           required: true
32032           type: string
32033           example: __VLAN-INTERFACE__
32034         - name: body
32035           in: body
32036           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
32037           required: true
32038           schema:
32039             $ref: "#/definitions/vlan"
32040     patch:
32041       tags:
32042         - Network
32043       summary: update an existing vlan
32044       description: |
32045         Update an existing vlan
32046         #
32047         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32048         The PUT operation will entirely replace an existing object.
32049         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32050         #
32051         Other differences between PUT and PATCH are:
32052         #
32053         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32054         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32055         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32056       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
32057       consumes:
32058         - application/json
32059         - application/xml
32060       produces:
32061         - application/json
32062         - application/xml
32063       responses:
32064         "default":
32065           description: Response codes found in [response codes](https://wiki.onap.org/).
32066       parameters:
32067         - name: vnf-id
32068           in: path
32069           description: Unique id of VNF.  This is unique across the graph.
32070           required: true
32071           type: string
32072           example: __VNF-ID__
32073         - name: interface-name
32074           in: path
32075           description: Name given to the interface
32076           required: true
32077           type: string
32078           example: __INTERFACE-NAME__
32079         - name: vlan-interface
32080           in: path
32081           description: String that identifies the interface
32082           required: true
32083           type: string
32084           example: __VLAN-INTERFACE__
32085         - name: body
32086           in: body
32087           description: vlan object that needs to be updated.
32088           required: true
32089           schema:
32090             $ref: "#/patchDefinitions/vlan"
32091     delete:
32092       tags:
32093         - Network
32094       summary: delete an existing vlan
32095       description: delete an existing vlan
32096       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
32097       consumes:
32098         - application/json
32099         - application/xml
32100       produces:
32101         - application/json
32102         - application/xml
32103       responses:
32104         "default":
32105           description: Response codes found in [response codes](https://wiki.onap.org/).
32106       parameters:
32107         - name: vnf-id
32108           in: path
32109           description: Unique id of VNF.  This is unique across the graph.
32110           required: true
32111           type: string
32112           example: __VNF-ID__
32113         - name: interface-name
32114           in: path
32115           description: Name given to the interface
32116           required: true
32117           type: string
32118           example: __INTERFACE-NAME__
32119         - name: vlan-interface
32120           in: path
32121           description: String that identifies the interface
32122           required: true
32123           type: string
32124           example: __VLAN-INTERFACE__
32125         - name: resource-version
32126           in: query
32127           description: resource-version for concurrency
32128           required: true
32129           type: string
32130   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
32131     get:
32132       tags:
32133         - Network
32134       summary: returns vlans
32135       description: returns vlans
32136       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
32137       produces:
32138         - application/json
32139         - application/xml
32140       responses:
32141         "200":
32142           description: successful operation
32143           schema:
32144               $ref: "#/getDefinitions/vlans"
32145         "default":
32146           description: Response codes found in [response codes](https://wiki.onap.org/).
32147       parameters:
32148         - name: vnf-id
32149           in: path
32150           description: Unique id of VNF.  This is unique across the graph.
32151           required: true
32152           type: string
32153           example: __VNF-ID__
32154         - name: interface-name
32155           in: path
32156           description: Name given to the interface
32157           required: true
32158           type: string
32159           example: __INTERFACE-NAME__
32160         - name: vlan-interface
32161           in: query
32162           description:
32163           required: false
32164           type: string
32165         - name: vlan-id-inner
32166           in: query
32167           description:
32168           required: false
32169           type: integer
32170           format: int64
32171         - name: vpn-key
32172           in: query
32173           description:
32174           required: false
32175           type: string
32176   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
32177     put:
32178       tags:
32179         - Network
32180       summary: see node definition for valid relationships
32181       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32182       consumes:
32183         - application/json
32184         - application/xml
32185       produces:
32186         - application/json
32187         - application/xml
32188       responses:
32189         "default":
32190           description: Response codes found in [response codes](https://wiki.onap.org/).
32191       parameters:
32192         - name: vnf-id
32193           in: path
32194           description: Unique id of VNF.  This is unique across the graph.
32195           required: true
32196           type: string
32197           example: __VNF-ID__
32198         - name: interface-name
32199           in: path
32200           description: Name given to the interface
32201           required: true
32202           type: string
32203           example: __INTERFACE-NAME__
32204         - name: pci-id
32205           in: path
32206           description: PCI ID used to identify the sriov-vf
32207           required: true
32208           type: string
32209           example: __PCI-ID__
32210         - name: body
32211           in: body
32212           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
32213           required: true
32214           schema:
32215             $ref: "#/definitions/relationship"
32216     delete:
32217       tags:
32218         - Network
32219       summary: delete an existing relationship
32220       description: delete an existing relationship
32221       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32222       consumes:
32223         - application/json
32224         - application/xml
32225       produces:
32226         - application/json
32227         - application/xml
32228       responses:
32229         "default":
32230           description: Response codes found in [response codes](https://wiki.onap.org/).
32231       parameters:
32232         - name: vnf-id
32233           in: path
32234           description: Unique id of VNF.  This is unique across the graph.
32235           required: true
32236           type: string
32237           example: __VNF-ID__
32238         - name: interface-name
32239           in: path
32240           description: Name given to the interface
32241           required: true
32242           type: string
32243           example: __INTERFACE-NAME__
32244         - name: pci-id
32245           in: path
32246           description: PCI ID used to identify the sriov-vf
32247           required: true
32248           type: string
32249           example: __PCI-ID__
32250   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
32251     get:
32252       tags:
32253         - Network
32254       summary: returns sriov-vf
32255       description: returns sriov-vf
32256       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32257       produces:
32258         - application/json
32259         - application/xml
32260       responses:
32261         "200":
32262           description: successful operation
32263           schema:
32264               $ref: "#/getDefinitions/sriov-vf"
32265         "default":
32266           description: Response codes found in [response codes](https://wiki.onap.org/).
32267       parameters:
32268         - name: vnf-id
32269           in: path
32270           description: Unique id of VNF.  This is unique across the graph.
32271           required: true
32272           type: string
32273           example: __VNF-ID__
32274         - name: interface-name
32275           in: path
32276           description: Name given to the interface
32277           required: true
32278           type: string
32279           example: __INTERFACE-NAME__
32280         - name: pci-id
32281           in: path
32282           description: PCI ID used to identify the sriov-vf
32283           required: true
32284           type: string
32285           example: __PCI-ID__
32286     put:
32287       tags:
32288         - Network
32289       summary: create or update an existing sriov-vf
32290       description: |
32291         Create or update an existing sriov-vf.
32292         #
32293         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32294       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32295       consumes:
32296         - application/json
32297         - application/xml
32298       produces:
32299         - application/json
32300         - application/xml
32301       responses:
32302         "default":
32303           description: Response codes found in [response codes](https://wiki.onap.org/).
32304       parameters:
32305         - name: vnf-id
32306           in: path
32307           description: Unique id of VNF.  This is unique across the graph.
32308           required: true
32309           type: string
32310           example: __VNF-ID__
32311         - name: interface-name
32312           in: path
32313           description: Name given to the interface
32314           required: true
32315           type: string
32316           example: __INTERFACE-NAME__
32317         - name: pci-id
32318           in: path
32319           description: PCI ID used to identify the sriov-vf
32320           required: true
32321           type: string
32322           example: __PCI-ID__
32323         - name: body
32324           in: body
32325           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
32326           required: true
32327           schema:
32328             $ref: "#/definitions/sriov-vf"
32329     patch:
32330       tags:
32331         - Network
32332       summary: update an existing sriov-vf
32333       description: |
32334         Update an existing sriov-vf
32335         #
32336         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32337         The PUT operation will entirely replace an existing object.
32338         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32339         #
32340         Other differences between PUT and PATCH are:
32341         #
32342         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32343         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32344         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32345       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32346       consumes:
32347         - application/json
32348         - application/xml
32349       produces:
32350         - application/json
32351         - application/xml
32352       responses:
32353         "default":
32354           description: Response codes found in [response codes](https://wiki.onap.org/).
32355       parameters:
32356         - name: vnf-id
32357           in: path
32358           description: Unique id of VNF.  This is unique across the graph.
32359           required: true
32360           type: string
32361           example: __VNF-ID__
32362         - name: interface-name
32363           in: path
32364           description: Name given to the interface
32365           required: true
32366           type: string
32367           example: __INTERFACE-NAME__
32368         - name: pci-id
32369           in: path
32370           description: PCI ID used to identify the sriov-vf
32371           required: true
32372           type: string
32373           example: __PCI-ID__
32374         - name: body
32375           in: body
32376           description: sriov-vf object that needs to be updated.
32377           required: true
32378           schema:
32379             $ref: "#/patchDefinitions/sriov-vf"
32380     delete:
32381       tags:
32382         - Network
32383       summary: delete an existing sriov-vf
32384       description: delete an existing sriov-vf
32385       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32386       consumes:
32387         - application/json
32388         - application/xml
32389       produces:
32390         - application/json
32391         - application/xml
32392       responses:
32393         "default":
32394           description: Response codes found in [response codes](https://wiki.onap.org/).
32395       parameters:
32396         - name: vnf-id
32397           in: path
32398           description: Unique id of VNF.  This is unique across the graph.
32399           required: true
32400           type: string
32401           example: __VNF-ID__
32402         - name: interface-name
32403           in: path
32404           description: Name given to the interface
32405           required: true
32406           type: string
32407           example: __INTERFACE-NAME__
32408         - name: pci-id
32409           in: path
32410           description: PCI ID used to identify the sriov-vf
32411           required: true
32412           type: string
32413           example: __PCI-ID__
32414         - name: resource-version
32415           in: query
32416           description: resource-version for concurrency
32417           required: true
32418           type: string
32419   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
32420     get:
32421       tags:
32422         - Network
32423       summary: returns sriov-vfs
32424       description: returns sriov-vfs
32425       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
32426       produces:
32427         - application/json
32428         - application/xml
32429       responses:
32430         "200":
32431           description: successful operation
32432           schema:
32433               $ref: "#/getDefinitions/sriov-vfs"
32434         "default":
32435           description: Response codes found in [response codes](https://wiki.onap.org/).
32436       parameters:
32437         - name: vnf-id
32438           in: path
32439           description: Unique id of VNF.  This is unique across the graph.
32440           required: true
32441           type: string
32442           example: __VNF-ID__
32443         - name: interface-name
32444           in: path
32445           description: Name given to the interface
32446           required: true
32447           type: string
32448           example: __INTERFACE-NAME__
32449         - name: pci-id
32450           in: query
32451           description:
32452           required: false
32453           type: string
32454         - name: vf-vlan-filter
32455           in: query
32456           description:
32457           required: false
32458           type: string
32459         - name: vf-mac-filter
32460           in: query
32461           description:
32462           required: false
32463           type: string
32464         - name: vf-vlan-strip
32465           in: query
32466           description:
32467           required: false
32468           type: boolean
32469         - name: neutron-network-id
32470           in: query
32471           description:
32472           required: false
32473           type: string
32474   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
32475     put:
32476       tags:
32477         - Network
32478       summary: see node definition for valid relationships
32479       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32480       consumes:
32481         - application/json
32482         - application/xml
32483       produces:
32484         - application/json
32485         - application/xml
32486       responses:
32487         "default":
32488           description: Response codes found in [response codes](https://wiki.onap.org/).
32489       parameters:
32490         - name: vnf-id
32491           in: path
32492           description: Unique id of VNF.  This is unique across the graph.
32493           required: true
32494           type: string
32495           example: __VNF-ID__
32496         - name: interface-name
32497           in: path
32498           description: Name given to the interface
32499           required: true
32500           type: string
32501           example: __INTERFACE-NAME__
32502         - name: body
32503           in: body
32504           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
32505           required: true
32506           schema:
32507             $ref: "#/definitions/relationship"
32508     delete:
32509       tags:
32510         - Network
32511       summary: delete an existing relationship
32512       description: delete an existing relationship
32513       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32514       consumes:
32515         - application/json
32516         - application/xml
32517       produces:
32518         - application/json
32519         - application/xml
32520       responses:
32521         "default":
32522           description: Response codes found in [response codes](https://wiki.onap.org/).
32523       parameters:
32524         - name: vnf-id
32525           in: path
32526           description: Unique id of VNF.  This is unique across the graph.
32527           required: true
32528           type: string
32529           example: __VNF-ID__
32530         - name: interface-name
32531           in: path
32532           description: Name given to the interface
32533           required: true
32534           type: string
32535           example: __INTERFACE-NAME__
32536   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
32537     put:
32538       tags:
32539         - Network
32540       summary: see node definition for valid relationships
32541       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32542       consumes:
32543         - application/json
32544         - application/xml
32545       produces:
32546         - application/json
32547         - application/xml
32548       responses:
32549         "default":
32550           description: Response codes found in [response codes](https://wiki.onap.org/).
32551       parameters:
32552         - name: vnf-id
32553           in: path
32554           description: Unique id of VNF.  This is unique across the graph.
32555           required: true
32556           type: string
32557           example: __VNF-ID__
32558         - name: interface-name
32559           in: path
32560           description: Name given to the interface
32561           required: true
32562           type: string
32563           example: __INTERFACE-NAME__
32564         - name: l3-interface-ipv4-address
32565           in: path
32566           description: IP address
32567           required: true
32568           type: string
32569           example: __L3-INTERFACE-IPV4-ADDRESS__
32570         - name: body
32571           in: body
32572           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32573           required: true
32574           schema:
32575             $ref: "#/definitions/relationship"
32576     delete:
32577       tags:
32578         - Network
32579       summary: delete an existing relationship
32580       description: delete an existing relationship
32581       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32582       consumes:
32583         - application/json
32584         - application/xml
32585       produces:
32586         - application/json
32587         - application/xml
32588       responses:
32589         "default":
32590           description: Response codes found in [response codes](https://wiki.onap.org/).
32591       parameters:
32592         - name: vnf-id
32593           in: path
32594           description: Unique id of VNF.  This is unique across the graph.
32595           required: true
32596           type: string
32597           example: __VNF-ID__
32598         - name: interface-name
32599           in: path
32600           description: Name given to the interface
32601           required: true
32602           type: string
32603           example: __INTERFACE-NAME__
32604         - name: l3-interface-ipv4-address
32605           in: path
32606           description: IP address
32607           required: true
32608           type: string
32609           example: __L3-INTERFACE-IPV4-ADDRESS__
32610   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
32611     get:
32612       tags:
32613         - Network
32614       summary: returns l3-interface-ipv4-address-list
32615       description: returns l3-interface-ipv4-address-list
32616       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32617       produces:
32618         - application/json
32619         - application/xml
32620       responses:
32621         "200":
32622           description: successful operation
32623           schema:
32624               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32625         "default":
32626           description: Response codes found in [response codes](https://wiki.onap.org/).
32627       parameters:
32628         - name: vnf-id
32629           in: path
32630           description: Unique id of VNF.  This is unique across the graph.
32631           required: true
32632           type: string
32633           example: __VNF-ID__
32634         - name: interface-name
32635           in: path
32636           description: Name given to the interface
32637           required: true
32638           type: string
32639           example: __INTERFACE-NAME__
32640         - name: l3-interface-ipv4-address
32641           in: path
32642           description: IP address
32643           required: true
32644           type: string
32645           example: __L3-INTERFACE-IPV4-ADDRESS__
32646     put:
32647       tags:
32648         - Network
32649       summary: create or update an existing l3-interface-ipv4-address-list
32650       description: |
32651         Create or update an existing l3-interface-ipv4-address-list.
32652         #
32653         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32654       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32655       consumes:
32656         - application/json
32657         - application/xml
32658       produces:
32659         - application/json
32660         - application/xml
32661       responses:
32662         "default":
32663           description: Response codes found in [response codes](https://wiki.onap.org/).
32664       parameters:
32665         - name: vnf-id
32666           in: path
32667           description: Unique id of VNF.  This is unique across the graph.
32668           required: true
32669           type: string
32670           example: __VNF-ID__
32671         - name: interface-name
32672           in: path
32673           description: Name given to the interface
32674           required: true
32675           type: string
32676           example: __INTERFACE-NAME__
32677         - name: l3-interface-ipv4-address
32678           in: path
32679           description: IP address
32680           required: true
32681           type: string
32682           example: __L3-INTERFACE-IPV4-ADDRESS__
32683         - name: body
32684           in: body
32685           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32686           required: true
32687           schema:
32688             $ref: "#/definitions/l3-interface-ipv4-address-list"
32689     patch:
32690       tags:
32691         - Network
32692       summary: update an existing l3-interface-ipv4-address-list
32693       description: |
32694         Update an existing l3-interface-ipv4-address-list
32695         #
32696         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32697         The PUT operation will entirely replace an existing object.
32698         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32699         #
32700         Other differences between PUT and PATCH are:
32701         #
32702         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32703         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32704         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32705       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32706       consumes:
32707         - application/json
32708         - application/xml
32709       produces:
32710         - application/json
32711         - application/xml
32712       responses:
32713         "default":
32714           description: Response codes found in [response codes](https://wiki.onap.org/).
32715       parameters:
32716         - name: vnf-id
32717           in: path
32718           description: Unique id of VNF.  This is unique across the graph.
32719           required: true
32720           type: string
32721           example: __VNF-ID__
32722         - name: interface-name
32723           in: path
32724           description: Name given to the interface
32725           required: true
32726           type: string
32727           example: __INTERFACE-NAME__
32728         - name: l3-interface-ipv4-address
32729           in: path
32730           description: IP address
32731           required: true
32732           type: string
32733           example: __L3-INTERFACE-IPV4-ADDRESS__
32734         - name: body
32735           in: body
32736           description: l3-interface-ipv4-address-list object that needs to be updated.
32737           required: true
32738           schema:
32739             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
32740     delete:
32741       tags:
32742         - Network
32743       summary: delete an existing l3-interface-ipv4-address-list
32744       description: delete an existing l3-interface-ipv4-address-list
32745       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32746       consumes:
32747         - application/json
32748         - application/xml
32749       produces:
32750         - application/json
32751         - application/xml
32752       responses:
32753         "default":
32754           description: Response codes found in [response codes](https://wiki.onap.org/).
32755       parameters:
32756         - name: vnf-id
32757           in: path
32758           description: Unique id of VNF.  This is unique across the graph.
32759           required: true
32760           type: string
32761           example: __VNF-ID__
32762         - name: interface-name
32763           in: path
32764           description: Name given to the interface
32765           required: true
32766           type: string
32767           example: __INTERFACE-NAME__
32768         - name: l3-interface-ipv4-address
32769           in: path
32770           description: IP address
32771           required: true
32772           type: string
32773           example: __L3-INTERFACE-IPV4-ADDRESS__
32774         - name: resource-version
32775           in: query
32776           description: resource-version for concurrency
32777           required: true
32778           type: string
32779   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
32780     put:
32781       tags:
32782         - Network
32783       summary: see node definition for valid relationships
32784       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
32785       consumes:
32786         - application/json
32787         - application/xml
32788       produces:
32789         - application/json
32790         - application/xml
32791       responses:
32792         "default":
32793           description: Response codes found in [response codes](https://wiki.onap.org/).
32794       parameters:
32795         - name: vnf-id
32796           in: path
32797           description: Unique id of VNF.  This is unique across the graph.
32798           required: true
32799           type: string
32800           example: __VNF-ID__
32801         - name: interface-name
32802           in: path
32803           description: Name given to the interface
32804           required: true
32805           type: string
32806           example: __INTERFACE-NAME__
32807         - name: l3-interface-ipv6-address
32808           in: path
32809           description: IP address
32810           required: true
32811           type: string
32812           example: __L3-INTERFACE-IPV6-ADDRESS__
32813         - name: body
32814           in: body
32815           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
32816           required: true
32817           schema:
32818             $ref: "#/definitions/relationship"
32819     delete:
32820       tags:
32821         - Network
32822       summary: delete an existing relationship
32823       description: delete an existing relationship
32824       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
32825       consumes:
32826         - application/json
32827         - application/xml
32828       produces:
32829         - application/json
32830         - application/xml
32831       responses:
32832         "default":
32833           description: Response codes found in [response codes](https://wiki.onap.org/).
32834       parameters:
32835         - name: vnf-id
32836           in: path
32837           description: Unique id of VNF.  This is unique across the graph.
32838           required: true
32839           type: string
32840           example: __VNF-ID__
32841         - name: interface-name
32842           in: path
32843           description: Name given to the interface
32844           required: true
32845           type: string
32846           example: __INTERFACE-NAME__
32847         - name: l3-interface-ipv6-address
32848           in: path
32849           description: IP address
32850           required: true
32851           type: string
32852           example: __L3-INTERFACE-IPV6-ADDRESS__
32853   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
32854     get:
32855       tags:
32856         - Network
32857       summary: returns l3-interface-ipv6-address-list
32858       description: returns l3-interface-ipv6-address-list
32859       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32860       produces:
32861         - application/json
32862         - application/xml
32863       responses:
32864         "200":
32865           description: successful operation
32866           schema:
32867               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
32868         "default":
32869           description: Response codes found in [response codes](https://wiki.onap.org/).
32870       parameters:
32871         - name: vnf-id
32872           in: path
32873           description: Unique id of VNF.  This is unique across the graph.
32874           required: true
32875           type: string
32876           example: __VNF-ID__
32877         - name: interface-name
32878           in: path
32879           description: Name given to the interface
32880           required: true
32881           type: string
32882           example: __INTERFACE-NAME__
32883         - name: l3-interface-ipv6-address
32884           in: path
32885           description: IP address
32886           required: true
32887           type: string
32888           example: __L3-INTERFACE-IPV6-ADDRESS__
32889     put:
32890       tags:
32891         - Network
32892       summary: create or update an existing l3-interface-ipv6-address-list
32893       description: |
32894         Create or update an existing l3-interface-ipv6-address-list.
32895         #
32896         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32897       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32898       consumes:
32899         - application/json
32900         - application/xml
32901       produces:
32902         - application/json
32903         - application/xml
32904       responses:
32905         "default":
32906           description: Response codes found in [response codes](https://wiki.onap.org/).
32907       parameters:
32908         - name: vnf-id
32909           in: path
32910           description: Unique id of VNF.  This is unique across the graph.
32911           required: true
32912           type: string
32913           example: __VNF-ID__
32914         - name: interface-name
32915           in: path
32916           description: Name given to the interface
32917           required: true
32918           type: string
32919           example: __INTERFACE-NAME__
32920         - name: l3-interface-ipv6-address
32921           in: path
32922           description: IP address
32923           required: true
32924           type: string
32925           example: __L3-INTERFACE-IPV6-ADDRESS__
32926         - name: body
32927           in: body
32928           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
32929           required: true
32930           schema:
32931             $ref: "#/definitions/l3-interface-ipv6-address-list"
32932     patch:
32933       tags:
32934         - Network
32935       summary: update an existing l3-interface-ipv6-address-list
32936       description: |
32937         Update an existing l3-interface-ipv6-address-list
32938         #
32939         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32940         The PUT operation will entirely replace an existing object.
32941         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32942         #
32943         Other differences between PUT and PATCH are:
32944         #
32945         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32946         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32947         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32948       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32949       consumes:
32950         - application/json
32951         - application/xml
32952       produces:
32953         - application/json
32954         - application/xml
32955       responses:
32956         "default":
32957           description: Response codes found in [response codes](https://wiki.onap.org/).
32958       parameters:
32959         - name: vnf-id
32960           in: path
32961           description: Unique id of VNF.  This is unique across the graph.
32962           required: true
32963           type: string
32964           example: __VNF-ID__
32965         - name: interface-name
32966           in: path
32967           description: Name given to the interface
32968           required: true
32969           type: string
32970           example: __INTERFACE-NAME__
32971         - name: l3-interface-ipv6-address
32972           in: path
32973           description: IP address
32974           required: true
32975           type: string
32976           example: __L3-INTERFACE-IPV6-ADDRESS__
32977         - name: body
32978           in: body
32979           description: l3-interface-ipv6-address-list object that needs to be updated.
32980           required: true
32981           schema:
32982             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
32983     delete:
32984       tags:
32985         - Network
32986       summary: delete an existing l3-interface-ipv6-address-list
32987       description: delete an existing l3-interface-ipv6-address-list
32988       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32989       consumes:
32990         - application/json
32991         - application/xml
32992       produces:
32993         - application/json
32994         - application/xml
32995       responses:
32996         "default":
32997           description: Response codes found in [response codes](https://wiki.onap.org/).
32998       parameters:
32999         - name: vnf-id
33000           in: path
33001           description: Unique id of VNF.  This is unique across the graph.
33002           required: true
33003           type: string
33004           example: __VNF-ID__
33005         - name: interface-name
33006           in: path
33007           description: Name given to the interface
33008           required: true
33009           type: string
33010           example: __INTERFACE-NAME__
33011         - name: l3-interface-ipv6-address
33012           in: path
33013           description: IP address
33014           required: true
33015           type: string
33016           example: __L3-INTERFACE-IPV6-ADDRESS__
33017         - name: resource-version
33018           in: query
33019           description: resource-version for concurrency
33020           required: true
33021           type: string
33022   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
33023     get:
33024       tags:
33025         - Network
33026       summary: returns l-interface
33027       description: returns l-interface
33028       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
33029       produces:
33030         - application/json
33031         - application/xml
33032       responses:
33033         "200":
33034           description: successful operation
33035           schema:
33036               $ref: "#/getDefinitions/l-interface"
33037         "default":
33038           description: Response codes found in [response codes](https://wiki.onap.org/).
33039       parameters:
33040         - name: vnf-id
33041           in: path
33042           description: Unique id of VNF.  This is unique across the graph.
33043           required: true
33044           type: string
33045           example: __VNF-ID__
33046         - name: interface-name
33047           in: path
33048           description: Name given to the interface
33049           required: true
33050           type: string
33051           example: __INTERFACE-NAME__
33052     put:
33053       tags:
33054         - Network
33055       summary: create or update an existing l-interface
33056       description: |
33057         Create or update an existing l-interface.
33058         #
33059         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33060       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33061       consumes:
33062         - application/json
33063         - application/xml
33064       produces:
33065         - application/json
33066         - application/xml
33067       responses:
33068         "default":
33069           description: Response codes found in [response codes](https://wiki.onap.org/).
33070       parameters:
33071         - name: vnf-id
33072           in: path
33073           description: Unique id of VNF.  This is unique across the graph.
33074           required: true
33075           type: string
33076           example: __VNF-ID__
33077         - name: interface-name
33078           in: path
33079           description: Name given to the interface
33080           required: true
33081           type: string
33082           example: __INTERFACE-NAME__
33083         - name: body
33084           in: body
33085           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
33086           required: true
33087           schema:
33088             $ref: "#/definitions/l-interface"
33089     patch:
33090       tags:
33091         - Network
33092       summary: update an existing l-interface
33093       description: |
33094         Update an existing l-interface
33095         #
33096         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33097         The PUT operation will entirely replace an existing object.
33098         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33099         #
33100         Other differences between PUT and PATCH are:
33101         #
33102         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33103         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33104         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33105       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33106       consumes:
33107         - application/json
33108         - application/xml
33109       produces:
33110         - application/json
33111         - application/xml
33112       responses:
33113         "default":
33114           description: Response codes found in [response codes](https://wiki.onap.org/).
33115       parameters:
33116         - name: vnf-id
33117           in: path
33118           description: Unique id of VNF.  This is unique across the graph.
33119           required: true
33120           type: string
33121           example: __VNF-ID__
33122         - name: interface-name
33123           in: path
33124           description: Name given to the interface
33125           required: true
33126           type: string
33127           example: __INTERFACE-NAME__
33128         - name: body
33129           in: body
33130           description: l-interface object that needs to be updated.
33131           required: true
33132           schema:
33133             $ref: "#/patchDefinitions/l-interface"
33134     delete:
33135       tags:
33136         - Network
33137       summary: delete an existing l-interface
33138       description: delete an existing l-interface
33139       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
33140       consumes:
33141         - application/json
33142         - application/xml
33143       produces:
33144         - application/json
33145         - application/xml
33146       responses:
33147         "default":
33148           description: Response codes found in [response codes](https://wiki.onap.org/).
33149       parameters:
33150         - name: vnf-id
33151           in: path
33152           description: Unique id of VNF.  This is unique across the graph.
33153           required: true
33154           type: string
33155           example: __VNF-ID__
33156         - name: interface-name
33157           in: path
33158           description: Name given to the interface
33159           required: true
33160           type: string
33161           example: __INTERFACE-NAME__
33162         - name: resource-version
33163           in: query
33164           description: resource-version for concurrency
33165           required: true
33166           type: string
33167   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
33168     get:
33169       tags:
33170         - Network
33171       summary: returns l-interfaces
33172       description: returns l-interfaces
33173       operationId: getNetworkGenericVnfsGenericVnfLInterfaces
33174       produces:
33175         - application/json
33176         - application/xml
33177       responses:
33178         "200":
33179           description: successful operation
33180           schema:
33181               $ref: "#/getDefinitions/l-interfaces"
33182         "default":
33183           description: Response codes found in [response codes](https://wiki.onap.org/).
33184       parameters:
33185         - name: vnf-id
33186           in: path
33187           description: Unique id of VNF.  This is unique across the graph.
33188           required: true
33189           type: string
33190           example: __VNF-ID__
33191         - name: interface-name
33192           in: query
33193           description:
33194           required: false
33195           type: string
33196         - name: interface-id
33197           in: query
33198           description:
33199           required: false
33200           type: string
33201         - name: macaddr
33202           in: query
33203           description:
33204           required: false
33205           type: string
33206         - name: network-name
33207           in: query
33208           description:
33209           required: false
33210           type: string
33211   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
33212     put:
33213       tags:
33214         - Network
33215       summary: see node definition for valid relationships
33216       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33217       consumes:
33218         - application/json
33219         - application/xml
33220       produces:
33221         - application/json
33222         - application/xml
33223       responses:
33224         "default":
33225           description: Response codes found in [response codes](https://wiki.onap.org/).
33226       parameters:
33227         - name: vnf-id
33228           in: path
33229           description: Unique id of VNF.  This is unique across the graph.
33230           required: true
33231           type: string
33232           example: __VNF-ID__
33233         - name: interface-name
33234           in: path
33235           description: Name that identifies the link aggregate interface
33236           required: true
33237           type: string
33238           example: __INTERFACE-NAME__
33239         - name: body
33240           in: body
33241           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
33242           required: true
33243           schema:
33244             $ref: "#/definitions/relationship"
33245     delete:
33246       tags:
33247         - Network
33248       summary: delete an existing relationship
33249       description: delete an existing relationship
33250       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33251       consumes:
33252         - application/json
33253         - application/xml
33254       produces:
33255         - application/json
33256         - application/xml
33257       responses:
33258         "default":
33259           description: Response codes found in [response codes](https://wiki.onap.org/).
33260       parameters:
33261         - name: vnf-id
33262           in: path
33263           description: Unique id of VNF.  This is unique across the graph.
33264           required: true
33265           type: string
33266           example: __VNF-ID__
33267         - name: interface-name
33268           in: path
33269           description: Name that identifies the link aggregate interface
33270           required: true
33271           type: string
33272           example: __INTERFACE-NAME__
33273   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
33274     put:
33275       tags:
33276         - Network
33277       summary: see node definition for valid relationships
33278       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33279       consumes:
33280         - application/json
33281         - application/xml
33282       produces:
33283         - application/json
33284         - application/xml
33285       responses:
33286         "default":
33287           description: Response codes found in [response codes](https://wiki.onap.org/).
33288       parameters:
33289         - name: vnf-id
33290           in: path
33291           description: Unique id of VNF.  This is unique across the graph.
33292           required: true
33293           type: string
33294           example: __VNF-ID__
33295         - name: interface-name
33296           in: path
33297           description: Name that identifies the link aggregate interface
33298           required: true
33299           type: string
33300           example: __INTERFACE-NAME__
33301         - name: interface-name
33302           in: path
33303           description: Name given to the interface
33304           required: true
33305           type: string
33306           example: __INTERFACE-NAME__
33307         - name: vlan-interface
33308           in: path
33309           description: String that identifies the interface
33310           required: true
33311           type: string
33312           example: __VLAN-INTERFACE__
33313         - name: body
33314           in: body
33315           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
33316           required: true
33317           schema:
33318             $ref: "#/definitions/relationship"
33319     delete:
33320       tags:
33321         - Network
33322       summary: delete an existing relationship
33323       description: delete an existing relationship
33324       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33325       consumes:
33326         - application/json
33327         - application/xml
33328       produces:
33329         - application/json
33330         - application/xml
33331       responses:
33332         "default":
33333           description: Response codes found in [response codes](https://wiki.onap.org/).
33334       parameters:
33335         - name: vnf-id
33336           in: path
33337           description: Unique id of VNF.  This is unique across the graph.
33338           required: true
33339           type: string
33340           example: __VNF-ID__
33341         - name: interface-name
33342           in: path
33343           description: Name that identifies the link aggregate interface
33344           required: true
33345           type: string
33346           example: __INTERFACE-NAME__
33347         - name: interface-name
33348           in: path
33349           description: Name given to the interface
33350           required: true
33351           type: string
33352           example: __INTERFACE-NAME__
33353         - name: vlan-interface
33354           in: path
33355           description: String that identifies the interface
33356           required: true
33357           type: string
33358           example: __VLAN-INTERFACE__
33359   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
33360     put:
33361       tags:
33362         - Network
33363       summary: see node definition for valid relationships
33364       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33365       consumes:
33366         - application/json
33367         - application/xml
33368       produces:
33369         - application/json
33370         - application/xml
33371       responses:
33372         "default":
33373           description: Response codes found in [response codes](https://wiki.onap.org/).
33374       parameters:
33375         - name: vnf-id
33376           in: path
33377           description: Unique id of VNF.  This is unique across the graph.
33378           required: true
33379           type: string
33380           example: __VNF-ID__
33381         - name: interface-name
33382           in: path
33383           description: Name that identifies the link aggregate interface
33384           required: true
33385           type: string
33386           example: __INTERFACE-NAME__
33387         - name: interface-name
33388           in: path
33389           description: Name given to the interface
33390           required: true
33391           type: string
33392           example: __INTERFACE-NAME__
33393         - name: vlan-interface
33394           in: path
33395           description: String that identifies the interface
33396           required: true
33397           type: string
33398           example: __VLAN-INTERFACE__
33399         - name: l3-interface-ipv4-address
33400           in: path
33401           description: IP address
33402           required: true
33403           type: string
33404           example: __L3-INTERFACE-IPV4-ADDRESS__
33405         - name: body
33406           in: body
33407           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33408           required: true
33409           schema:
33410             $ref: "#/definitions/relationship"
33411     delete:
33412       tags:
33413         - Network
33414       summary: delete an existing relationship
33415       description: delete an existing relationship
33416       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33417       consumes:
33418         - application/json
33419         - application/xml
33420       produces:
33421         - application/json
33422         - application/xml
33423       responses:
33424         "default":
33425           description: Response codes found in [response codes](https://wiki.onap.org/).
33426       parameters:
33427         - name: vnf-id
33428           in: path
33429           description: Unique id of VNF.  This is unique across the graph.
33430           required: true
33431           type: string
33432           example: __VNF-ID__
33433         - name: interface-name
33434           in: path
33435           description: Name that identifies the link aggregate interface
33436           required: true
33437           type: string
33438           example: __INTERFACE-NAME__
33439         - name: interface-name
33440           in: path
33441           description: Name given to the interface
33442           required: true
33443           type: string
33444           example: __INTERFACE-NAME__
33445         - name: vlan-interface
33446           in: path
33447           description: String that identifies the interface
33448           required: true
33449           type: string
33450           example: __VLAN-INTERFACE__
33451         - name: l3-interface-ipv4-address
33452           in: path
33453           description: IP address
33454           required: true
33455           type: string
33456           example: __L3-INTERFACE-IPV4-ADDRESS__
33457   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
33458     get:
33459       tags:
33460         - Network
33461       summary: returns l3-interface-ipv4-address-list
33462       description: returns l3-interface-ipv4-address-list
33463       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33464       produces:
33465         - application/json
33466         - application/xml
33467       responses:
33468         "200":
33469           description: successful operation
33470           schema:
33471               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
33472         "default":
33473           description: Response codes found in [response codes](https://wiki.onap.org/).
33474       parameters:
33475         - name: vnf-id
33476           in: path
33477           description: Unique id of VNF.  This is unique across the graph.
33478           required: true
33479           type: string
33480           example: __VNF-ID__
33481         - name: interface-name
33482           in: path
33483           description: Name that identifies the link aggregate interface
33484           required: true
33485           type: string
33486           example: __INTERFACE-NAME__
33487         - name: interface-name
33488           in: path
33489           description: Name given to the interface
33490           required: true
33491           type: string
33492           example: __INTERFACE-NAME__
33493         - name: vlan-interface
33494           in: path
33495           description: String that identifies the interface
33496           required: true
33497           type: string
33498           example: __VLAN-INTERFACE__
33499         - name: l3-interface-ipv4-address
33500           in: path
33501           description: IP address
33502           required: true
33503           type: string
33504           example: __L3-INTERFACE-IPV4-ADDRESS__
33505     put:
33506       tags:
33507         - Network
33508       summary: create or update an existing l3-interface-ipv4-address-list
33509       description: |
33510         Create or update an existing l3-interface-ipv4-address-list.
33511         #
33512         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33513       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33514       consumes:
33515         - application/json
33516         - application/xml
33517       produces:
33518         - application/json
33519         - application/xml
33520       responses:
33521         "default":
33522           description: Response codes found in [response codes](https://wiki.onap.org/).
33523       parameters:
33524         - name: vnf-id
33525           in: path
33526           description: Unique id of VNF.  This is unique across the graph.
33527           required: true
33528           type: string
33529           example: __VNF-ID__
33530         - name: interface-name
33531           in: path
33532           description: Name that identifies the link aggregate interface
33533           required: true
33534           type: string
33535           example: __INTERFACE-NAME__
33536         - name: interface-name
33537           in: path
33538           description: Name given to the interface
33539           required: true
33540           type: string
33541           example: __INTERFACE-NAME__
33542         - name: vlan-interface
33543           in: path
33544           description: String that identifies the interface
33545           required: true
33546           type: string
33547           example: __VLAN-INTERFACE__
33548         - name: l3-interface-ipv4-address
33549           in: path
33550           description: IP address
33551           required: true
33552           type: string
33553           example: __L3-INTERFACE-IPV4-ADDRESS__
33554         - name: body
33555           in: body
33556           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33557           required: true
33558           schema:
33559             $ref: "#/definitions/l3-interface-ipv4-address-list"
33560     patch:
33561       tags:
33562         - Network
33563       summary: update an existing l3-interface-ipv4-address-list
33564       description: |
33565         Update an existing l3-interface-ipv4-address-list
33566         #
33567         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33568         The PUT operation will entirely replace an existing object.
33569         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33570         #
33571         Other differences between PUT and PATCH are:
33572         #
33573         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33574         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33575         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33576       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33577       consumes:
33578         - application/json
33579         - application/xml
33580       produces:
33581         - application/json
33582         - application/xml
33583       responses:
33584         "default":
33585           description: Response codes found in [response codes](https://wiki.onap.org/).
33586       parameters:
33587         - name: vnf-id
33588           in: path
33589           description: Unique id of VNF.  This is unique across the graph.
33590           required: true
33591           type: string
33592           example: __VNF-ID__
33593         - name: interface-name
33594           in: path
33595           description: Name that identifies the link aggregate interface
33596           required: true
33597           type: string
33598           example: __INTERFACE-NAME__
33599         - name: interface-name
33600           in: path
33601           description: Name given to the interface
33602           required: true
33603           type: string
33604           example: __INTERFACE-NAME__
33605         - name: vlan-interface
33606           in: path
33607           description: String that identifies the interface
33608           required: true
33609           type: string
33610           example: __VLAN-INTERFACE__
33611         - name: l3-interface-ipv4-address
33612           in: path
33613           description: IP address
33614           required: true
33615           type: string
33616           example: __L3-INTERFACE-IPV4-ADDRESS__
33617         - name: body
33618           in: body
33619           description: l3-interface-ipv4-address-list object that needs to be updated.
33620           required: true
33621           schema:
33622             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
33623     delete:
33624       tags:
33625         - Network
33626       summary: delete an existing l3-interface-ipv4-address-list
33627       description: delete an existing l3-interface-ipv4-address-list
33628       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33629       consumes:
33630         - application/json
33631         - application/xml
33632       produces:
33633         - application/json
33634         - application/xml
33635       responses:
33636         "default":
33637           description: Response codes found in [response codes](https://wiki.onap.org/).
33638       parameters:
33639         - name: vnf-id
33640           in: path
33641           description: Unique id of VNF.  This is unique across the graph.
33642           required: true
33643           type: string
33644           example: __VNF-ID__
33645         - name: interface-name
33646           in: path
33647           description: Name that identifies the link aggregate interface
33648           required: true
33649           type: string
33650           example: __INTERFACE-NAME__
33651         - name: interface-name
33652           in: path
33653           description: Name given to the interface
33654           required: true
33655           type: string
33656           example: __INTERFACE-NAME__
33657         - name: vlan-interface
33658           in: path
33659           description: String that identifies the interface
33660           required: true
33661           type: string
33662           example: __VLAN-INTERFACE__
33663         - name: l3-interface-ipv4-address
33664           in: path
33665           description: IP address
33666           required: true
33667           type: string
33668           example: __L3-INTERFACE-IPV4-ADDRESS__
33669         - name: resource-version
33670           in: query
33671           description: resource-version for concurrency
33672           required: true
33673           type: string
33674   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
33675     put:
33676       tags:
33677         - Network
33678       summary: see node definition for valid relationships
33679       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33680       consumes:
33681         - application/json
33682         - application/xml
33683       produces:
33684         - application/json
33685         - application/xml
33686       responses:
33687         "default":
33688           description: Response codes found in [response codes](https://wiki.onap.org/).
33689       parameters:
33690         - name: vnf-id
33691           in: path
33692           description: Unique id of VNF.  This is unique across the graph.
33693           required: true
33694           type: string
33695           example: __VNF-ID__
33696         - name: interface-name
33697           in: path
33698           description: Name that identifies the link aggregate interface
33699           required: true
33700           type: string
33701           example: __INTERFACE-NAME__
33702         - name: interface-name
33703           in: path
33704           description: Name given to the interface
33705           required: true
33706           type: string
33707           example: __INTERFACE-NAME__
33708         - name: vlan-interface
33709           in: path
33710           description: String that identifies the interface
33711           required: true
33712           type: string
33713           example: __VLAN-INTERFACE__
33714         - name: l3-interface-ipv6-address
33715           in: path
33716           description: IP address
33717           required: true
33718           type: string
33719           example: __L3-INTERFACE-IPV6-ADDRESS__
33720         - name: body
33721           in: body
33722           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33723           required: true
33724           schema:
33725             $ref: "#/definitions/relationship"
33726     delete:
33727       tags:
33728         - Network
33729       summary: delete an existing relationship
33730       description: delete an existing relationship
33731       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33732       consumes:
33733         - application/json
33734         - application/xml
33735       produces:
33736         - application/json
33737         - application/xml
33738       responses:
33739         "default":
33740           description: Response codes found in [response codes](https://wiki.onap.org/).
33741       parameters:
33742         - name: vnf-id
33743           in: path
33744           description: Unique id of VNF.  This is unique across the graph.
33745           required: true
33746           type: string
33747           example: __VNF-ID__
33748         - name: interface-name
33749           in: path
33750           description: Name that identifies the link aggregate interface
33751           required: true
33752           type: string
33753           example: __INTERFACE-NAME__
33754         - name: interface-name
33755           in: path
33756           description: Name given to the interface
33757           required: true
33758           type: string
33759           example: __INTERFACE-NAME__
33760         - name: vlan-interface
33761           in: path
33762           description: String that identifies the interface
33763           required: true
33764           type: string
33765           example: __VLAN-INTERFACE__
33766         - name: l3-interface-ipv6-address
33767           in: path
33768           description: IP address
33769           required: true
33770           type: string
33771           example: __L3-INTERFACE-IPV6-ADDRESS__
33772   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
33773     get:
33774       tags:
33775         - Network
33776       summary: returns l3-interface-ipv6-address-list
33777       description: returns l3-interface-ipv6-address-list
33778       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33779       produces:
33780         - application/json
33781         - application/xml
33782       responses:
33783         "200":
33784           description: successful operation
33785           schema:
33786               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33787         "default":
33788           description: Response codes found in [response codes](https://wiki.onap.org/).
33789       parameters:
33790         - name: vnf-id
33791           in: path
33792           description: Unique id of VNF.  This is unique across the graph.
33793           required: true
33794           type: string
33795           example: __VNF-ID__
33796         - name: interface-name
33797           in: path
33798           description: Name that identifies the link aggregate interface
33799           required: true
33800           type: string
33801           example: __INTERFACE-NAME__
33802         - name: interface-name
33803           in: path
33804           description: Name given to the interface
33805           required: true
33806           type: string
33807           example: __INTERFACE-NAME__
33808         - name: vlan-interface
33809           in: path
33810           description: String that identifies the interface
33811           required: true
33812           type: string
33813           example: __VLAN-INTERFACE__
33814         - name: l3-interface-ipv6-address
33815           in: path
33816           description: IP address
33817           required: true
33818           type: string
33819           example: __L3-INTERFACE-IPV6-ADDRESS__
33820     put:
33821       tags:
33822         - Network
33823       summary: create or update an existing l3-interface-ipv6-address-list
33824       description: |
33825         Create or update an existing l3-interface-ipv6-address-list.
33826         #
33827         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33828       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33829       consumes:
33830         - application/json
33831         - application/xml
33832       produces:
33833         - application/json
33834         - application/xml
33835       responses:
33836         "default":
33837           description: Response codes found in [response codes](https://wiki.onap.org/).
33838       parameters:
33839         - name: vnf-id
33840           in: path
33841           description: Unique id of VNF.  This is unique across the graph.
33842           required: true
33843           type: string
33844           example: __VNF-ID__
33845         - name: interface-name
33846           in: path
33847           description: Name that identifies the link aggregate interface
33848           required: true
33849           type: string
33850           example: __INTERFACE-NAME__
33851         - name: interface-name
33852           in: path
33853           description: Name given to the interface
33854           required: true
33855           type: string
33856           example: __INTERFACE-NAME__
33857         - name: vlan-interface
33858           in: path
33859           description: String that identifies the interface
33860           required: true
33861           type: string
33862           example: __VLAN-INTERFACE__
33863         - name: l3-interface-ipv6-address
33864           in: path
33865           description: IP address
33866           required: true
33867           type: string
33868           example: __L3-INTERFACE-IPV6-ADDRESS__
33869         - name: body
33870           in: body
33871           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33872           required: true
33873           schema:
33874             $ref: "#/definitions/l3-interface-ipv6-address-list"
33875     patch:
33876       tags:
33877         - Network
33878       summary: update an existing l3-interface-ipv6-address-list
33879       description: |
33880         Update an existing l3-interface-ipv6-address-list
33881         #
33882         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33883         The PUT operation will entirely replace an existing object.
33884         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33885         #
33886         Other differences between PUT and PATCH are:
33887         #
33888         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33889         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33890         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33891       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33892       consumes:
33893         - application/json
33894         - application/xml
33895       produces:
33896         - application/json
33897         - application/xml
33898       responses:
33899         "default":
33900           description: Response codes found in [response codes](https://wiki.onap.org/).
33901       parameters:
33902         - name: vnf-id
33903           in: path
33904           description: Unique id of VNF.  This is unique across the graph.
33905           required: true
33906           type: string
33907           example: __VNF-ID__
33908         - name: interface-name
33909           in: path
33910           description: Name that identifies the link aggregate interface
33911           required: true
33912           type: string
33913           example: __INTERFACE-NAME__
33914         - name: interface-name
33915           in: path
33916           description: Name given to the interface
33917           required: true
33918           type: string
33919           example: __INTERFACE-NAME__
33920         - name: vlan-interface
33921           in: path
33922           description: String that identifies the interface
33923           required: true
33924           type: string
33925           example: __VLAN-INTERFACE__
33926         - name: l3-interface-ipv6-address
33927           in: path
33928           description: IP address
33929           required: true
33930           type: string
33931           example: __L3-INTERFACE-IPV6-ADDRESS__
33932         - name: body
33933           in: body
33934           description: l3-interface-ipv6-address-list object that needs to be updated.
33935           required: true
33936           schema:
33937             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
33938     delete:
33939       tags:
33940         - Network
33941       summary: delete an existing l3-interface-ipv6-address-list
33942       description: delete an existing l3-interface-ipv6-address-list
33943       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33944       consumes:
33945         - application/json
33946         - application/xml
33947       produces:
33948         - application/json
33949         - application/xml
33950       responses:
33951         "default":
33952           description: Response codes found in [response codes](https://wiki.onap.org/).
33953       parameters:
33954         - name: vnf-id
33955           in: path
33956           description: Unique id of VNF.  This is unique across the graph.
33957           required: true
33958           type: string
33959           example: __VNF-ID__
33960         - name: interface-name
33961           in: path
33962           description: Name that identifies the link aggregate interface
33963           required: true
33964           type: string
33965           example: __INTERFACE-NAME__
33966         - name: interface-name
33967           in: path
33968           description: Name given to the interface
33969           required: true
33970           type: string
33971           example: __INTERFACE-NAME__
33972         - name: vlan-interface
33973           in: path
33974           description: String that identifies the interface
33975           required: true
33976           type: string
33977           example: __VLAN-INTERFACE__
33978         - name: l3-interface-ipv6-address
33979           in: path
33980           description: IP address
33981           required: true
33982           type: string
33983           example: __L3-INTERFACE-IPV6-ADDRESS__
33984         - name: resource-version
33985           in: query
33986           description: resource-version for concurrency
33987           required: true
33988           type: string
33989   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
33990     get:
33991       tags:
33992         - Network
33993       summary: returns vlan
33994       description: returns vlan
33995       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
33996       produces:
33997         - application/json
33998         - application/xml
33999       responses:
34000         "200":
34001           description: successful operation
34002           schema:
34003               $ref: "#/getDefinitions/vlan"
34004         "default":
34005           description: Response codes found in [response codes](https://wiki.onap.org/).
34006       parameters:
34007         - name: vnf-id
34008           in: path
34009           description: Unique id of VNF.  This is unique across the graph.
34010           required: true
34011           type: string
34012           example: __VNF-ID__
34013         - name: interface-name
34014           in: path
34015           description: Name that identifies the link aggregate interface
34016           required: true
34017           type: string
34018           example: __INTERFACE-NAME__
34019         - name: interface-name
34020           in: path
34021           description: Name given to the interface
34022           required: true
34023           type: string
34024           example: __INTERFACE-NAME__
34025         - name: vlan-interface
34026           in: path
34027           description: String that identifies the interface
34028           required: true
34029           type: string
34030           example: __VLAN-INTERFACE__
34031     put:
34032       tags:
34033         - Network
34034       summary: create or update an existing vlan
34035       description: |
34036         Create or update an existing vlan.
34037         #
34038         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34039       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34040       consumes:
34041         - application/json
34042         - application/xml
34043       produces:
34044         - application/json
34045         - application/xml
34046       responses:
34047         "default":
34048           description: Response codes found in [response codes](https://wiki.onap.org/).
34049       parameters:
34050         - name: vnf-id
34051           in: path
34052           description: Unique id of VNF.  This is unique across the graph.
34053           required: true
34054           type: string
34055           example: __VNF-ID__
34056         - name: interface-name
34057           in: path
34058           description: Name that identifies the link aggregate interface
34059           required: true
34060           type: string
34061           example: __INTERFACE-NAME__
34062         - name: interface-name
34063           in: path
34064           description: Name given to the interface
34065           required: true
34066           type: string
34067           example: __INTERFACE-NAME__
34068         - name: vlan-interface
34069           in: path
34070           description: String that identifies the interface
34071           required: true
34072           type: string
34073           example: __VLAN-INTERFACE__
34074         - name: body
34075           in: body
34076           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
34077           required: true
34078           schema:
34079             $ref: "#/definitions/vlan"
34080     patch:
34081       tags:
34082         - Network
34083       summary: update an existing vlan
34084       description: |
34085         Update an existing vlan
34086         #
34087         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34088         The PUT operation will entirely replace an existing object.
34089         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34090         #
34091         Other differences between PUT and PATCH are:
34092         #
34093         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34094         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34095         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34096       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34097       consumes:
34098         - application/json
34099         - application/xml
34100       produces:
34101         - application/json
34102         - application/xml
34103       responses:
34104         "default":
34105           description: Response codes found in [response codes](https://wiki.onap.org/).
34106       parameters:
34107         - name: vnf-id
34108           in: path
34109           description: Unique id of VNF.  This is unique across the graph.
34110           required: true
34111           type: string
34112           example: __VNF-ID__
34113         - name: interface-name
34114           in: path
34115           description: Name that identifies the link aggregate interface
34116           required: true
34117           type: string
34118           example: __INTERFACE-NAME__
34119         - name: interface-name
34120           in: path
34121           description: Name given to the interface
34122           required: true
34123           type: string
34124           example: __INTERFACE-NAME__
34125         - name: vlan-interface
34126           in: path
34127           description: String that identifies the interface
34128           required: true
34129           type: string
34130           example: __VLAN-INTERFACE__
34131         - name: body
34132           in: body
34133           description: vlan object that needs to be updated.
34134           required: true
34135           schema:
34136             $ref: "#/patchDefinitions/vlan"
34137     delete:
34138       tags:
34139         - Network
34140       summary: delete an existing vlan
34141       description: delete an existing vlan
34142       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34143       consumes:
34144         - application/json
34145         - application/xml
34146       produces:
34147         - application/json
34148         - application/xml
34149       responses:
34150         "default":
34151           description: Response codes found in [response codes](https://wiki.onap.org/).
34152       parameters:
34153         - name: vnf-id
34154           in: path
34155           description: Unique id of VNF.  This is unique across the graph.
34156           required: true
34157           type: string
34158           example: __VNF-ID__
34159         - name: interface-name
34160           in: path
34161           description: Name that identifies the link aggregate interface
34162           required: true
34163           type: string
34164           example: __INTERFACE-NAME__
34165         - name: interface-name
34166           in: path
34167           description: Name given to the interface
34168           required: true
34169           type: string
34170           example: __INTERFACE-NAME__
34171         - name: vlan-interface
34172           in: path
34173           description: String that identifies the interface
34174           required: true
34175           type: string
34176           example: __VLAN-INTERFACE__
34177         - name: resource-version
34178           in: query
34179           description: resource-version for concurrency
34180           required: true
34181           type: string
34182   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
34183     get:
34184       tags:
34185         - Network
34186       summary: returns vlans
34187       description: returns vlans
34188       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
34189       produces:
34190         - application/json
34191         - application/xml
34192       responses:
34193         "200":
34194           description: successful operation
34195           schema:
34196               $ref: "#/getDefinitions/vlans"
34197         "default":
34198           description: Response codes found in [response codes](https://wiki.onap.org/).
34199       parameters:
34200         - name: vnf-id
34201           in: path
34202           description: Unique id of VNF.  This is unique across the graph.
34203           required: true
34204           type: string
34205           example: __VNF-ID__
34206         - name: interface-name
34207           in: path
34208           description: Name that identifies the link aggregate interface
34209           required: true
34210           type: string
34211           example: __INTERFACE-NAME__
34212         - name: interface-name
34213           in: path
34214           description: Name given to the interface
34215           required: true
34216           type: string
34217           example: __INTERFACE-NAME__
34218         - name: vlan-interface
34219           in: query
34220           description:
34221           required: false
34222           type: string
34223         - name: vlan-id-inner
34224           in: query
34225           description:
34226           required: false
34227           type: integer
34228           format: int64
34229         - name: vpn-key
34230           in: query
34231           description:
34232           required: false
34233           type: string
34234   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
34235     put:
34236       tags:
34237         - Network
34238       summary: see node definition for valid relationships
34239       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
34240       consumes:
34241         - application/json
34242         - application/xml
34243       produces:
34244         - application/json
34245         - application/xml
34246       responses:
34247         "default":
34248           description: Response codes found in [response codes](https://wiki.onap.org/).
34249       parameters:
34250         - name: vnf-id
34251           in: path
34252           description: Unique id of VNF.  This is unique across the graph.
34253           required: true
34254           type: string
34255           example: __VNF-ID__
34256         - name: interface-name
34257           in: path
34258           description: Name that identifies the link aggregate interface
34259           required: true
34260           type: string
34261           example: __INTERFACE-NAME__
34262         - name: interface-name
34263           in: path
34264           description: Name given to the interface
34265           required: true
34266           type: string
34267           example: __INTERFACE-NAME__
34268         - name: pci-id
34269           in: path
34270           description: PCI ID used to identify the sriov-vf
34271           required: true
34272           type: string
34273           example: __PCI-ID__
34274         - name: body
34275           in: body
34276           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
34277           required: true
34278           schema:
34279             $ref: "#/definitions/relationship"
34280     delete:
34281       tags:
34282         - Network
34283       summary: delete an existing relationship
34284       description: delete an existing relationship
34285       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
34286       consumes:
34287         - application/json
34288         - application/xml
34289       produces:
34290         - application/json
34291         - application/xml
34292       responses:
34293         "default":
34294           description: Response codes found in [response codes](https://wiki.onap.org/).
34295       parameters:
34296         - name: vnf-id
34297           in: path
34298           description: Unique id of VNF.  This is unique across the graph.
34299           required: true
34300           type: string
34301           example: __VNF-ID__
34302         - name: interface-name
34303           in: path
34304           description: Name that identifies the link aggregate interface
34305           required: true
34306           type: string
34307           example: __INTERFACE-NAME__
34308         - name: interface-name
34309           in: path
34310           description: Name given to the interface
34311           required: true
34312           type: string
34313           example: __INTERFACE-NAME__
34314         - name: pci-id
34315           in: path
34316           description: PCI ID used to identify the sriov-vf
34317           required: true
34318           type: string
34319           example: __PCI-ID__
34320   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
34321     get:
34322       tags:
34323         - Network
34324       summary: returns sriov-vf
34325       description: returns sriov-vf
34326       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34327       produces:
34328         - application/json
34329         - application/xml
34330       responses:
34331         "200":
34332           description: successful operation
34333           schema:
34334               $ref: "#/getDefinitions/sriov-vf"
34335         "default":
34336           description: Response codes found in [response codes](https://wiki.onap.org/).
34337       parameters:
34338         - name: vnf-id
34339           in: path
34340           description: Unique id of VNF.  This is unique across the graph.
34341           required: true
34342           type: string
34343           example: __VNF-ID__
34344         - name: interface-name
34345           in: path
34346           description: Name that identifies the link aggregate interface
34347           required: true
34348           type: string
34349           example: __INTERFACE-NAME__
34350         - name: interface-name
34351           in: path
34352           description: Name given to the interface
34353           required: true
34354           type: string
34355           example: __INTERFACE-NAME__
34356         - name: pci-id
34357           in: path
34358           description: PCI ID used to identify the sriov-vf
34359           required: true
34360           type: string
34361           example: __PCI-ID__
34362     put:
34363       tags:
34364         - Network
34365       summary: create or update an existing sriov-vf
34366       description: |
34367         Create or update an existing sriov-vf.
34368         #
34369         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34370       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34371       consumes:
34372         - application/json
34373         - application/xml
34374       produces:
34375         - application/json
34376         - application/xml
34377       responses:
34378         "default":
34379           description: Response codes found in [response codes](https://wiki.onap.org/).
34380       parameters:
34381         - name: vnf-id
34382           in: path
34383           description: Unique id of VNF.  This is unique across the graph.
34384           required: true
34385           type: string
34386           example: __VNF-ID__
34387         - name: interface-name
34388           in: path
34389           description: Name that identifies the link aggregate interface
34390           required: true
34391           type: string
34392           example: __INTERFACE-NAME__
34393         - name: interface-name
34394           in: path
34395           description: Name given to the interface
34396           required: true
34397           type: string
34398           example: __INTERFACE-NAME__
34399         - name: pci-id
34400           in: path
34401           description: PCI ID used to identify the sriov-vf
34402           required: true
34403           type: string
34404           example: __PCI-ID__
34405         - name: body
34406           in: body
34407           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
34408           required: true
34409           schema:
34410             $ref: "#/definitions/sriov-vf"
34411     patch:
34412       tags:
34413         - Network
34414       summary: update an existing sriov-vf
34415       description: |
34416         Update an existing sriov-vf
34417         #
34418         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34419         The PUT operation will entirely replace an existing object.
34420         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34421         #
34422         Other differences between PUT and PATCH are:
34423         #
34424         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34425         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34426         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34427       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34428       consumes:
34429         - application/json
34430         - application/xml
34431       produces:
34432         - application/json
34433         - application/xml
34434       responses:
34435         "default":
34436           description: Response codes found in [response codes](https://wiki.onap.org/).
34437       parameters:
34438         - name: vnf-id
34439           in: path
34440           description: Unique id of VNF.  This is unique across the graph.
34441           required: true
34442           type: string
34443           example: __VNF-ID__
34444         - name: interface-name
34445           in: path
34446           description: Name that identifies the link aggregate interface
34447           required: true
34448           type: string
34449           example: __INTERFACE-NAME__
34450         - name: interface-name
34451           in: path
34452           description: Name given to the interface
34453           required: true
34454           type: string
34455           example: __INTERFACE-NAME__
34456         - name: pci-id
34457           in: path
34458           description: PCI ID used to identify the sriov-vf
34459           required: true
34460           type: string
34461           example: __PCI-ID__
34462         - name: body
34463           in: body
34464           description: sriov-vf object that needs to be updated.
34465           required: true
34466           schema:
34467             $ref: "#/patchDefinitions/sriov-vf"
34468     delete:
34469       tags:
34470         - Network
34471       summary: delete an existing sriov-vf
34472       description: delete an existing sriov-vf
34473       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34474       consumes:
34475         - application/json
34476         - application/xml
34477       produces:
34478         - application/json
34479         - application/xml
34480       responses:
34481         "default":
34482           description: Response codes found in [response codes](https://wiki.onap.org/).
34483       parameters:
34484         - name: vnf-id
34485           in: path
34486           description: Unique id of VNF.  This is unique across the graph.
34487           required: true
34488           type: string
34489           example: __VNF-ID__
34490         - name: interface-name
34491           in: path
34492           description: Name that identifies the link aggregate interface
34493           required: true
34494           type: string
34495           example: __INTERFACE-NAME__
34496         - name: interface-name
34497           in: path
34498           description: Name given to the interface
34499           required: true
34500           type: string
34501           example: __INTERFACE-NAME__
34502         - name: pci-id
34503           in: path
34504           description: PCI ID used to identify the sriov-vf
34505           required: true
34506           type: string
34507           example: __PCI-ID__
34508         - name: resource-version
34509           in: query
34510           description: resource-version for concurrency
34511           required: true
34512           type: string
34513   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
34514     get:
34515       tags:
34516         - Network
34517       summary: returns sriov-vfs
34518       description: returns sriov-vfs
34519       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
34520       produces:
34521         - application/json
34522         - application/xml
34523       responses:
34524         "200":
34525           description: successful operation
34526           schema:
34527               $ref: "#/getDefinitions/sriov-vfs"
34528         "default":
34529           description: Response codes found in [response codes](https://wiki.onap.org/).
34530       parameters:
34531         - name: vnf-id
34532           in: path
34533           description: Unique id of VNF.  This is unique across the graph.
34534           required: true
34535           type: string
34536           example: __VNF-ID__
34537         - name: interface-name
34538           in: path
34539           description: Name that identifies the link aggregate interface
34540           required: true
34541           type: string
34542           example: __INTERFACE-NAME__
34543         - name: interface-name
34544           in: path
34545           description: Name given to the interface
34546           required: true
34547           type: string
34548           example: __INTERFACE-NAME__
34549         - name: pci-id
34550           in: query
34551           description:
34552           required: false
34553           type: string
34554         - name: vf-vlan-filter
34555           in: query
34556           description:
34557           required: false
34558           type: string
34559         - name: vf-mac-filter
34560           in: query
34561           description:
34562           required: false
34563           type: string
34564         - name: vf-vlan-strip
34565           in: query
34566           description:
34567           required: false
34568           type: boolean
34569         - name: neutron-network-id
34570           in: query
34571           description:
34572           required: false
34573           type: string
34574   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
34575     put:
34576       tags:
34577         - Network
34578       summary: see node definition for valid relationships
34579       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
34580       consumes:
34581         - application/json
34582         - application/xml
34583       produces:
34584         - application/json
34585         - application/xml
34586       responses:
34587         "default":
34588           description: Response codes found in [response codes](https://wiki.onap.org/).
34589       parameters:
34590         - name: vnf-id
34591           in: path
34592           description: Unique id of VNF.  This is unique across the graph.
34593           required: true
34594           type: string
34595           example: __VNF-ID__
34596         - name: interface-name
34597           in: path
34598           description: Name that identifies the link aggregate interface
34599           required: true
34600           type: string
34601           example: __INTERFACE-NAME__
34602         - name: interface-name
34603           in: path
34604           description: Name given to the interface
34605           required: true
34606           type: string
34607           example: __INTERFACE-NAME__
34608         - name: body
34609           in: body
34610           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
34611           required: true
34612           schema:
34613             $ref: "#/definitions/relationship"
34614     delete:
34615       tags:
34616         - Network
34617       summary: delete an existing relationship
34618       description: delete an existing relationship
34619       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
34620       consumes:
34621         - application/json
34622         - application/xml
34623       produces:
34624         - application/json
34625         - application/xml
34626       responses:
34627         "default":
34628           description: Response codes found in [response codes](https://wiki.onap.org/).
34629       parameters:
34630         - name: vnf-id
34631           in: path
34632           description: Unique id of VNF.  This is unique across the graph.
34633           required: true
34634           type: string
34635           example: __VNF-ID__
34636         - name: interface-name
34637           in: path
34638           description: Name that identifies the link aggregate interface
34639           required: true
34640           type: string
34641           example: __INTERFACE-NAME__
34642         - name: interface-name
34643           in: path
34644           description: Name given to the interface
34645           required: true
34646           type: string
34647           example: __INTERFACE-NAME__
34648   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
34649     put:
34650       tags:
34651         - Network
34652       summary: see node definition for valid relationships
34653       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
34654       consumes:
34655         - application/json
34656         - application/xml
34657       produces:
34658         - application/json
34659         - application/xml
34660       responses:
34661         "default":
34662           description: Response codes found in [response codes](https://wiki.onap.org/).
34663       parameters:
34664         - name: vnf-id
34665           in: path
34666           description: Unique id of VNF.  This is unique across the graph.
34667           required: true
34668           type: string
34669           example: __VNF-ID__
34670         - name: interface-name
34671           in: path
34672           description: Name that identifies the link aggregate interface
34673           required: true
34674           type: string
34675           example: __INTERFACE-NAME__
34676         - name: interface-name
34677           in: path
34678           description: Name given to the interface
34679           required: true
34680           type: string
34681           example: __INTERFACE-NAME__
34682         - name: l3-interface-ipv4-address
34683           in: path
34684           description: IP address
34685           required: true
34686           type: string
34687           example: __L3-INTERFACE-IPV4-ADDRESS__
34688         - name: body
34689           in: body
34690           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
34691           required: true
34692           schema:
34693             $ref: "#/definitions/relationship"
34694     delete:
34695       tags:
34696         - Network
34697       summary: delete an existing relationship
34698       description: delete an existing relationship
34699       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
34700       consumes:
34701         - application/json
34702         - application/xml
34703       produces:
34704         - application/json
34705         - application/xml
34706       responses:
34707         "default":
34708           description: Response codes found in [response codes](https://wiki.onap.org/).
34709       parameters:
34710         - name: vnf-id
34711           in: path
34712           description: Unique id of VNF.  This is unique across the graph.
34713           required: true
34714           type: string
34715           example: __VNF-ID__
34716         - name: interface-name
34717           in: path
34718           description: Name that identifies the link aggregate interface
34719           required: true
34720           type: string
34721           example: __INTERFACE-NAME__
34722         - name: interface-name
34723           in: path
34724           description: Name given to the interface
34725           required: true
34726           type: string
34727           example: __INTERFACE-NAME__
34728         - name: l3-interface-ipv4-address
34729           in: path
34730           description: IP address
34731           required: true
34732           type: string
34733           example: __L3-INTERFACE-IPV4-ADDRESS__
34734   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
34735     get:
34736       tags:
34737         - Network
34738       summary: returns l3-interface-ipv4-address-list
34739       description: returns l3-interface-ipv4-address-list
34740       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34741       produces:
34742         - application/json
34743         - application/xml
34744       responses:
34745         "200":
34746           description: successful operation
34747           schema:
34748               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
34749         "default":
34750           description: Response codes found in [response codes](https://wiki.onap.org/).
34751       parameters:
34752         - name: vnf-id
34753           in: path
34754           description: Unique id of VNF.  This is unique across the graph.
34755           required: true
34756           type: string
34757           example: __VNF-ID__
34758         - name: interface-name
34759           in: path
34760           description: Name that identifies the link aggregate interface
34761           required: true
34762           type: string
34763           example: __INTERFACE-NAME__
34764         - name: interface-name
34765           in: path
34766           description: Name given to the interface
34767           required: true
34768           type: string
34769           example: __INTERFACE-NAME__
34770         - name: l3-interface-ipv4-address
34771           in: path
34772           description: IP address
34773           required: true
34774           type: string
34775           example: __L3-INTERFACE-IPV4-ADDRESS__
34776     put:
34777       tags:
34778         - Network
34779       summary: create or update an existing l3-interface-ipv4-address-list
34780       description: |
34781         Create or update an existing l3-interface-ipv4-address-list.
34782         #
34783         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34784       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34785       consumes:
34786         - application/json
34787         - application/xml
34788       produces:
34789         - application/json
34790         - application/xml
34791       responses:
34792         "default":
34793           description: Response codes found in [response codes](https://wiki.onap.org/).
34794       parameters:
34795         - name: vnf-id
34796           in: path
34797           description: Unique id of VNF.  This is unique across the graph.
34798           required: true
34799           type: string
34800           example: __VNF-ID__
34801         - name: interface-name
34802           in: path
34803           description: Name that identifies the link aggregate interface
34804           required: true
34805           type: string
34806           example: __INTERFACE-NAME__
34807         - name: interface-name
34808           in: path
34809           description: Name given to the interface
34810           required: true
34811           type: string
34812           example: __INTERFACE-NAME__
34813         - name: l3-interface-ipv4-address
34814           in: path
34815           description: IP address
34816           required: true
34817           type: string
34818           example: __L3-INTERFACE-IPV4-ADDRESS__
34819         - name: body
34820           in: body
34821           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
34822           required: true
34823           schema:
34824             $ref: "#/definitions/l3-interface-ipv4-address-list"
34825     patch:
34826       tags:
34827         - Network
34828       summary: update an existing l3-interface-ipv4-address-list
34829       description: |
34830         Update an existing l3-interface-ipv4-address-list
34831         #
34832         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34833         The PUT operation will entirely replace an existing object.
34834         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34835         #
34836         Other differences between PUT and PATCH are:
34837         #
34838         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34839         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34840         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34841       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34842       consumes:
34843         - application/json
34844         - application/xml
34845       produces:
34846         - application/json
34847         - application/xml
34848       responses:
34849         "default":
34850           description: Response codes found in [response codes](https://wiki.onap.org/).
34851       parameters:
34852         - name: vnf-id
34853           in: path
34854           description: Unique id of VNF.  This is unique across the graph.
34855           required: true
34856           type: string
34857           example: __VNF-ID__
34858         - name: interface-name
34859           in: path
34860           description: Name that identifies the link aggregate interface
34861           required: true
34862           type: string
34863           example: __INTERFACE-NAME__
34864         - name: interface-name
34865           in: path
34866           description: Name given to the interface
34867           required: true
34868           type: string
34869           example: __INTERFACE-NAME__
34870         - name: l3-interface-ipv4-address
34871           in: path
34872           description: IP address
34873           required: true
34874           type: string
34875           example: __L3-INTERFACE-IPV4-ADDRESS__
34876         - name: body
34877           in: body
34878           description: l3-interface-ipv4-address-list object that needs to be updated.
34879           required: true
34880           schema:
34881             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
34882     delete:
34883       tags:
34884         - Network
34885       summary: delete an existing l3-interface-ipv4-address-list
34886       description: delete an existing l3-interface-ipv4-address-list
34887       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34888       consumes:
34889         - application/json
34890         - application/xml
34891       produces:
34892         - application/json
34893         - application/xml
34894       responses:
34895         "default":
34896           description: Response codes found in [response codes](https://wiki.onap.org/).
34897       parameters:
34898         - name: vnf-id
34899           in: path
34900           description: Unique id of VNF.  This is unique across the graph.
34901           required: true
34902           type: string
34903           example: __VNF-ID__
34904         - name: interface-name
34905           in: path
34906           description: Name that identifies the link aggregate interface
34907           required: true
34908           type: string
34909           example: __INTERFACE-NAME__
34910         - name: interface-name
34911           in: path
34912           description: Name given to the interface
34913           required: true
34914           type: string
34915           example: __INTERFACE-NAME__
34916         - name: l3-interface-ipv4-address
34917           in: path
34918           description: IP address
34919           required: true
34920           type: string
34921           example: __L3-INTERFACE-IPV4-ADDRESS__
34922         - name: resource-version
34923           in: query
34924           description: resource-version for concurrency
34925           required: true
34926           type: string
34927   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
34928     put:
34929       tags:
34930         - Network
34931       summary: see node definition for valid relationships
34932       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34933       consumes:
34934         - application/json
34935         - application/xml
34936       produces:
34937         - application/json
34938         - application/xml
34939       responses:
34940         "default":
34941           description: Response codes found in [response codes](https://wiki.onap.org/).
34942       parameters:
34943         - name: vnf-id
34944           in: path
34945           description: Unique id of VNF.  This is unique across the graph.
34946           required: true
34947           type: string
34948           example: __VNF-ID__
34949         - name: interface-name
34950           in: path
34951           description: Name that identifies the link aggregate interface
34952           required: true
34953           type: string
34954           example: __INTERFACE-NAME__
34955         - name: interface-name
34956           in: path
34957           description: Name given to the interface
34958           required: true
34959           type: string
34960           example: __INTERFACE-NAME__
34961         - name: l3-interface-ipv6-address
34962           in: path
34963           description: IP address
34964           required: true
34965           type: string
34966           example: __L3-INTERFACE-IPV6-ADDRESS__
34967         - name: body
34968           in: body
34969           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
34970           required: true
34971           schema:
34972             $ref: "#/definitions/relationship"
34973     delete:
34974       tags:
34975         - Network
34976       summary: delete an existing relationship
34977       description: delete an existing relationship
34978       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34979       consumes:
34980         - application/json
34981         - application/xml
34982       produces:
34983         - application/json
34984         - application/xml
34985       responses:
34986         "default":
34987           description: Response codes found in [response codes](https://wiki.onap.org/).
34988       parameters:
34989         - name: vnf-id
34990           in: path
34991           description: Unique id of VNF.  This is unique across the graph.
34992           required: true
34993           type: string
34994           example: __VNF-ID__
34995         - name: interface-name
34996           in: path
34997           description: Name that identifies the link aggregate interface
34998           required: true
34999           type: string
35000           example: __INTERFACE-NAME__
35001         - name: interface-name
35002           in: path
35003           description: Name given to the interface
35004           required: true
35005           type: string
35006           example: __INTERFACE-NAME__
35007         - name: l3-interface-ipv6-address
35008           in: path
35009           description: IP address
35010           required: true
35011           type: string
35012           example: __L3-INTERFACE-IPV6-ADDRESS__
35013   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
35014     get:
35015       tags:
35016         - Network
35017       summary: returns l3-interface-ipv6-address-list
35018       description: returns l3-interface-ipv6-address-list
35019       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35020       produces:
35021         - application/json
35022         - application/xml
35023       responses:
35024         "200":
35025           description: successful operation
35026           schema:
35027               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35028         "default":
35029           description: Response codes found in [response codes](https://wiki.onap.org/).
35030       parameters:
35031         - name: vnf-id
35032           in: path
35033           description: Unique id of VNF.  This is unique across the graph.
35034           required: true
35035           type: string
35036           example: __VNF-ID__
35037         - name: interface-name
35038           in: path
35039           description: Name that identifies the link aggregate interface
35040           required: true
35041           type: string
35042           example: __INTERFACE-NAME__
35043         - name: interface-name
35044           in: path
35045           description: Name given to the interface
35046           required: true
35047           type: string
35048           example: __INTERFACE-NAME__
35049         - name: l3-interface-ipv6-address
35050           in: path
35051           description: IP address
35052           required: true
35053           type: string
35054           example: __L3-INTERFACE-IPV6-ADDRESS__
35055     put:
35056       tags:
35057         - Network
35058       summary: create or update an existing l3-interface-ipv6-address-list
35059       description: |
35060         Create or update an existing l3-interface-ipv6-address-list.
35061         #
35062         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35063       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35064       consumes:
35065         - application/json
35066         - application/xml
35067       produces:
35068         - application/json
35069         - application/xml
35070       responses:
35071         "default":
35072           description: Response codes found in [response codes](https://wiki.onap.org/).
35073       parameters:
35074         - name: vnf-id
35075           in: path
35076           description: Unique id of VNF.  This is unique across the graph.
35077           required: true
35078           type: string
35079           example: __VNF-ID__
35080         - name: interface-name
35081           in: path
35082           description: Name that identifies the link aggregate interface
35083           required: true
35084           type: string
35085           example: __INTERFACE-NAME__
35086         - name: interface-name
35087           in: path
35088           description: Name given to the interface
35089           required: true
35090           type: string
35091           example: __INTERFACE-NAME__
35092         - name: l3-interface-ipv6-address
35093           in: path
35094           description: IP address
35095           required: true
35096           type: string
35097           example: __L3-INTERFACE-IPV6-ADDRESS__
35098         - name: body
35099           in: body
35100           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
35101           required: true
35102           schema:
35103             $ref: "#/definitions/l3-interface-ipv6-address-list"
35104     patch:
35105       tags:
35106         - Network
35107       summary: update an existing l3-interface-ipv6-address-list
35108       description: |
35109         Update an existing l3-interface-ipv6-address-list
35110         #
35111         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35112         The PUT operation will entirely replace an existing object.
35113         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35114         #
35115         Other differences between PUT and PATCH are:
35116         #
35117         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35118         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35119         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35120       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35121       consumes:
35122         - application/json
35123         - application/xml
35124       produces:
35125         - application/json
35126         - application/xml
35127       responses:
35128         "default":
35129           description: Response codes found in [response codes](https://wiki.onap.org/).
35130       parameters:
35131         - name: vnf-id
35132           in: path
35133           description: Unique id of VNF.  This is unique across the graph.
35134           required: true
35135           type: string
35136           example: __VNF-ID__
35137         - name: interface-name
35138           in: path
35139           description: Name that identifies the link aggregate interface
35140           required: true
35141           type: string
35142           example: __INTERFACE-NAME__
35143         - name: interface-name
35144           in: path
35145           description: Name given to the interface
35146           required: true
35147           type: string
35148           example: __INTERFACE-NAME__
35149         - name: l3-interface-ipv6-address
35150           in: path
35151           description: IP address
35152           required: true
35153           type: string
35154           example: __L3-INTERFACE-IPV6-ADDRESS__
35155         - name: body
35156           in: body
35157           description: l3-interface-ipv6-address-list object that needs to be updated.
35158           required: true
35159           schema:
35160             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
35161     delete:
35162       tags:
35163         - Network
35164       summary: delete an existing l3-interface-ipv6-address-list
35165       description: delete an existing l3-interface-ipv6-address-list
35166       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35167       consumes:
35168         - application/json
35169         - application/xml
35170       produces:
35171         - application/json
35172         - application/xml
35173       responses:
35174         "default":
35175           description: Response codes found in [response codes](https://wiki.onap.org/).
35176       parameters:
35177         - name: vnf-id
35178           in: path
35179           description: Unique id of VNF.  This is unique across the graph.
35180           required: true
35181           type: string
35182           example: __VNF-ID__
35183         - name: interface-name
35184           in: path
35185           description: Name that identifies the link aggregate interface
35186           required: true
35187           type: string
35188           example: __INTERFACE-NAME__
35189         - name: interface-name
35190           in: path
35191           description: Name given to the interface
35192           required: true
35193           type: string
35194           example: __INTERFACE-NAME__
35195         - name: l3-interface-ipv6-address
35196           in: path
35197           description: IP address
35198           required: true
35199           type: string
35200           example: __L3-INTERFACE-IPV6-ADDRESS__
35201         - name: resource-version
35202           in: query
35203           description: resource-version for concurrency
35204           required: true
35205           type: string
35206   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
35207     get:
35208       tags:
35209         - Network
35210       summary: returns l-interface
35211       description: returns l-interface
35212       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35213       produces:
35214         - application/json
35215         - application/xml
35216       responses:
35217         "200":
35218           description: successful operation
35219           schema:
35220               $ref: "#/getDefinitions/l-interface"
35221         "default":
35222           description: Response codes found in [response codes](https://wiki.onap.org/).
35223       parameters:
35224         - name: vnf-id
35225           in: path
35226           description: Unique id of VNF.  This is unique across the graph.
35227           required: true
35228           type: string
35229           example: __VNF-ID__
35230         - name: interface-name
35231           in: path
35232           description: Name that identifies the link aggregate interface
35233           required: true
35234           type: string
35235           example: __INTERFACE-NAME__
35236         - name: interface-name
35237           in: path
35238           description: Name given to the interface
35239           required: true
35240           type: string
35241           example: __INTERFACE-NAME__
35242     put:
35243       tags:
35244         - Network
35245       summary: create or update an existing l-interface
35246       description: |
35247         Create or update an existing l-interface.
35248         #
35249         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35250       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35251       consumes:
35252         - application/json
35253         - application/xml
35254       produces:
35255         - application/json
35256         - application/xml
35257       responses:
35258         "default":
35259           description: Response codes found in [response codes](https://wiki.onap.org/).
35260       parameters:
35261         - name: vnf-id
35262           in: path
35263           description: Unique id of VNF.  This is unique across the graph.
35264           required: true
35265           type: string
35266           example: __VNF-ID__
35267         - name: interface-name
35268           in: path
35269           description: Name that identifies the link aggregate interface
35270           required: true
35271           type: string
35272           example: __INTERFACE-NAME__
35273         - name: interface-name
35274           in: path
35275           description: Name given to the interface
35276           required: true
35277           type: string
35278           example: __INTERFACE-NAME__
35279         - name: body
35280           in: body
35281           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
35282           required: true
35283           schema:
35284             $ref: "#/definitions/l-interface"
35285     patch:
35286       tags:
35287         - Network
35288       summary: update an existing l-interface
35289       description: |
35290         Update an existing l-interface
35291         #
35292         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35293         The PUT operation will entirely replace an existing object.
35294         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35295         #
35296         Other differences between PUT and PATCH are:
35297         #
35298         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35299         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35300         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35301       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35302       consumes:
35303         - application/json
35304         - application/xml
35305       produces:
35306         - application/json
35307         - application/xml
35308       responses:
35309         "default":
35310           description: Response codes found in [response codes](https://wiki.onap.org/).
35311       parameters:
35312         - name: vnf-id
35313           in: path
35314           description: Unique id of VNF.  This is unique across the graph.
35315           required: true
35316           type: string
35317           example: __VNF-ID__
35318         - name: interface-name
35319           in: path
35320           description: Name that identifies the link aggregate interface
35321           required: true
35322           type: string
35323           example: __INTERFACE-NAME__
35324         - name: interface-name
35325           in: path
35326           description: Name given to the interface
35327           required: true
35328           type: string
35329           example: __INTERFACE-NAME__
35330         - name: body
35331           in: body
35332           description: l-interface object that needs to be updated.
35333           required: true
35334           schema:
35335             $ref: "#/patchDefinitions/l-interface"
35336     delete:
35337       tags:
35338         - Network
35339       summary: delete an existing l-interface
35340       description: delete an existing l-interface
35341       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35342       consumes:
35343         - application/json
35344         - application/xml
35345       produces:
35346         - application/json
35347         - application/xml
35348       responses:
35349         "default":
35350           description: Response codes found in [response codes](https://wiki.onap.org/).
35351       parameters:
35352         - name: vnf-id
35353           in: path
35354           description: Unique id of VNF.  This is unique across the graph.
35355           required: true
35356           type: string
35357           example: __VNF-ID__
35358         - name: interface-name
35359           in: path
35360           description: Name that identifies the link aggregate interface
35361           required: true
35362           type: string
35363           example: __INTERFACE-NAME__
35364         - name: interface-name
35365           in: path
35366           description: Name given to the interface
35367           required: true
35368           type: string
35369           example: __INTERFACE-NAME__
35370         - name: resource-version
35371           in: query
35372           description: resource-version for concurrency
35373           required: true
35374           type: string
35375   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
35376     get:
35377       tags:
35378         - Network
35379       summary: returns l-interfaces
35380       description: returns l-interfaces
35381       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
35382       produces:
35383         - application/json
35384         - application/xml
35385       responses:
35386         "200":
35387           description: successful operation
35388           schema:
35389               $ref: "#/getDefinitions/l-interfaces"
35390         "default":
35391           description: Response codes found in [response codes](https://wiki.onap.org/).
35392       parameters:
35393         - name: vnf-id
35394           in: path
35395           description: Unique id of VNF.  This is unique across the graph.
35396           required: true
35397           type: string
35398           example: __VNF-ID__
35399         - name: interface-name
35400           in: path
35401           description: Name that identifies the link aggregate interface
35402           required: true
35403           type: string
35404           example: __INTERFACE-NAME__
35405         - name: interface-name
35406           in: query
35407           description:
35408           required: false
35409           type: string
35410         - name: interface-id
35411           in: query
35412           description:
35413           required: false
35414           type: string
35415         - name: macaddr
35416           in: query
35417           description:
35418           required: false
35419           type: string
35420         - name: network-name
35421           in: query
35422           description:
35423           required: false
35424           type: string
35425   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
35426     get:
35427       tags:
35428         - Network
35429       summary: returns lag-interface
35430       description: returns lag-interface
35431       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35432       produces:
35433         - application/json
35434         - application/xml
35435       responses:
35436         "200":
35437           description: successful operation
35438           schema:
35439               $ref: "#/getDefinitions/lag-interface"
35440         "default":
35441           description: Response codes found in [response codes](https://wiki.onap.org/).
35442       parameters:
35443         - name: vnf-id
35444           in: path
35445           description: Unique id of VNF.  This is unique across the graph.
35446           required: true
35447           type: string
35448           example: __VNF-ID__
35449         - name: interface-name
35450           in: path
35451           description: Name that identifies the link aggregate interface
35452           required: true
35453           type: string
35454           example: __INTERFACE-NAME__
35455     put:
35456       tags:
35457         - Network
35458       summary: create or update an existing lag-interface
35459       description: |
35460         Create or update an existing lag-interface.
35461         #
35462         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35463       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35464       consumes:
35465         - application/json
35466         - application/xml
35467       produces:
35468         - application/json
35469         - application/xml
35470       responses:
35471         "default":
35472           description: Response codes found in [response codes](https://wiki.onap.org/).
35473       parameters:
35474         - name: vnf-id
35475           in: path
35476           description: Unique id of VNF.  This is unique across the graph.
35477           required: true
35478           type: string
35479           example: __VNF-ID__
35480         - name: interface-name
35481           in: path
35482           description: Name that identifies the link aggregate interface
35483           required: true
35484           type: string
35485           example: __INTERFACE-NAME__
35486         - name: body
35487           in: body
35488           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
35489           required: true
35490           schema:
35491             $ref: "#/definitions/lag-interface"
35492     patch:
35493       tags:
35494         - Network
35495       summary: update an existing lag-interface
35496       description: |
35497         Update an existing lag-interface
35498         #
35499         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35500         The PUT operation will entirely replace an existing object.
35501         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35502         #
35503         Other differences between PUT and PATCH are:
35504         #
35505         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35506         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35507         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35508       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35509       consumes:
35510         - application/json
35511         - application/xml
35512       produces:
35513         - application/json
35514         - application/xml
35515       responses:
35516         "default":
35517           description: Response codes found in [response codes](https://wiki.onap.org/).
35518       parameters:
35519         - name: vnf-id
35520           in: path
35521           description: Unique id of VNF.  This is unique across the graph.
35522           required: true
35523           type: string
35524           example: __VNF-ID__
35525         - name: interface-name
35526           in: path
35527           description: Name that identifies the link aggregate interface
35528           required: true
35529           type: string
35530           example: __INTERFACE-NAME__
35531         - name: body
35532           in: body
35533           description: lag-interface object that needs to be updated.
35534           required: true
35535           schema:
35536             $ref: "#/patchDefinitions/lag-interface"
35537     delete:
35538       tags:
35539         - Network
35540       summary: delete an existing lag-interface
35541       description: delete an existing lag-interface
35542       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35543       consumes:
35544         - application/json
35545         - application/xml
35546       produces:
35547         - application/json
35548         - application/xml
35549       responses:
35550         "default":
35551           description: Response codes found in [response codes](https://wiki.onap.org/).
35552       parameters:
35553         - name: vnf-id
35554           in: path
35555           description: Unique id of VNF.  This is unique across the graph.
35556           required: true
35557           type: string
35558           example: __VNF-ID__
35559         - name: interface-name
35560           in: path
35561           description: Name that identifies the link aggregate interface
35562           required: true
35563           type: string
35564           example: __INTERFACE-NAME__
35565         - name: resource-version
35566           in: query
35567           description: resource-version for concurrency
35568           required: true
35569           type: string
35570   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
35571     get:
35572       tags:
35573         - Network
35574       summary: returns lag-interfaces
35575       description: returns lag-interfaces
35576       operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
35577       produces:
35578         - application/json
35579         - application/xml
35580       responses:
35581         "200":
35582           description: successful operation
35583           schema:
35584               $ref: "#/getDefinitions/lag-interfaces"
35585         "default":
35586           description: Response codes found in [response codes](https://wiki.onap.org/).
35587       parameters:
35588         - name: vnf-id
35589           in: path
35590           description: Unique id of VNF.  This is unique across the graph.
35591           required: true
35592           type: string
35593           example: __VNF-ID__
35594         - name: interface-name
35595           in: query
35596           description:
35597           required: false
35598           type: string
35599         - name: interface-id
35600           in: query
35601           description:
35602           required: false
35603           type: string
35604         - name: interface-role
35605           in: query
35606           description:
35607           required: false
35608           type: string
35609   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
35610     put:
35611       tags:
35612         - Network
35613       summary: see node definition for valid relationships
35614       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
35615       consumes:
35616         - application/json
35617         - application/xml
35618       produces:
35619         - application/json
35620         - application/xml
35621       responses:
35622         "default":
35623           description: Response codes found in [response codes](https://wiki.onap.org/).
35624       parameters:
35625         - name: vnf-id
35626           in: path
35627           description: Unique id of VNF.  This is unique across the graph.
35628           required: true
35629           type: string
35630           example: __VNF-ID__
35631         - name: vf-module-id
35632           in: path
35633           description: Unique ID of vf-module.
35634           required: true
35635           type: string
35636           example: __VF-MODULE-ID__
35637         - name: body
35638           in: body
35639           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
35640           required: true
35641           schema:
35642             $ref: "#/definitions/relationship"
35643     delete:
35644       tags:
35645         - Network
35646       summary: delete an existing relationship
35647       description: delete an existing relationship
35648       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
35649       consumes:
35650         - application/json
35651         - application/xml
35652       produces:
35653         - application/json
35654         - application/xml
35655       responses:
35656         "default":
35657           description: Response codes found in [response codes](https://wiki.onap.org/).
35658       parameters:
35659         - name: vnf-id
35660           in: path
35661           description: Unique id of VNF.  This is unique across the graph.
35662           required: true
35663           type: string
35664           example: __VNF-ID__
35665         - name: vf-module-id
35666           in: path
35667           description: Unique ID of vf-module.
35668           required: true
35669           type: string
35670           example: __VF-MODULE-ID__
35671   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
35672     get:
35673       tags:
35674         - Network
35675       summary: returns vf-module
35676       description: returns vf-module
35677       operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
35678       produces:
35679         - application/json
35680         - application/xml
35681       responses:
35682         "200":
35683           description: successful operation
35684           schema:
35685               $ref: "#/getDefinitions/vf-module"
35686         "default":
35687           description: Response codes found in [response codes](https://wiki.onap.org/).
35688       parameters:
35689         - name: vnf-id
35690           in: path
35691           description: Unique id of VNF.  This is unique across the graph.
35692           required: true
35693           type: string
35694           example: __VNF-ID__
35695         - name: vf-module-id
35696           in: path
35697           description: Unique ID of vf-module.
35698           required: true
35699           type: string
35700           example: __VF-MODULE-ID__
35701     put:
35702       tags:
35703         - Network
35704       summary: create or update an existing vf-module
35705       description: |
35706         Create or update an existing vf-module.
35707         #
35708         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35709       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
35710       consumes:
35711         - application/json
35712         - application/xml
35713       produces:
35714         - application/json
35715         - application/xml
35716       responses:
35717         "default":
35718           description: Response codes found in [response codes](https://wiki.onap.org/).
35719       parameters:
35720         - name: vnf-id
35721           in: path
35722           description: Unique id of VNF.  This is unique across the graph.
35723           required: true
35724           type: string
35725           example: __VNF-ID__
35726         - name: vf-module-id
35727           in: path
35728           description: Unique ID of vf-module.
35729           required: true
35730           type: string
35731           example: __VF-MODULE-ID__
35732         - name: body
35733           in: body
35734           description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
35735           required: true
35736           schema:
35737             $ref: "#/definitions/vf-module"
35738     patch:
35739       tags:
35740         - Network
35741       summary: update an existing vf-module
35742       description: |
35743         Update an existing vf-module
35744         #
35745         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35746         The PUT operation will entirely replace an existing object.
35747         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35748         #
35749         Other differences between PUT and PATCH are:
35750         #
35751         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35752         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35753         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35754       operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
35755       consumes:
35756         - application/json
35757         - application/xml
35758       produces:
35759         - application/json
35760         - application/xml
35761       responses:
35762         "default":
35763           description: Response codes found in [response codes](https://wiki.onap.org/).
35764       parameters:
35765         - name: vnf-id
35766           in: path
35767           description: Unique id of VNF.  This is unique across the graph.
35768           required: true
35769           type: string
35770           example: __VNF-ID__
35771         - name: vf-module-id
35772           in: path
35773           description: Unique ID of vf-module.
35774           required: true
35775           type: string
35776           example: __VF-MODULE-ID__
35777         - name: body
35778           in: body
35779           description: vf-module object that needs to be updated.
35780           required: true
35781           schema:
35782             $ref: "#/patchDefinitions/vf-module"
35783     delete:
35784       tags:
35785         - Network
35786       summary: delete an existing vf-module
35787       description: delete an existing vf-module
35788       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
35789       consumes:
35790         - application/json
35791         - application/xml
35792       produces:
35793         - application/json
35794         - application/xml
35795       responses:
35796         "default":
35797           description: Response codes found in [response codes](https://wiki.onap.org/).
35798       parameters:
35799         - name: vnf-id
35800           in: path
35801           description: Unique id of VNF.  This is unique across the graph.
35802           required: true
35803           type: string
35804           example: __VNF-ID__
35805         - name: vf-module-id
35806           in: path
35807           description: Unique ID of vf-module.
35808           required: true
35809           type: string
35810           example: __VF-MODULE-ID__
35811         - name: resource-version
35812           in: query
35813           description: resource-version for concurrency
35814           required: true
35815           type: string
35816   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
35817     get:
35818       tags:
35819         - Network
35820       summary: returns vf-modules
35821       description: returns vf-modules
35822       operationId: getNetworkGenericVnfsGenericVnfVfModules
35823       produces:
35824         - application/json
35825         - application/xml
35826       responses:
35827         "200":
35828           description: successful operation
35829           schema:
35830               $ref: "#/getDefinitions/vf-modules"
35831         "default":
35832           description: Response codes found in [response codes](https://wiki.onap.org/).
35833       parameters:
35834         - name: vnf-id
35835           in: path
35836           description: Unique id of VNF.  This is unique across the graph.
35837           required: true
35838           type: string
35839           example: __VNF-ID__
35840         - name: vf-module-id
35841           in: query
35842           description:
35843           required: false
35844           type: string
35845         - name: vf-module-name
35846           in: query
35847           description:
35848           required: false
35849           type: string
35850         - name: heat-stack-id
35851           in: query
35852           description:
35853           required: false
35854           type: string
35855         - name: model-invariant-id
35856           in: query
35857           description:
35858           required: false
35859           type: string
35860         - name: model-version-id
35861           in: query
35862           description:
35863           required: false
35864           type: string
35865         - name: widget-model-id
35866           in: query
35867           description:
35868           required: false
35869           type: string
35870         - name: widget-model-version
35871           in: query
35872           description:
35873           required: false
35874           type: string
35875         - name: contrail-service-instance-fqdn
35876           in: query
35877           description:
35878           required: false
35879           type: string
35880   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
35881     put:
35882       tags:
35883         - Network
35884       summary: see node definition for valid relationships
35885       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
35886       consumes:
35887         - application/json
35888         - application/xml
35889       produces:
35890         - application/json
35891         - application/xml
35892       responses:
35893         "default":
35894           description: Response codes found in [response codes](https://wiki.onap.org/).
35895       parameters:
35896         - name: vnf-id
35897           in: path
35898           description: Unique id of VNF.  This is unique across the graph.
35899           required: true
35900           type: string
35901           example: __VNF-ID__
35902         - name: group-uuid
35903           in: path
35904           description: Unique ID for the license group the resource belongs to, should be uuid.
35905           required: true
35906           type: string
35907           example: __GROUP-UUID__
35908         - name: resource-uuid
35909           in: path
35910           description: Unique ID of a license resource.
35911           required: true
35912           type: string
35913           example: __RESOURCE-UUID__
35914         - name: body
35915           in: body
35916           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json)
35917           required: true
35918           schema:
35919             $ref: "#/definitions/relationship"
35920     delete:
35921       tags:
35922         - Network
35923       summary: delete an existing relationship
35924       description: delete an existing relationship
35925       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
35926       consumes:
35927         - application/json
35928         - application/xml
35929       produces:
35930         - application/json
35931         - application/xml
35932       responses:
35933         "default":
35934           description: Response codes found in [response codes](https://wiki.onap.org/).
35935       parameters:
35936         - name: vnf-id
35937           in: path
35938           description: Unique id of VNF.  This is unique across the graph.
35939           required: true
35940           type: string
35941           example: __VNF-ID__
35942         - name: group-uuid
35943           in: path
35944           description: Unique ID for the license group the resource belongs to, should be uuid.
35945           required: true
35946           type: string
35947           example: __GROUP-UUID__
35948         - name: resource-uuid
35949           in: path
35950           description: Unique ID of a license resource.
35951           required: true
35952           type: string
35953           example: __RESOURCE-UUID__
35954   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
35955     get:
35956       tags:
35957         - Network
35958       summary: returns license
35959       description: returns license
35960       operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
35961       produces:
35962         - application/json
35963         - application/xml
35964       responses:
35965         "200":
35966           description: successful operation
35967           schema:
35968               $ref: "#/getDefinitions/license"
35969         "default":
35970           description: Response codes found in [response codes](https://wiki.onap.org/).
35971       parameters:
35972         - name: vnf-id
35973           in: path
35974           description: Unique id of VNF.  This is unique across the graph.
35975           required: true
35976           type: string
35977           example: __VNF-ID__
35978         - name: group-uuid
35979           in: path
35980           description: Unique ID for the license group the resource belongs to, should be uuid.
35981           required: true
35982           type: string
35983           example: __GROUP-UUID__
35984         - name: resource-uuid
35985           in: path
35986           description: Unique ID of a license resource.
35987           required: true
35988           type: string
35989           example: __RESOURCE-UUID__
35990     put:
35991       tags:
35992         - Network
35993       summary: create or update an existing license
35994       description: |
35995         Create or update an existing license.
35996         #
35997         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35998       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
35999       consumes:
36000         - application/json
36001         - application/xml
36002       produces:
36003         - application/json
36004         - application/xml
36005       responses:
36006         "default":
36007           description: Response codes found in [response codes](https://wiki.onap.org/).
36008       parameters:
36009         - name: vnf-id
36010           in: path
36011           description: Unique id of VNF.  This is unique across the graph.
36012           required: true
36013           type: string
36014           example: __VNF-ID__
36015         - name: group-uuid
36016           in: path
36017           description: Unique ID for the license group the resource belongs to, should be uuid.
36018           required: true
36019           type: string
36020           example: __GROUP-UUID__
36021         - name: resource-uuid
36022           in: path
36023           description: Unique ID of a license resource.
36024           required: true
36025           type: string
36026           example: __RESOURCE-UUID__
36027         - name: body
36028           in: body
36029           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json)
36030           required: true
36031           schema:
36032             $ref: "#/definitions/license"
36033     patch:
36034       tags:
36035         - Network
36036       summary: update an existing license
36037       description: |
36038         Update an existing license
36039         #
36040         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36041         The PUT operation will entirely replace an existing object.
36042         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36043         #
36044         Other differences between PUT and PATCH are:
36045         #
36046         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36047         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36048         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36049       operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
36050       consumes:
36051         - application/json
36052         - application/xml
36053       produces:
36054         - application/json
36055         - application/xml
36056       responses:
36057         "default":
36058           description: Response codes found in [response codes](https://wiki.onap.org/).
36059       parameters:
36060         - name: vnf-id
36061           in: path
36062           description: Unique id of VNF.  This is unique across the graph.
36063           required: true
36064           type: string
36065           example: __VNF-ID__
36066         - name: group-uuid
36067           in: path
36068           description: Unique ID for the license group the resource belongs to, should be uuid.
36069           required: true
36070           type: string
36071           example: __GROUP-UUID__
36072         - name: resource-uuid
36073           in: path
36074           description: Unique ID of a license resource.
36075           required: true
36076           type: string
36077           example: __RESOURCE-UUID__
36078         - name: body
36079           in: body
36080           description: license object that needs to be updated.
36081           required: true
36082           schema:
36083             $ref: "#/patchDefinitions/license"
36084     delete:
36085       tags:
36086         - Network
36087       summary: delete an existing license
36088       description: delete an existing license
36089       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
36090       consumes:
36091         - application/json
36092         - application/xml
36093       produces:
36094         - application/json
36095         - application/xml
36096       responses:
36097         "default":
36098           description: Response codes found in [response codes](https://wiki.onap.org/).
36099       parameters:
36100         - name: vnf-id
36101           in: path
36102           description: Unique id of VNF.  This is unique across the graph.
36103           required: true
36104           type: string
36105           example: __VNF-ID__
36106         - name: group-uuid
36107           in: path
36108           description: Unique ID for the license group the resource belongs to, should be uuid.
36109           required: true
36110           type: string
36111           example: __GROUP-UUID__
36112         - name: resource-uuid
36113           in: path
36114           description: Unique ID of a license resource.
36115           required: true
36116           type: string
36117           example: __RESOURCE-UUID__
36118         - name: resource-version
36119           in: query
36120           description: resource-version for concurrency
36121           required: true
36122           type: string
36123   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
36124     get:
36125       tags:
36126         - Network
36127       summary: returns licenses
36128       description: returns licenses
36129       operationId: getNetworkGenericVnfsGenericVnfLicenses
36130       produces:
36131         - application/json
36132         - application/xml
36133       responses:
36134         "200":
36135           description: successful operation
36136           schema:
36137               $ref: "#/getDefinitions/licenses"
36138         "default":
36139           description: Response codes found in [response codes](https://wiki.onap.org/).
36140       parameters:
36141         - name: vnf-id
36142           in: path
36143           description: Unique id of VNF.  This is unique across the graph.
36144           required: true
36145           type: string
36146           example: __VNF-ID__
36147         - name: group-uuid
36148           in: query
36149           description:
36150           required: false
36151           type: string
36152         - name: resource-uuid
36153           in: query
36154           description:
36155           required: false
36156           type: string
36157   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
36158     put:
36159       tags:
36160         - Network
36161       summary: see node definition for valid relationships
36162       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
36163       consumes:
36164         - application/json
36165         - application/xml
36166       produces:
36167         - application/json
36168         - application/xml
36169       responses:
36170         "default":
36171           description: Response codes found in [response codes](https://wiki.onap.org/).
36172       parameters:
36173         - name: vnf-id
36174           in: path
36175           description: Unique id of VNF.  This is unique across the graph.
36176           required: true
36177           type: string
36178           example: __VNF-ID__
36179         - name: group-uuid
36180           in: path
36181           description: Unique ID for the entitlement group the resource comes from, should be uuid.
36182           required: true
36183           type: string
36184           example: __GROUP-UUID__
36185         - name: resource-uuid
36186           in: path
36187           description: Unique ID of an entitlement resource.
36188           required: true
36189           type: string
36190           example: __RESOURCE-UUID__
36191         - name: body
36192           in: body
36193           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
36194           required: true
36195           schema:
36196             $ref: "#/definitions/relationship"
36197     delete:
36198       tags:
36199         - Network
36200       summary: delete an existing relationship
36201       description: delete an existing relationship
36202       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
36203       consumes:
36204         - application/json
36205         - application/xml
36206       produces:
36207         - application/json
36208         - application/xml
36209       responses:
36210         "default":
36211           description: Response codes found in [response codes](https://wiki.onap.org/).
36212       parameters:
36213         - name: vnf-id
36214           in: path
36215           description: Unique id of VNF.  This is unique across the graph.
36216           required: true
36217           type: string
36218           example: __VNF-ID__
36219         - name: group-uuid
36220           in: path
36221           description: Unique ID for the entitlement group the resource comes from, should be uuid.
36222           required: true
36223           type: string
36224           example: __GROUP-UUID__
36225         - name: resource-uuid
36226           in: path
36227           description: Unique ID of an entitlement resource.
36228           required: true
36229           type: string
36230           example: __RESOURCE-UUID__
36231   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
36232     get:
36233       tags:
36234         - Network
36235       summary: returns entitlement
36236       description: returns entitlement
36237       operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36238       produces:
36239         - application/json
36240         - application/xml
36241       responses:
36242         "200":
36243           description: successful operation
36244           schema:
36245               $ref: "#/getDefinitions/entitlement"
36246         "default":
36247           description: Response codes found in [response codes](https://wiki.onap.org/).
36248       parameters:
36249         - name: vnf-id
36250           in: path
36251           description: Unique id of VNF.  This is unique across the graph.
36252           required: true
36253           type: string
36254           example: __VNF-ID__
36255         - name: group-uuid
36256           in: path
36257           description: Unique ID for the entitlement group the resource comes from, should be uuid.
36258           required: true
36259           type: string
36260           example: __GROUP-UUID__
36261         - name: resource-uuid
36262           in: path
36263           description: Unique ID of an entitlement resource.
36264           required: true
36265           type: string
36266           example: __RESOURCE-UUID__
36267     put:
36268       tags:
36269         - Network
36270       summary: create or update an existing entitlement
36271       description: |
36272         Create or update an existing entitlement.
36273         #
36274         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36275       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36276       consumes:
36277         - application/json
36278         - application/xml
36279       produces:
36280         - application/json
36281         - application/xml
36282       responses:
36283         "default":
36284           description: Response codes found in [response codes](https://wiki.onap.org/).
36285       parameters:
36286         - name: vnf-id
36287           in: path
36288           description: Unique id of VNF.  This is unique across the graph.
36289           required: true
36290           type: string
36291           example: __VNF-ID__
36292         - name: group-uuid
36293           in: path
36294           description: Unique ID for the entitlement group the resource comes from, should be uuid.
36295           required: true
36296           type: string
36297           example: __GROUP-UUID__
36298         - name: resource-uuid
36299           in: path
36300           description: Unique ID of an entitlement resource.
36301           required: true
36302           type: string
36303           example: __RESOURCE-UUID__
36304         - name: body
36305           in: body
36306           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
36307           required: true
36308           schema:
36309             $ref: "#/definitions/entitlement"
36310     patch:
36311       tags:
36312         - Network
36313       summary: update an existing entitlement
36314       description: |
36315         Update an existing entitlement
36316         #
36317         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36318         The PUT operation will entirely replace an existing object.
36319         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36320         #
36321         Other differences between PUT and PATCH are:
36322         #
36323         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36324         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36325         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36326       operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36327       consumes:
36328         - application/json
36329         - application/xml
36330       produces:
36331         - application/json
36332         - application/xml
36333       responses:
36334         "default":
36335           description: Response codes found in [response codes](https://wiki.onap.org/).
36336       parameters:
36337         - name: vnf-id
36338           in: path
36339           description: Unique id of VNF.  This is unique across the graph.
36340           required: true
36341           type: string
36342           example: __VNF-ID__
36343         - name: group-uuid
36344           in: path
36345           description: Unique ID for the entitlement group the resource comes from, should be uuid.
36346           required: true
36347           type: string
36348           example: __GROUP-UUID__
36349         - name: resource-uuid
36350           in: path
36351           description: Unique ID of an entitlement resource.
36352           required: true
36353           type: string
36354           example: __RESOURCE-UUID__
36355         - name: body
36356           in: body
36357           description: entitlement object that needs to be updated.
36358           required: true
36359           schema:
36360             $ref: "#/patchDefinitions/entitlement"
36361     delete:
36362       tags:
36363         - Network
36364       summary: delete an existing entitlement
36365       description: delete an existing entitlement
36366       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36367       consumes:
36368         - application/json
36369         - application/xml
36370       produces:
36371         - application/json
36372         - application/xml
36373       responses:
36374         "default":
36375           description: Response codes found in [response codes](https://wiki.onap.org/).
36376       parameters:
36377         - name: vnf-id
36378           in: path
36379           description: Unique id of VNF.  This is unique across the graph.
36380           required: true
36381           type: string
36382           example: __VNF-ID__
36383         - name: group-uuid
36384           in: path
36385           description: Unique ID for the entitlement group the resource comes from, should be uuid.
36386           required: true
36387           type: string
36388           example: __GROUP-UUID__
36389         - name: resource-uuid
36390           in: path
36391           description: Unique ID of an entitlement resource.
36392           required: true
36393           type: string
36394           example: __RESOURCE-UUID__
36395         - name: resource-version
36396           in: query
36397           description: resource-version for concurrency
36398           required: true
36399           type: string
36400   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
36401     get:
36402       tags:
36403         - Network
36404       summary: returns entitlements
36405       description: returns entitlements
36406       operationId: getNetworkGenericVnfsGenericVnfEntitlements
36407       produces:
36408         - application/json
36409         - application/xml
36410       responses:
36411         "200":
36412           description: successful operation
36413           schema:
36414               $ref: "#/getDefinitions/entitlements"
36415         "default":
36416           description: Response codes found in [response codes](https://wiki.onap.org/).
36417       parameters:
36418         - name: vnf-id
36419           in: path
36420           description: Unique id of VNF.  This is unique across the graph.
36421           required: true
36422           type: string
36423           example: __VNF-ID__
36424         - name: group-uuid
36425           in: query
36426           description:
36427           required: false
36428           type: string
36429         - name: resource-uuid
36430           in: query
36431           description:
36432           required: false
36433           type: string
36434   /network/generic-vnfs/generic-vnf/{vnf-id}:
36435     get:
36436       tags:
36437         - Network
36438       summary: returns generic-vnf
36439       description: returns generic-vnf
36440       operationId: getNetworkGenericVnfsGenericVnf
36441       produces:
36442         - application/json
36443         - application/xml
36444       responses:
36445         "200":
36446           description: successful operation
36447           schema:
36448               $ref: "#/getDefinitions/generic-vnf"
36449         "default":
36450           description: Response codes found in [response codes](https://wiki.onap.org/).
36451       parameters:
36452         - name: vnf-id
36453           in: path
36454           description: Unique id of VNF.  This is unique across the graph.
36455           required: true
36456           type: string
36457           example: __VNF-ID__
36458     put:
36459       tags:
36460         - Network
36461       summary: create or update an existing generic-vnf
36462       description: |
36463         Create or update an existing generic-vnf.
36464         #
36465         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36466       operationId: createOrUpdateNetworkGenericVnfsGenericVnf
36467       consumes:
36468         - application/json
36469         - application/xml
36470       produces:
36471         - application/json
36472         - application/xml
36473       responses:
36474         "default":
36475           description: Response codes found in [response codes](https://wiki.onap.org/).
36476       parameters:
36477         - name: vnf-id
36478           in: path
36479           description: Unique id of VNF.  This is unique across the graph.
36480           required: true
36481           type: string
36482           example: __VNF-ID__
36483         - name: body
36484           in: body
36485           description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json)
36486           required: true
36487           schema:
36488             $ref: "#/definitions/generic-vnf"
36489     patch:
36490       tags:
36491         - Network
36492       summary: update an existing generic-vnf
36493       description: |
36494         Update an existing generic-vnf
36495         #
36496         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36497         The PUT operation will entirely replace an existing object.
36498         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36499         #
36500         Other differences between PUT and PATCH are:
36501         #
36502         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36503         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36504         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36505       operationId: UpdateNetworkGenericVnfsGenericVnf
36506       consumes:
36507         - application/json
36508         - application/xml
36509       produces:
36510         - application/json
36511         - application/xml
36512       responses:
36513         "default":
36514           description: Response codes found in [response codes](https://wiki.onap.org/).
36515       parameters:
36516         - name: vnf-id
36517           in: path
36518           description: Unique id of VNF.  This is unique across the graph.
36519           required: true
36520           type: string
36521           example: __VNF-ID__
36522         - name: body
36523           in: body
36524           description: generic-vnf object that needs to be updated.
36525           required: true
36526           schema:
36527             $ref: "#/patchDefinitions/generic-vnf"
36528     delete:
36529       tags:
36530         - Network
36531       summary: delete an existing generic-vnf
36532       description: delete an existing generic-vnf
36533       operationId: deleteNetworkGenericVnfsGenericVnf
36534       consumes:
36535         - application/json
36536         - application/xml
36537       produces:
36538         - application/json
36539         - application/xml
36540       responses:
36541         "default":
36542           description: Response codes found in [response codes](https://wiki.onap.org/).
36543       parameters:
36544         - name: vnf-id
36545           in: path
36546           description: Unique id of VNF.  This is unique across the graph.
36547           required: true
36548           type: string
36549           example: __VNF-ID__
36550         - name: resource-version
36551           in: query
36552           description: resource-version for concurrency
36553           required: true
36554           type: string
36555   /network/generic-vnfs:
36556     get:
36557       tags:
36558         - Network
36559       summary: returns generic-vnfs
36560       description: returns generic-vnfs
36561       operationId: getNetworkGenericVnfs
36562       produces:
36563         - application/json
36564         - application/xml
36565       responses:
36566         "200":
36567           description: successful operation
36568           schema:
36569               $ref: "#/getDefinitions/generic-vnfs"
36570         "default":
36571           description: Response codes found in [response codes](https://wiki.onap.org/).
36572       parameters:
36573         - name: vnf-id
36574           in: query
36575           description:
36576           required: false
36577           type: string
36578         - name: vnf-name
36579           in: query
36580           description:
36581           required: false
36582           type: string
36583         - name: vnf-name2
36584           in: query
36585           description:
36586           required: false
36587           type: string
36588         - name: vnf-type
36589           in: query
36590           description:
36591           required: false
36592           type: string
36593         - name: service-id
36594           in: query
36595           description:
36596           required: false
36597           type: string
36598         - name: regional-resource-zone
36599           in: query
36600           description:
36601           required: false
36602           type: string
36603         - name: prov-status
36604           in: query
36605           description:
36606           required: false
36607           type: string
36608         - name: heat-stack-id
36609           in: query
36610           description:
36611           required: false
36612           type: string
36613         - name: in-maint
36614           in: query
36615           description:
36616           required: false
36617           type: boolean
36618         - name: is-closed-loop-disabled
36619           in: query
36620           description:
36621           required: false
36622           type: boolean
36623         - name: model-invariant-id
36624           in: query
36625           description:
36626           required: false
36627           type: string
36628         - name: model-version-id
36629           in: query
36630           description:
36631           required: false
36632           type: string
36633         - name: widget-model-id
36634           in: query
36635           description:
36636           required: false
36637           type: string
36638         - name: widget-model-version
36639           in: query
36640           description:
36641           required: false
36642           type: string
36643         - name: nf-type
36644           in: query
36645           description:
36646           required: false
36647           type: string
36648         - name: nf-function
36649           in: query
36650           description:
36651           required: false
36652           type: string
36653         - name: nf-role
36654           in: query
36655           description:
36656           required: false
36657           type: string
36658         - name: nf-naming-code
36659           in: query
36660           description:
36661           required: false
36662           type: string
36663   /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
36664     put:
36665       tags:
36666         - Network
36667       summary: see node definition for valid relationships
36668       operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
36669       consumes:
36670         - application/json
36671         - application/xml
36672       produces:
36673         - application/json
36674         - application/xml
36675       responses:
36676         "default":
36677           description: Response codes found in [response codes](https://wiki.onap.org/).
36678       parameters:
36679         - name: link-name
36680           in: path
36681           description: Alphabetical concatenation of lag-interface names
36682           required: true
36683           type: string
36684           example: __LINK-NAME__
36685         - name: body
36686           in: body
36687           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLagLinksLagLink.json)
36688           required: true
36689           schema:
36690             $ref: "#/definitions/relationship"
36691     delete:
36692       tags:
36693         - Network
36694       summary: delete an existing relationship
36695       description: delete an existing relationship
36696       operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
36697       consumes:
36698         - application/json
36699         - application/xml
36700       produces:
36701         - application/json
36702         - application/xml
36703       responses:
36704         "default":
36705           description: Response codes found in [response codes](https://wiki.onap.org/).
36706       parameters:
36707         - name: link-name
36708           in: path
36709           description: Alphabetical concatenation of lag-interface names
36710           required: true
36711           type: string
36712           example: __LINK-NAME__
36713   /network/lag-links/lag-link/{link-name}:
36714     get:
36715       tags:
36716         - Network
36717       summary: returns lag-link
36718       description: returns lag-link
36719       operationId: getNetworkLagLinksLagLink
36720       produces:
36721         - application/json
36722         - application/xml
36723       responses:
36724         "200":
36725           description: successful operation
36726           schema:
36727               $ref: "#/getDefinitions/lag-link"
36728         "default":
36729           description: Response codes found in [response codes](https://wiki.onap.org/).
36730       parameters:
36731         - name: link-name
36732           in: path
36733           description: Alphabetical concatenation of lag-interface names
36734           required: true
36735           type: string
36736           example: __LINK-NAME__
36737     put:
36738       tags:
36739         - Network
36740       summary: create or update an existing lag-link
36741       description: |
36742         Create or update an existing lag-link.
36743         #
36744         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36745       operationId: createOrUpdateNetworkLagLinksLagLink
36746       consumes:
36747         - application/json
36748         - application/xml
36749       produces:
36750         - application/json
36751         - application/xml
36752       responses:
36753         "default":
36754           description: Response codes found in [response codes](https://wiki.onap.org/).
36755       parameters:
36756         - name: link-name
36757           in: path
36758           description: Alphabetical concatenation of lag-interface names
36759           required: true
36760           type: string
36761           example: __LINK-NAME__
36762         - name: body
36763           in: body
36764           description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLagLinksLagLink.json)
36765           required: true
36766           schema:
36767             $ref: "#/definitions/lag-link"
36768     patch:
36769       tags:
36770         - Network
36771       summary: update an existing lag-link
36772       description: |
36773         Update an existing lag-link
36774         #
36775         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36776         The PUT operation will entirely replace an existing object.
36777         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36778         #
36779         Other differences between PUT and PATCH are:
36780         #
36781         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36782         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36783         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36784       operationId: UpdateNetworkLagLinksLagLink
36785       consumes:
36786         - application/json
36787         - application/xml
36788       produces:
36789         - application/json
36790         - application/xml
36791       responses:
36792         "default":
36793           description: Response codes found in [response codes](https://wiki.onap.org/).
36794       parameters:
36795         - name: link-name
36796           in: path
36797           description: Alphabetical concatenation of lag-interface names
36798           required: true
36799           type: string
36800           example: __LINK-NAME__
36801         - name: body
36802           in: body
36803           description: lag-link object that needs to be updated.
36804           required: true
36805           schema:
36806             $ref: "#/patchDefinitions/lag-link"
36807     delete:
36808       tags:
36809         - Network
36810       summary: delete an existing lag-link
36811       description: delete an existing lag-link
36812       operationId: deleteNetworkLagLinksLagLink
36813       consumes:
36814         - application/json
36815         - application/xml
36816       produces:
36817         - application/json
36818         - application/xml
36819       responses:
36820         "default":
36821           description: Response codes found in [response codes](https://wiki.onap.org/).
36822       parameters:
36823         - name: link-name
36824           in: path
36825           description: Alphabetical concatenation of lag-interface names
36826           required: true
36827           type: string
36828           example: __LINK-NAME__
36829         - name: resource-version
36830           in: query
36831           description: resource-version for concurrency
36832           required: true
36833           type: string
36834   /network/lag-links:
36835     get:
36836       tags:
36837         - Network
36838       summary: returns lag-links
36839       description: returns lag-links
36840       operationId: getNetworkLagLinks
36841       produces:
36842         - application/json
36843         - application/xml
36844       responses:
36845         "200":
36846           description: successful operation
36847           schema:
36848               $ref: "#/getDefinitions/lag-links"
36849         "default":
36850           description: Response codes found in [response codes](https://wiki.onap.org/).
36851       parameters:
36852         - name: link-name
36853           in: query
36854           description:
36855           required: false
36856           type: string
36857   /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
36858     put:
36859       tags:
36860         - Network
36861       summary: see node definition for valid relationships
36862       operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
36863       consumes:
36864         - application/json
36865         - application/xml
36866       produces:
36867         - application/json
36868         - application/xml
36869       responses:
36870         "default":
36871           description: Response codes found in [response codes](https://wiki.onap.org/).
36872       parameters:
36873         - name: vnf-id2
36874           in: path
36875           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36876           required: true
36877           type: string
36878           example: __VNF-ID2__
36879         - name: body
36880           in: body
36881           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json)
36882           required: true
36883           schema:
36884             $ref: "#/definitions/relationship"
36885     delete:
36886       tags:
36887         - Network
36888       summary: delete an existing relationship
36889       description: delete an existing relationship
36890       operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
36891       consumes:
36892         - application/json
36893         - application/xml
36894       produces:
36895         - application/json
36896         - application/xml
36897       responses:
36898         "default":
36899           description: Response codes found in [response codes](https://wiki.onap.org/).
36900       parameters:
36901         - name: vnf-id2
36902           in: path
36903           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36904           required: true
36905           type: string
36906           example: __VNF-ID2__
36907   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
36908     put:
36909       tags:
36910         - Network
36911       summary: see node definition for valid relationships
36912       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
36913       consumes:
36914         - application/json
36915         - application/xml
36916       produces:
36917         - application/json
36918         - application/xml
36919       responses:
36920         "default":
36921           description: Response codes found in [response codes](https://wiki.onap.org/).
36922       parameters:
36923         - name: vnf-id2
36924           in: path
36925           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36926           required: true
36927           type: string
36928           example: __VNF-ID2__
36929         - name: interface-name
36930           in: path
36931           description: Name given to the interface
36932           required: true
36933           type: string
36934           example: __INTERFACE-NAME__
36935         - name: vlan-interface
36936           in: path
36937           description: String that identifies the interface
36938           required: true
36939           type: string
36940           example: __VLAN-INTERFACE__
36941         - name: body
36942           in: body
36943           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
36944           required: true
36945           schema:
36946             $ref: "#/definitions/relationship"
36947     delete:
36948       tags:
36949         - Network
36950       summary: delete an existing relationship
36951       description: delete an existing relationship
36952       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
36953       consumes:
36954         - application/json
36955         - application/xml
36956       produces:
36957         - application/json
36958         - application/xml
36959       responses:
36960         "default":
36961           description: Response codes found in [response codes](https://wiki.onap.org/).
36962       parameters:
36963         - name: vnf-id2
36964           in: path
36965           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36966           required: true
36967           type: string
36968           example: __VNF-ID2__
36969         - name: interface-name
36970           in: path
36971           description: Name given to the interface
36972           required: true
36973           type: string
36974           example: __INTERFACE-NAME__
36975         - name: vlan-interface
36976           in: path
36977           description: String that identifies the interface
36978           required: true
36979           type: string
36980           example: __VLAN-INTERFACE__
36981   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
36982     put:
36983       tags:
36984         - Network
36985       summary: see node definition for valid relationships
36986       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
36987       consumes:
36988         - application/json
36989         - application/xml
36990       produces:
36991         - application/json
36992         - application/xml
36993       responses:
36994         "default":
36995           description: Response codes found in [response codes](https://wiki.onap.org/).
36996       parameters:
36997         - name: vnf-id2
36998           in: path
36999           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37000           required: true
37001           type: string
37002           example: __VNF-ID2__
37003         - name: interface-name
37004           in: path
37005           description: Name given to the interface
37006           required: true
37007           type: string
37008           example: __INTERFACE-NAME__
37009         - name: vlan-interface
37010           in: path
37011           description: String that identifies the interface
37012           required: true
37013           type: string
37014           example: __VLAN-INTERFACE__
37015         - name: l3-interface-ipv4-address
37016           in: path
37017           description: IP address
37018           required: true
37019           type: string
37020           example: __L3-INTERFACE-IPV4-ADDRESS__
37021         - name: body
37022           in: body
37023           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37024           required: true
37025           schema:
37026             $ref: "#/definitions/relationship"
37027     delete:
37028       tags:
37029         - Network
37030       summary: delete an existing relationship
37031       description: delete an existing relationship
37032       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37033       consumes:
37034         - application/json
37035         - application/xml
37036       produces:
37037         - application/json
37038         - application/xml
37039       responses:
37040         "default":
37041           description: Response codes found in [response codes](https://wiki.onap.org/).
37042       parameters:
37043         - name: vnf-id2
37044           in: path
37045           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37046           required: true
37047           type: string
37048           example: __VNF-ID2__
37049         - name: interface-name
37050           in: path
37051           description: Name given to the interface
37052           required: true
37053           type: string
37054           example: __INTERFACE-NAME__
37055         - name: vlan-interface
37056           in: path
37057           description: String that identifies the interface
37058           required: true
37059           type: string
37060           example: __VLAN-INTERFACE__
37061         - name: l3-interface-ipv4-address
37062           in: path
37063           description: IP address
37064           required: true
37065           type: string
37066           example: __L3-INTERFACE-IPV4-ADDRESS__
37067   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
37068     get:
37069       tags:
37070         - Network
37071       summary: returns l3-interface-ipv4-address-list
37072       description: returns l3-interface-ipv4-address-list
37073       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37074       produces:
37075         - application/json
37076         - application/xml
37077       responses:
37078         "200":
37079           description: successful operation
37080           schema:
37081               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37082         "default":
37083           description: Response codes found in [response codes](https://wiki.onap.org/).
37084       parameters:
37085         - name: vnf-id2
37086           in: path
37087           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37088           required: true
37089           type: string
37090           example: __VNF-ID2__
37091         - name: interface-name
37092           in: path
37093           description: Name given to the interface
37094           required: true
37095           type: string
37096           example: __INTERFACE-NAME__
37097         - name: vlan-interface
37098           in: path
37099           description: String that identifies the interface
37100           required: true
37101           type: string
37102           example: __VLAN-INTERFACE__
37103         - name: l3-interface-ipv4-address
37104           in: path
37105           description: IP address
37106           required: true
37107           type: string
37108           example: __L3-INTERFACE-IPV4-ADDRESS__
37109     put:
37110       tags:
37111         - Network
37112       summary: create or update an existing l3-interface-ipv4-address-list
37113       description: |
37114         Create or update an existing l3-interface-ipv4-address-list.
37115         #
37116         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37117       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37118       consumes:
37119         - application/json
37120         - application/xml
37121       produces:
37122         - application/json
37123         - application/xml
37124       responses:
37125         "default":
37126           description: Response codes found in [response codes](https://wiki.onap.org/).
37127       parameters:
37128         - name: vnf-id2
37129           in: path
37130           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37131           required: true
37132           type: string
37133           example: __VNF-ID2__
37134         - name: interface-name
37135           in: path
37136           description: Name given to the interface
37137           required: true
37138           type: string
37139           example: __INTERFACE-NAME__
37140         - name: vlan-interface
37141           in: path
37142           description: String that identifies the interface
37143           required: true
37144           type: string
37145           example: __VLAN-INTERFACE__
37146         - name: l3-interface-ipv4-address
37147           in: path
37148           description: IP address
37149           required: true
37150           type: string
37151           example: __L3-INTERFACE-IPV4-ADDRESS__
37152         - name: body
37153           in: body
37154           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37155           required: true
37156           schema:
37157             $ref: "#/definitions/l3-interface-ipv4-address-list"
37158     patch:
37159       tags:
37160         - Network
37161       summary: update an existing l3-interface-ipv4-address-list
37162       description: |
37163         Update an existing l3-interface-ipv4-address-list
37164         #
37165         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37166         The PUT operation will entirely replace an existing object.
37167         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37168         #
37169         Other differences between PUT and PATCH are:
37170         #
37171         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37172         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37173         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37174       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37175       consumes:
37176         - application/json
37177         - application/xml
37178       produces:
37179         - application/json
37180         - application/xml
37181       responses:
37182         "default":
37183           description: Response codes found in [response codes](https://wiki.onap.org/).
37184       parameters:
37185         - name: vnf-id2
37186           in: path
37187           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37188           required: true
37189           type: string
37190           example: __VNF-ID2__
37191         - name: interface-name
37192           in: path
37193           description: Name given to the interface
37194           required: true
37195           type: string
37196           example: __INTERFACE-NAME__
37197         - name: vlan-interface
37198           in: path
37199           description: String that identifies the interface
37200           required: true
37201           type: string
37202           example: __VLAN-INTERFACE__
37203         - name: l3-interface-ipv4-address
37204           in: path
37205           description: IP address
37206           required: true
37207           type: string
37208           example: __L3-INTERFACE-IPV4-ADDRESS__
37209         - name: body
37210           in: body
37211           description: l3-interface-ipv4-address-list object that needs to be updated.
37212           required: true
37213           schema:
37214             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37215     delete:
37216       tags:
37217         - Network
37218       summary: delete an existing l3-interface-ipv4-address-list
37219       description: delete an existing l3-interface-ipv4-address-list
37220       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37221       consumes:
37222         - application/json
37223         - application/xml
37224       produces:
37225         - application/json
37226         - application/xml
37227       responses:
37228         "default":
37229           description: Response codes found in [response codes](https://wiki.onap.org/).
37230       parameters:
37231         - name: vnf-id2
37232           in: path
37233           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37234           required: true
37235           type: string
37236           example: __VNF-ID2__
37237         - name: interface-name
37238           in: path
37239           description: Name given to the interface
37240           required: true
37241           type: string
37242           example: __INTERFACE-NAME__
37243         - name: vlan-interface
37244           in: path
37245           description: String that identifies the interface
37246           required: true
37247           type: string
37248           example: __VLAN-INTERFACE__
37249         - name: l3-interface-ipv4-address
37250           in: path
37251           description: IP address
37252           required: true
37253           type: string
37254           example: __L3-INTERFACE-IPV4-ADDRESS__
37255         - name: resource-version
37256           in: query
37257           description: resource-version for concurrency
37258           required: true
37259           type: string
37260   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
37261     put:
37262       tags:
37263         - Network
37264       summary: see node definition for valid relationships
37265       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37266       consumes:
37267         - application/json
37268         - application/xml
37269       produces:
37270         - application/json
37271         - application/xml
37272       responses:
37273         "default":
37274           description: Response codes found in [response codes](https://wiki.onap.org/).
37275       parameters:
37276         - name: vnf-id2
37277           in: path
37278           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37279           required: true
37280           type: string
37281           example: __VNF-ID2__
37282         - name: interface-name
37283           in: path
37284           description: Name given to the interface
37285           required: true
37286           type: string
37287           example: __INTERFACE-NAME__
37288         - name: vlan-interface
37289           in: path
37290           description: String that identifies the interface
37291           required: true
37292           type: string
37293           example: __VLAN-INTERFACE__
37294         - name: l3-interface-ipv6-address
37295           in: path
37296           description: IP address
37297           required: true
37298           type: string
37299           example: __L3-INTERFACE-IPV6-ADDRESS__
37300         - name: body
37301           in: body
37302           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37303           required: true
37304           schema:
37305             $ref: "#/definitions/relationship"
37306     delete:
37307       tags:
37308         - Network
37309       summary: delete an existing relationship
37310       description: delete an existing relationship
37311       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37312       consumes:
37313         - application/json
37314         - application/xml
37315       produces:
37316         - application/json
37317         - application/xml
37318       responses:
37319         "default":
37320           description: Response codes found in [response codes](https://wiki.onap.org/).
37321       parameters:
37322         - name: vnf-id2
37323           in: path
37324           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37325           required: true
37326           type: string
37327           example: __VNF-ID2__
37328         - name: interface-name
37329           in: path
37330           description: Name given to the interface
37331           required: true
37332           type: string
37333           example: __INTERFACE-NAME__
37334         - name: vlan-interface
37335           in: path
37336           description: String that identifies the interface
37337           required: true
37338           type: string
37339           example: __VLAN-INTERFACE__
37340         - name: l3-interface-ipv6-address
37341           in: path
37342           description: IP address
37343           required: true
37344           type: string
37345           example: __L3-INTERFACE-IPV6-ADDRESS__
37346   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
37347     get:
37348       tags:
37349         - Network
37350       summary: returns l3-interface-ipv6-address-list
37351       description: returns l3-interface-ipv6-address-list
37352       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37353       produces:
37354         - application/json
37355         - application/xml
37356       responses:
37357         "200":
37358           description: successful operation
37359           schema:
37360               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
37361         "default":
37362           description: Response codes found in [response codes](https://wiki.onap.org/).
37363       parameters:
37364         - name: vnf-id2
37365           in: path
37366           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37367           required: true
37368           type: string
37369           example: __VNF-ID2__
37370         - name: interface-name
37371           in: path
37372           description: Name given to the interface
37373           required: true
37374           type: string
37375           example: __INTERFACE-NAME__
37376         - name: vlan-interface
37377           in: path
37378           description: String that identifies the interface
37379           required: true
37380           type: string
37381           example: __VLAN-INTERFACE__
37382         - name: l3-interface-ipv6-address
37383           in: path
37384           description: IP address
37385           required: true
37386           type: string
37387           example: __L3-INTERFACE-IPV6-ADDRESS__
37388     put:
37389       tags:
37390         - Network
37391       summary: create or update an existing l3-interface-ipv6-address-list
37392       description: |
37393         Create or update an existing l3-interface-ipv6-address-list.
37394         #
37395         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37396       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37397       consumes:
37398         - application/json
37399         - application/xml
37400       produces:
37401         - application/json
37402         - application/xml
37403       responses:
37404         "default":
37405           description: Response codes found in [response codes](https://wiki.onap.org/).
37406       parameters:
37407         - name: vnf-id2
37408           in: path
37409           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37410           required: true
37411           type: string
37412           example: __VNF-ID2__
37413         - name: interface-name
37414           in: path
37415           description: Name given to the interface
37416           required: true
37417           type: string
37418           example: __INTERFACE-NAME__
37419         - name: vlan-interface
37420           in: path
37421           description: String that identifies the interface
37422           required: true
37423           type: string
37424           example: __VLAN-INTERFACE__
37425         - name: l3-interface-ipv6-address
37426           in: path
37427           description: IP address
37428           required: true
37429           type: string
37430           example: __L3-INTERFACE-IPV6-ADDRESS__
37431         - name: body
37432           in: body
37433           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37434           required: true
37435           schema:
37436             $ref: "#/definitions/l3-interface-ipv6-address-list"
37437     patch:
37438       tags:
37439         - Network
37440       summary: update an existing l3-interface-ipv6-address-list
37441       description: |
37442         Update an existing l3-interface-ipv6-address-list
37443         #
37444         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37445         The PUT operation will entirely replace an existing object.
37446         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37447         #
37448         Other differences between PUT and PATCH are:
37449         #
37450         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37451         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37452         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37453       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37454       consumes:
37455         - application/json
37456         - application/xml
37457       produces:
37458         - application/json
37459         - application/xml
37460       responses:
37461         "default":
37462           description: Response codes found in [response codes](https://wiki.onap.org/).
37463       parameters:
37464         - name: vnf-id2
37465           in: path
37466           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37467           required: true
37468           type: string
37469           example: __VNF-ID2__
37470         - name: interface-name
37471           in: path
37472           description: Name given to the interface
37473           required: true
37474           type: string
37475           example: __INTERFACE-NAME__
37476         - name: vlan-interface
37477           in: path
37478           description: String that identifies the interface
37479           required: true
37480           type: string
37481           example: __VLAN-INTERFACE__
37482         - name: l3-interface-ipv6-address
37483           in: path
37484           description: IP address
37485           required: true
37486           type: string
37487           example: __L3-INTERFACE-IPV6-ADDRESS__
37488         - name: body
37489           in: body
37490           description: l3-interface-ipv6-address-list object that needs to be updated.
37491           required: true
37492           schema:
37493             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
37494     delete:
37495       tags:
37496         - Network
37497       summary: delete an existing l3-interface-ipv6-address-list
37498       description: delete an existing l3-interface-ipv6-address-list
37499       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37500       consumes:
37501         - application/json
37502         - application/xml
37503       produces:
37504         - application/json
37505         - application/xml
37506       responses:
37507         "default":
37508           description: Response codes found in [response codes](https://wiki.onap.org/).
37509       parameters:
37510         - name: vnf-id2
37511           in: path
37512           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37513           required: true
37514           type: string
37515           example: __VNF-ID2__
37516         - name: interface-name
37517           in: path
37518           description: Name given to the interface
37519           required: true
37520           type: string
37521           example: __INTERFACE-NAME__
37522         - name: vlan-interface
37523           in: path
37524           description: String that identifies the interface
37525           required: true
37526           type: string
37527           example: __VLAN-INTERFACE__
37528         - name: l3-interface-ipv6-address
37529           in: path
37530           description: IP address
37531           required: true
37532           type: string
37533           example: __L3-INTERFACE-IPV6-ADDRESS__
37534         - name: resource-version
37535           in: query
37536           description: resource-version for concurrency
37537           required: true
37538           type: string
37539   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
37540     get:
37541       tags:
37542         - Network
37543       summary: returns vlan
37544       description: returns vlan
37545       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37546       produces:
37547         - application/json
37548         - application/xml
37549       responses:
37550         "200":
37551           description: successful operation
37552           schema:
37553               $ref: "#/getDefinitions/vlan"
37554         "default":
37555           description: Response codes found in [response codes](https://wiki.onap.org/).
37556       parameters:
37557         - name: vnf-id2
37558           in: path
37559           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37560           required: true
37561           type: string
37562           example: __VNF-ID2__
37563         - name: interface-name
37564           in: path
37565           description: Name given to the interface
37566           required: true
37567           type: string
37568           example: __INTERFACE-NAME__
37569         - name: vlan-interface
37570           in: path
37571           description: String that identifies the interface
37572           required: true
37573           type: string
37574           example: __VLAN-INTERFACE__
37575     put:
37576       tags:
37577         - Network
37578       summary: create or update an existing vlan
37579       description: |
37580         Create or update an existing vlan.
37581         #
37582         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37583       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37584       consumes:
37585         - application/json
37586         - application/xml
37587       produces:
37588         - application/json
37589         - application/xml
37590       responses:
37591         "default":
37592           description: Response codes found in [response codes](https://wiki.onap.org/).
37593       parameters:
37594         - name: vnf-id2
37595           in: path
37596           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37597           required: true
37598           type: string
37599           example: __VNF-ID2__
37600         - name: interface-name
37601           in: path
37602           description: Name given to the interface
37603           required: true
37604           type: string
37605           example: __INTERFACE-NAME__
37606         - name: vlan-interface
37607           in: path
37608           description: String that identifies the interface
37609           required: true
37610           type: string
37611           example: __VLAN-INTERFACE__
37612         - name: body
37613           in: body
37614           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
37615           required: true
37616           schema:
37617             $ref: "#/definitions/vlan"
37618     patch:
37619       tags:
37620         - Network
37621       summary: update an existing vlan
37622       description: |
37623         Update an existing vlan
37624         #
37625         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37626         The PUT operation will entirely replace an existing object.
37627         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37628         #
37629         Other differences between PUT and PATCH are:
37630         #
37631         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37632         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37633         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37634       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37635       consumes:
37636         - application/json
37637         - application/xml
37638       produces:
37639         - application/json
37640         - application/xml
37641       responses:
37642         "default":
37643           description: Response codes found in [response codes](https://wiki.onap.org/).
37644       parameters:
37645         - name: vnf-id2
37646           in: path
37647           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37648           required: true
37649           type: string
37650           example: __VNF-ID2__
37651         - name: interface-name
37652           in: path
37653           description: Name given to the interface
37654           required: true
37655           type: string
37656           example: __INTERFACE-NAME__
37657         - name: vlan-interface
37658           in: path
37659           description: String that identifies the interface
37660           required: true
37661           type: string
37662           example: __VLAN-INTERFACE__
37663         - name: body
37664           in: body
37665           description: vlan object that needs to be updated.
37666           required: true
37667           schema:
37668             $ref: "#/patchDefinitions/vlan"
37669     delete:
37670       tags:
37671         - Network
37672       summary: delete an existing vlan
37673       description: delete an existing vlan
37674       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37675       consumes:
37676         - application/json
37677         - application/xml
37678       produces:
37679         - application/json
37680         - application/xml
37681       responses:
37682         "default":
37683           description: Response codes found in [response codes](https://wiki.onap.org/).
37684       parameters:
37685         - name: vnf-id2
37686           in: path
37687           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37688           required: true
37689           type: string
37690           example: __VNF-ID2__
37691         - name: interface-name
37692           in: path
37693           description: Name given to the interface
37694           required: true
37695           type: string
37696           example: __INTERFACE-NAME__
37697         - name: vlan-interface
37698           in: path
37699           description: String that identifies the interface
37700           required: true
37701           type: string
37702           example: __VLAN-INTERFACE__
37703         - name: resource-version
37704           in: query
37705           description: resource-version for concurrency
37706           required: true
37707           type: string
37708   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
37709     get:
37710       tags:
37711         - Network
37712       summary: returns vlans
37713       description: returns vlans
37714       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
37715       produces:
37716         - application/json
37717         - application/xml
37718       responses:
37719         "200":
37720           description: successful operation
37721           schema:
37722               $ref: "#/getDefinitions/vlans"
37723         "default":
37724           description: Response codes found in [response codes](https://wiki.onap.org/).
37725       parameters:
37726         - name: vnf-id2
37727           in: path
37728           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37729           required: true
37730           type: string
37731           example: __VNF-ID2__
37732         - name: interface-name
37733           in: path
37734           description: Name given to the interface
37735           required: true
37736           type: string
37737           example: __INTERFACE-NAME__
37738         - name: vlan-interface
37739           in: query
37740           description:
37741           required: false
37742           type: string
37743         - name: vlan-id-inner
37744           in: query
37745           description:
37746           required: false
37747           type: integer
37748           format: int64
37749         - name: vpn-key
37750           in: query
37751           description:
37752           required: false
37753           type: string
37754   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
37755     put:
37756       tags:
37757         - Network
37758       summary: see node definition for valid relationships
37759       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
37760       consumes:
37761         - application/json
37762         - application/xml
37763       produces:
37764         - application/json
37765         - application/xml
37766       responses:
37767         "default":
37768           description: Response codes found in [response codes](https://wiki.onap.org/).
37769       parameters:
37770         - name: vnf-id2
37771           in: path
37772           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37773           required: true
37774           type: string
37775           example: __VNF-ID2__
37776         - name: interface-name
37777           in: path
37778           description: Name given to the interface
37779           required: true
37780           type: string
37781           example: __INTERFACE-NAME__
37782         - name: pci-id
37783           in: path
37784           description: PCI ID used to identify the sriov-vf
37785           required: true
37786           type: string
37787           example: __PCI-ID__
37788         - name: body
37789           in: body
37790           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
37791           required: true
37792           schema:
37793             $ref: "#/definitions/relationship"
37794     delete:
37795       tags:
37796         - Network
37797       summary: delete an existing relationship
37798       description: delete an existing relationship
37799       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
37800       consumes:
37801         - application/json
37802         - application/xml
37803       produces:
37804         - application/json
37805         - application/xml
37806       responses:
37807         "default":
37808           description: Response codes found in [response codes](https://wiki.onap.org/).
37809       parameters:
37810         - name: vnf-id2
37811           in: path
37812           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37813           required: true
37814           type: string
37815           example: __VNF-ID2__
37816         - name: interface-name
37817           in: path
37818           description: Name given to the interface
37819           required: true
37820           type: string
37821           example: __INTERFACE-NAME__
37822         - name: pci-id
37823           in: path
37824           description: PCI ID used to identify the sriov-vf
37825           required: true
37826           type: string
37827           example: __PCI-ID__
37828   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
37829     get:
37830       tags:
37831         - Network
37832       summary: returns sriov-vf
37833       description: returns sriov-vf
37834       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
37835       produces:
37836         - application/json
37837         - application/xml
37838       responses:
37839         "200":
37840           description: successful operation
37841           schema:
37842               $ref: "#/getDefinitions/sriov-vf"
37843         "default":
37844           description: Response codes found in [response codes](https://wiki.onap.org/).
37845       parameters:
37846         - name: vnf-id2
37847           in: path
37848           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37849           required: true
37850           type: string
37851           example: __VNF-ID2__
37852         - name: interface-name
37853           in: path
37854           description: Name given to the interface
37855           required: true
37856           type: string
37857           example: __INTERFACE-NAME__
37858         - name: pci-id
37859           in: path
37860           description: PCI ID used to identify the sriov-vf
37861           required: true
37862           type: string
37863           example: __PCI-ID__
37864     put:
37865       tags:
37866         - Network
37867       summary: create or update an existing sriov-vf
37868       description: |
37869         Create or update an existing sriov-vf.
37870         #
37871         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37872       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
37873       consumes:
37874         - application/json
37875         - application/xml
37876       produces:
37877         - application/json
37878         - application/xml
37879       responses:
37880         "default":
37881           description: Response codes found in [response codes](https://wiki.onap.org/).
37882       parameters:
37883         - name: vnf-id2
37884           in: path
37885           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37886           required: true
37887           type: string
37888           example: __VNF-ID2__
37889         - name: interface-name
37890           in: path
37891           description: Name given to the interface
37892           required: true
37893           type: string
37894           example: __INTERFACE-NAME__
37895         - name: pci-id
37896           in: path
37897           description: PCI ID used to identify the sriov-vf
37898           required: true
37899           type: string
37900           example: __PCI-ID__
37901         - name: body
37902           in: body
37903           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
37904           required: true
37905           schema:
37906             $ref: "#/definitions/sriov-vf"
37907     patch:
37908       tags:
37909         - Network
37910       summary: update an existing sriov-vf
37911       description: |
37912         Update an existing sriov-vf
37913         #
37914         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37915         The PUT operation will entirely replace an existing object.
37916         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37917         #
37918         Other differences between PUT and PATCH are:
37919         #
37920         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37921         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37922         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37923       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
37924       consumes:
37925         - application/json
37926         - application/xml
37927       produces:
37928         - application/json
37929         - application/xml
37930       responses:
37931         "default":
37932           description: Response codes found in [response codes](https://wiki.onap.org/).
37933       parameters:
37934         - name: vnf-id2
37935           in: path
37936           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37937           required: true
37938           type: string
37939           example: __VNF-ID2__
37940         - name: interface-name
37941           in: path
37942           description: Name given to the interface
37943           required: true
37944           type: string
37945           example: __INTERFACE-NAME__
37946         - name: pci-id
37947           in: path
37948           description: PCI ID used to identify the sriov-vf
37949           required: true
37950           type: string
37951           example: __PCI-ID__
37952         - name: body
37953           in: body
37954           description: sriov-vf object that needs to be updated.
37955           required: true
37956           schema:
37957             $ref: "#/patchDefinitions/sriov-vf"
37958     delete:
37959       tags:
37960         - Network
37961       summary: delete an existing sriov-vf
37962       description: delete an existing sriov-vf
37963       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
37964       consumes:
37965         - application/json
37966         - application/xml
37967       produces:
37968         - application/json
37969         - application/xml
37970       responses:
37971         "default":
37972           description: Response codes found in [response codes](https://wiki.onap.org/).
37973       parameters:
37974         - name: vnf-id2
37975           in: path
37976           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37977           required: true
37978           type: string
37979           example: __VNF-ID2__
37980         - name: interface-name
37981           in: path
37982           description: Name given to the interface
37983           required: true
37984           type: string
37985           example: __INTERFACE-NAME__
37986         - name: pci-id
37987           in: path
37988           description: PCI ID used to identify the sriov-vf
37989           required: true
37990           type: string
37991           example: __PCI-ID__
37992         - name: resource-version
37993           in: query
37994           description: resource-version for concurrency
37995           required: true
37996           type: string
37997   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
37998     get:
37999       tags:
38000         - Network
38001       summary: returns sriov-vfs
38002       description: returns sriov-vfs
38003       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
38004       produces:
38005         - application/json
38006         - application/xml
38007       responses:
38008         "200":
38009           description: successful operation
38010           schema:
38011               $ref: "#/getDefinitions/sriov-vfs"
38012         "default":
38013           description: Response codes found in [response codes](https://wiki.onap.org/).
38014       parameters:
38015         - name: vnf-id2
38016           in: path
38017           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38018           required: true
38019           type: string
38020           example: __VNF-ID2__
38021         - name: interface-name
38022           in: path
38023           description: Name given to the interface
38024           required: true
38025           type: string
38026           example: __INTERFACE-NAME__
38027         - name: pci-id
38028           in: query
38029           description:
38030           required: false
38031           type: string
38032         - name: vf-vlan-filter
38033           in: query
38034           description:
38035           required: false
38036           type: string
38037         - name: vf-mac-filter
38038           in: query
38039           description:
38040           required: false
38041           type: string
38042         - name: vf-vlan-strip
38043           in: query
38044           description:
38045           required: false
38046           type: boolean
38047         - name: neutron-network-id
38048           in: query
38049           description:
38050           required: false
38051           type: string
38052   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
38053     put:
38054       tags:
38055         - Network
38056       summary: see node definition for valid relationships
38057       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
38058       consumes:
38059         - application/json
38060         - application/xml
38061       produces:
38062         - application/json
38063         - application/xml
38064       responses:
38065         "default":
38066           description: Response codes found in [response codes](https://wiki.onap.org/).
38067       parameters:
38068         - name: vnf-id2
38069           in: path
38070           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38071           required: true
38072           type: string
38073           example: __VNF-ID2__
38074         - name: interface-name
38075           in: path
38076           description: Name given to the interface
38077           required: true
38078           type: string
38079           example: __INTERFACE-NAME__
38080         - name: body
38081           in: body
38082           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json)
38083           required: true
38084           schema:
38085             $ref: "#/definitions/relationship"
38086     delete:
38087       tags:
38088         - Network
38089       summary: delete an existing relationship
38090       description: delete an existing relationship
38091       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
38092       consumes:
38093         - application/json
38094         - application/xml
38095       produces:
38096         - application/json
38097         - application/xml
38098       responses:
38099         "default":
38100           description: Response codes found in [response codes](https://wiki.onap.org/).
38101       parameters:
38102         - name: vnf-id2
38103           in: path
38104           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38105           required: true
38106           type: string
38107           example: __VNF-ID2__
38108         - name: interface-name
38109           in: path
38110           description: Name given to the interface
38111           required: true
38112           type: string
38113           example: __INTERFACE-NAME__
38114   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
38115     put:
38116       tags:
38117         - Network
38118       summary: see node definition for valid relationships
38119       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38120       consumes:
38121         - application/json
38122         - application/xml
38123       produces:
38124         - application/json
38125         - application/xml
38126       responses:
38127         "default":
38128           description: Response codes found in [response codes](https://wiki.onap.org/).
38129       parameters:
38130         - name: vnf-id2
38131           in: path
38132           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38133           required: true
38134           type: string
38135           example: __VNF-ID2__
38136         - name: interface-name
38137           in: path
38138           description: Name given to the interface
38139           required: true
38140           type: string
38141           example: __INTERFACE-NAME__
38142         - name: l3-interface-ipv4-address
38143           in: path
38144           description: IP address
38145           required: true
38146           type: string
38147           example: __L3-INTERFACE-IPV4-ADDRESS__
38148         - name: body
38149           in: body
38150           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
38151           required: true
38152           schema:
38153             $ref: "#/definitions/relationship"
38154     delete:
38155       tags:
38156         - Network
38157       summary: delete an existing relationship
38158       description: delete an existing relationship
38159       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38160       consumes:
38161         - application/json
38162         - application/xml
38163       produces:
38164         - application/json
38165         - application/xml
38166       responses:
38167         "default":
38168           description: Response codes found in [response codes](https://wiki.onap.org/).
38169       parameters:
38170         - name: vnf-id2
38171           in: path
38172           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38173           required: true
38174           type: string
38175           example: __VNF-ID2__
38176         - name: interface-name
38177           in: path
38178           description: Name given to the interface
38179           required: true
38180           type: string
38181           example: __INTERFACE-NAME__
38182         - name: l3-interface-ipv4-address
38183           in: path
38184           description: IP address
38185           required: true
38186           type: string
38187           example: __L3-INTERFACE-IPV4-ADDRESS__
38188   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
38189     get:
38190       tags:
38191         - Network
38192       summary: returns l3-interface-ipv4-address-list
38193       description: returns l3-interface-ipv4-address-list
38194       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38195       produces:
38196         - application/json
38197         - application/xml
38198       responses:
38199         "200":
38200           description: successful operation
38201           schema:
38202               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
38203         "default":
38204           description: Response codes found in [response codes](https://wiki.onap.org/).
38205       parameters:
38206         - name: vnf-id2
38207           in: path
38208           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38209           required: true
38210           type: string
38211           example: __VNF-ID2__
38212         - name: interface-name
38213           in: path
38214           description: Name given to the interface
38215           required: true
38216           type: string
38217           example: __INTERFACE-NAME__
38218         - name: l3-interface-ipv4-address
38219           in: path
38220           description: IP address
38221           required: true
38222           type: string
38223           example: __L3-INTERFACE-IPV4-ADDRESS__
38224     put:
38225       tags:
38226         - Network
38227       summary: create or update an existing l3-interface-ipv4-address-list
38228       description: |
38229         Create or update an existing l3-interface-ipv4-address-list.
38230         #
38231         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38232       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38233       consumes:
38234         - application/json
38235         - application/xml
38236       produces:
38237         - application/json
38238         - application/xml
38239       responses:
38240         "default":
38241           description: Response codes found in [response codes](https://wiki.onap.org/).
38242       parameters:
38243         - name: vnf-id2
38244           in: path
38245           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38246           required: true
38247           type: string
38248           example: __VNF-ID2__
38249         - name: interface-name
38250           in: path
38251           description: Name given to the interface
38252           required: true
38253           type: string
38254           example: __INTERFACE-NAME__
38255         - name: l3-interface-ipv4-address
38256           in: path
38257           description: IP address
38258           required: true
38259           type: string
38260           example: __L3-INTERFACE-IPV4-ADDRESS__
38261         - name: body
38262           in: body
38263           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
38264           required: true
38265           schema:
38266             $ref: "#/definitions/l3-interface-ipv4-address-list"
38267     patch:
38268       tags:
38269         - Network
38270       summary: update an existing l3-interface-ipv4-address-list
38271       description: |
38272         Update an existing l3-interface-ipv4-address-list
38273         #
38274         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38275         The PUT operation will entirely replace an existing object.
38276         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38277         #
38278         Other differences between PUT and PATCH are:
38279         #
38280         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38281         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38282         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38283       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38284       consumes:
38285         - application/json
38286         - application/xml
38287       produces:
38288         - application/json
38289         - application/xml
38290       responses:
38291         "default":
38292           description: Response codes found in [response codes](https://wiki.onap.org/).
38293       parameters:
38294         - name: vnf-id2
38295           in: path
38296           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38297           required: true
38298           type: string
38299           example: __VNF-ID2__
38300         - name: interface-name
38301           in: path
38302           description: Name given to the interface
38303           required: true
38304           type: string
38305           example: __INTERFACE-NAME__
38306         - name: l3-interface-ipv4-address
38307           in: path
38308           description: IP address
38309           required: true
38310           type: string
38311           example: __L3-INTERFACE-IPV4-ADDRESS__
38312         - name: body
38313           in: body
38314           description: l3-interface-ipv4-address-list object that needs to be updated.
38315           required: true
38316           schema:
38317             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
38318     delete:
38319       tags:
38320         - Network
38321       summary: delete an existing l3-interface-ipv4-address-list
38322       description: delete an existing l3-interface-ipv4-address-list
38323       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38324       consumes:
38325         - application/json
38326         - application/xml
38327       produces:
38328         - application/json
38329         - application/xml
38330       responses:
38331         "default":
38332           description: Response codes found in [response codes](https://wiki.onap.org/).
38333       parameters:
38334         - name: vnf-id2
38335           in: path
38336           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38337           required: true
38338           type: string
38339           example: __VNF-ID2__
38340         - name: interface-name
38341           in: path
38342           description: Name given to the interface
38343           required: true
38344           type: string
38345           example: __INTERFACE-NAME__
38346         - name: l3-interface-ipv4-address
38347           in: path
38348           description: IP address
38349           required: true
38350           type: string
38351           example: __L3-INTERFACE-IPV4-ADDRESS__
38352         - name: resource-version
38353           in: query
38354           description: resource-version for concurrency
38355           required: true
38356           type: string
38357   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
38358     put:
38359       tags:
38360         - Network
38361       summary: see node definition for valid relationships
38362       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
38363       consumes:
38364         - application/json
38365         - application/xml
38366       produces:
38367         - application/json
38368         - application/xml
38369       responses:
38370         "default":
38371           description: Response codes found in [response codes](https://wiki.onap.org/).
38372       parameters:
38373         - name: vnf-id2
38374           in: path
38375           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38376           required: true
38377           type: string
38378           example: __VNF-ID2__
38379         - name: interface-name
38380           in: path
38381           description: Name given to the interface
38382           required: true
38383           type: string
38384           example: __INTERFACE-NAME__
38385         - name: l3-interface-ipv6-address
38386           in: path
38387           description: IP address
38388           required: true
38389           type: string
38390           example: __L3-INTERFACE-IPV6-ADDRESS__
38391         - name: body
38392           in: body
38393           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
38394           required: true
38395           schema:
38396             $ref: "#/definitions/relationship"
38397     delete:
38398       tags:
38399         - Network
38400       summary: delete an existing relationship
38401       description: delete an existing relationship
38402       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
38403       consumes:
38404         - application/json
38405         - application/xml
38406       produces:
38407         - application/json
38408         - application/xml
38409       responses:
38410         "default":
38411           description: Response codes found in [response codes](https://wiki.onap.org/).
38412       parameters:
38413         - name: vnf-id2
38414           in: path
38415           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38416           required: true
38417           type: string
38418           example: __VNF-ID2__
38419         - name: interface-name
38420           in: path
38421           description: Name given to the interface
38422           required: true
38423           type: string
38424           example: __INTERFACE-NAME__
38425         - name: l3-interface-ipv6-address
38426           in: path
38427           description: IP address
38428           required: true
38429           type: string
38430           example: __L3-INTERFACE-IPV6-ADDRESS__
38431   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
38432     get:
38433       tags:
38434         - Network
38435       summary: returns l3-interface-ipv6-address-list
38436       description: returns l3-interface-ipv6-address-list
38437       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38438       produces:
38439         - application/json
38440         - application/xml
38441       responses:
38442         "200":
38443           description: successful operation
38444           schema:
38445               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38446         "default":
38447           description: Response codes found in [response codes](https://wiki.onap.org/).
38448       parameters:
38449         - name: vnf-id2
38450           in: path
38451           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38452           required: true
38453           type: string
38454           example: __VNF-ID2__
38455         - name: interface-name
38456           in: path
38457           description: Name given to the interface
38458           required: true
38459           type: string
38460           example: __INTERFACE-NAME__
38461         - name: l3-interface-ipv6-address
38462           in: path
38463           description: IP address
38464           required: true
38465           type: string
38466           example: __L3-INTERFACE-IPV6-ADDRESS__
38467     put:
38468       tags:
38469         - Network
38470       summary: create or update an existing l3-interface-ipv6-address-list
38471       description: |
38472         Create or update an existing l3-interface-ipv6-address-list.
38473         #
38474         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38475       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38476       consumes:
38477         - application/json
38478         - application/xml
38479       produces:
38480         - application/json
38481         - application/xml
38482       responses:
38483         "default":
38484           description: Response codes found in [response codes](https://wiki.onap.org/).
38485       parameters:
38486         - name: vnf-id2
38487           in: path
38488           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38489           required: true
38490           type: string
38491           example: __VNF-ID2__
38492         - name: interface-name
38493           in: path
38494           description: Name given to the interface
38495           required: true
38496           type: string
38497           example: __INTERFACE-NAME__
38498         - name: l3-interface-ipv6-address
38499           in: path
38500           description: IP address
38501           required: true
38502           type: string
38503           example: __L3-INTERFACE-IPV6-ADDRESS__
38504         - name: body
38505           in: body
38506           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
38507           required: true
38508           schema:
38509             $ref: "#/definitions/l3-interface-ipv6-address-list"
38510     patch:
38511       tags:
38512         - Network
38513       summary: update an existing l3-interface-ipv6-address-list
38514       description: |
38515         Update an existing l3-interface-ipv6-address-list
38516         #
38517         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38518         The PUT operation will entirely replace an existing object.
38519         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38520         #
38521         Other differences between PUT and PATCH are:
38522         #
38523         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38524         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38525         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38526       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38527       consumes:
38528         - application/json
38529         - application/xml
38530       produces:
38531         - application/json
38532         - application/xml
38533       responses:
38534         "default":
38535           description: Response codes found in [response codes](https://wiki.onap.org/).
38536       parameters:
38537         - name: vnf-id2
38538           in: path
38539           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38540           required: true
38541           type: string
38542           example: __VNF-ID2__
38543         - name: interface-name
38544           in: path
38545           description: Name given to the interface
38546           required: true
38547           type: string
38548           example: __INTERFACE-NAME__
38549         - name: l3-interface-ipv6-address
38550           in: path
38551           description: IP address
38552           required: true
38553           type: string
38554           example: __L3-INTERFACE-IPV6-ADDRESS__
38555         - name: body
38556           in: body
38557           description: l3-interface-ipv6-address-list object that needs to be updated.
38558           required: true
38559           schema:
38560             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
38561     delete:
38562       tags:
38563         - Network
38564       summary: delete an existing l3-interface-ipv6-address-list
38565       description: delete an existing l3-interface-ipv6-address-list
38566       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38567       consumes:
38568         - application/json
38569         - application/xml
38570       produces:
38571         - application/json
38572         - application/xml
38573       responses:
38574         "default":
38575           description: Response codes found in [response codes](https://wiki.onap.org/).
38576       parameters:
38577         - name: vnf-id2
38578           in: path
38579           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38580           required: true
38581           type: string
38582           example: __VNF-ID2__
38583         - name: interface-name
38584           in: path
38585           description: Name given to the interface
38586           required: true
38587           type: string
38588           example: __INTERFACE-NAME__
38589         - name: l3-interface-ipv6-address
38590           in: path
38591           description: IP address
38592           required: true
38593           type: string
38594           example: __L3-INTERFACE-IPV6-ADDRESS__
38595         - name: resource-version
38596           in: query
38597           description: resource-version for concurrency
38598           required: true
38599           type: string
38600   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
38601     get:
38602       tags:
38603         - Network
38604       summary: returns l-interface
38605       description: returns l-interface
38606       operationId: getNetworkNewvcesNewvceLInterfacesLInterface
38607       produces:
38608         - application/json
38609         - application/xml
38610       responses:
38611         "200":
38612           description: successful operation
38613           schema:
38614               $ref: "#/getDefinitions/l-interface"
38615         "default":
38616           description: Response codes found in [response codes](https://wiki.onap.org/).
38617       parameters:
38618         - name: vnf-id2
38619           in: path
38620           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38621           required: true
38622           type: string
38623           example: __VNF-ID2__
38624         - name: interface-name
38625           in: path
38626           description: Name given to the interface
38627           required: true
38628           type: string
38629           example: __INTERFACE-NAME__
38630     put:
38631       tags:
38632         - Network
38633       summary: create or update an existing l-interface
38634       description: |
38635         Create or update an existing l-interface.
38636         #
38637         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38638       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
38639       consumes:
38640         - application/json
38641         - application/xml
38642       produces:
38643         - application/json
38644         - application/xml
38645       responses:
38646         "default":
38647           description: Response codes found in [response codes](https://wiki.onap.org/).
38648       parameters:
38649         - name: vnf-id2
38650           in: path
38651           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38652           required: true
38653           type: string
38654           example: __VNF-ID2__
38655         - name: interface-name
38656           in: path
38657           description: Name given to the interface
38658           required: true
38659           type: string
38660           example: __INTERFACE-NAME__
38661         - name: body
38662           in: body
38663           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json)
38664           required: true
38665           schema:
38666             $ref: "#/definitions/l-interface"
38667     patch:
38668       tags:
38669         - Network
38670       summary: update an existing l-interface
38671       description: |
38672         Update an existing l-interface
38673         #
38674         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38675         The PUT operation will entirely replace an existing object.
38676         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38677         #
38678         Other differences between PUT and PATCH are:
38679         #
38680         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38681         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38682         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38683       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
38684       consumes:
38685         - application/json
38686         - application/xml
38687       produces:
38688         - application/json
38689         - application/xml
38690       responses:
38691         "default":
38692           description: Response codes found in [response codes](https://wiki.onap.org/).
38693       parameters:
38694         - name: vnf-id2
38695           in: path
38696           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38697           required: true
38698           type: string
38699           example: __VNF-ID2__
38700         - name: interface-name
38701           in: path
38702           description: Name given to the interface
38703           required: true
38704           type: string
38705           example: __INTERFACE-NAME__
38706         - name: body
38707           in: body
38708           description: l-interface object that needs to be updated.
38709           required: true
38710           schema:
38711             $ref: "#/patchDefinitions/l-interface"
38712     delete:
38713       tags:
38714         - Network
38715       summary: delete an existing l-interface
38716       description: delete an existing l-interface
38717       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
38718       consumes:
38719         - application/json
38720         - application/xml
38721       produces:
38722         - application/json
38723         - application/xml
38724       responses:
38725         "default":
38726           description: Response codes found in [response codes](https://wiki.onap.org/).
38727       parameters:
38728         - name: vnf-id2
38729           in: path
38730           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38731           required: true
38732           type: string
38733           example: __VNF-ID2__
38734         - name: interface-name
38735           in: path
38736           description: Name given to the interface
38737           required: true
38738           type: string
38739           example: __INTERFACE-NAME__
38740         - name: resource-version
38741           in: query
38742           description: resource-version for concurrency
38743           required: true
38744           type: string
38745   /network/newvces/newvce/{vnf-id2}/l-interfaces:
38746     get:
38747       tags:
38748         - Network
38749       summary: returns l-interfaces
38750       description: returns l-interfaces
38751       operationId: getNetworkNewvcesNewvceLInterfaces
38752       produces:
38753         - application/json
38754         - application/xml
38755       responses:
38756         "200":
38757           description: successful operation
38758           schema:
38759               $ref: "#/getDefinitions/l-interfaces"
38760         "default":
38761           description: Response codes found in [response codes](https://wiki.onap.org/).
38762       parameters:
38763         - name: vnf-id2
38764           in: path
38765           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38766           required: true
38767           type: string
38768           example: __VNF-ID2__
38769         - name: interface-name
38770           in: query
38771           description:
38772           required: false
38773           type: string
38774         - name: interface-id
38775           in: query
38776           description:
38777           required: false
38778           type: string
38779         - name: macaddr
38780           in: query
38781           description:
38782           required: false
38783           type: string
38784         - name: network-name
38785           in: query
38786           description:
38787           required: false
38788           type: string
38789   /network/newvces/newvce/{vnf-id2}:
38790     get:
38791       tags:
38792         - Network
38793       summary: returns newvce
38794       description: returns newvce
38795       operationId: getNetworkNewvcesNewvce
38796       produces:
38797         - application/json
38798         - application/xml
38799       responses:
38800         "200":
38801           description: successful operation
38802           schema:
38803               $ref: "#/getDefinitions/newvce"
38804         "default":
38805           description: Response codes found in [response codes](https://wiki.onap.org/).
38806       parameters:
38807         - name: vnf-id2
38808           in: path
38809           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38810           required: true
38811           type: string
38812           example: __VNF-ID2__
38813     put:
38814       tags:
38815         - Network
38816       summary: create or update an existing newvce
38817       description: |
38818         Create or update an existing newvce.
38819         #
38820         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38821       operationId: createOrUpdateNetworkNewvcesNewvce
38822       consumes:
38823         - application/json
38824         - application/xml
38825       produces:
38826         - application/json
38827         - application/xml
38828       responses:
38829         "default":
38830           description: Response codes found in [response codes](https://wiki.onap.org/).
38831       parameters:
38832         - name: vnf-id2
38833           in: path
38834           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38835           required: true
38836           type: string
38837           example: __VNF-ID2__
38838         - name: body
38839           in: body
38840           description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json)
38841           required: true
38842           schema:
38843             $ref: "#/definitions/newvce"
38844     patch:
38845       tags:
38846         - Network
38847       summary: update an existing newvce
38848       description: |
38849         Update an existing newvce
38850         #
38851         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38852         The PUT operation will entirely replace an existing object.
38853         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38854         #
38855         Other differences between PUT and PATCH are:
38856         #
38857         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38858         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38859         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38860       operationId: UpdateNetworkNewvcesNewvce
38861       consumes:
38862         - application/json
38863         - application/xml
38864       produces:
38865         - application/json
38866         - application/xml
38867       responses:
38868         "default":
38869           description: Response codes found in [response codes](https://wiki.onap.org/).
38870       parameters:
38871         - name: vnf-id2
38872           in: path
38873           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38874           required: true
38875           type: string
38876           example: __VNF-ID2__
38877         - name: body
38878           in: body
38879           description: newvce object that needs to be updated.
38880           required: true
38881           schema:
38882             $ref: "#/patchDefinitions/newvce"
38883     delete:
38884       tags:
38885         - Network
38886       summary: delete an existing newvce
38887       description: delete an existing newvce
38888       operationId: deleteNetworkNewvcesNewvce
38889       consumes:
38890         - application/json
38891         - application/xml
38892       produces:
38893         - application/json
38894         - application/xml
38895       responses:
38896         "default":
38897           description: Response codes found in [response codes](https://wiki.onap.org/).
38898       parameters:
38899         - name: vnf-id2
38900           in: path
38901           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38902           required: true
38903           type: string
38904           example: __VNF-ID2__
38905         - name: resource-version
38906           in: query
38907           description: resource-version for concurrency
38908           required: true
38909           type: string
38910   /network/newvces:
38911     get:
38912       tags:
38913         - Network
38914       summary: returns newvces
38915       description: returns newvces
38916       operationId: getNetworkNewvces
38917       produces:
38918         - application/json
38919         - application/xml
38920       responses:
38921         "200":
38922           description: successful operation
38923           schema:
38924               $ref: "#/getDefinitions/newvces"
38925         "default":
38926           description: Response codes found in [response codes](https://wiki.onap.org/).
38927       parameters:
38928         - name: vnf-id2
38929           in: query
38930           description:
38931           required: false
38932           type: string
38933         - name: vnf-name
38934           in: query
38935           description:
38936           required: false
38937           type: string
38938         - name: vnf-name2
38939           in: query
38940           description:
38941           required: false
38942           type: string
38943         - name: vnf-type
38944           in: query
38945           description:
38946           required: false
38947           type: string
38948         - name: prov-status
38949           in: query
38950           description:
38951           required: false
38952           type: string
38953         - name: heat-stack-id
38954           in: query
38955           description:
38956           required: false
38957           type: string
38958   /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
38959     put:
38960       tags:
38961         - Network
38962       summary: see node definition for valid relationships
38963       operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
38964       consumes:
38965         - application/json
38966         - application/xml
38967       produces:
38968         - application/json
38969         - application/xml
38970       responses:
38971         "default":
38972           description: Response codes found in [response codes](https://wiki.onap.org/).
38973       parameters:
38974         - name: pnf-name
38975           in: path
38976           description: unique name of Physical Network Function.
38977           required: true
38978           type: string
38979           example: __PNF-NAME__
38980         - name: body
38981           in: body
38982           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json)
38983           required: true
38984           schema:
38985             $ref: "#/definitions/relationship"
38986     delete:
38987       tags:
38988         - Network
38989       summary: delete an existing relationship
38990       description: delete an existing relationship
38991       operationId: deleteNetworkPnfsPnfRelationshipListRelationship
38992       consumes:
38993         - application/json
38994         - application/xml
38995       produces:
38996         - application/json
38997         - application/xml
38998       responses:
38999         "default":
39000           description: Response codes found in [response codes](https://wiki.onap.org/).
39001       parameters:
39002         - name: pnf-name
39003           in: path
39004           description: unique name of Physical Network Function.
39005           required: true
39006           type: string
39007           example: __PNF-NAME__
39008   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
39009     put:
39010       tags:
39011         - Network
39012       summary: see node definition for valid relationships
39013       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
39014       consumes:
39015         - application/json
39016         - application/xml
39017       produces:
39018         - application/json
39019         - application/xml
39020       responses:
39021         "default":
39022           description: Response codes found in [response codes](https://wiki.onap.org/).
39023       parameters:
39024         - name: pnf-name
39025           in: path
39026           description: unique name of Physical Network Function.
39027           required: true
39028           type: string
39029           example: __PNF-NAME__
39030         - name: interface-name
39031           in: path
39032           description: Name that identifies the physical interface
39033           required: true
39034           type: string
39035           example: __INTERFACE-NAME__
39036         - name: body
39037           in: body
39038           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json)
39039           required: true
39040           schema:
39041             $ref: "#/definitions/relationship"
39042     delete:
39043       tags:
39044         - Network
39045       summary: delete an existing relationship
39046       description: delete an existing relationship
39047       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
39048       consumes:
39049         - application/json
39050         - application/xml
39051       produces:
39052         - application/json
39053         - application/xml
39054       responses:
39055         "default":
39056           description: Response codes found in [response codes](https://wiki.onap.org/).
39057       parameters:
39058         - name: pnf-name
39059           in: path
39060           description: unique name of Physical Network Function.
39061           required: true
39062           type: string
39063           example: __PNF-NAME__
39064         - name: interface-name
39065           in: path
39066           description: Name that identifies the physical interface
39067           required: true
39068           type: string
39069           example: __INTERFACE-NAME__
39070   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
39071     put:
39072       tags:
39073         - Network
39074       summary: see node definition for valid relationships
39075       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
39076       consumes:
39077         - application/json
39078         - application/xml
39079       produces:
39080         - application/json
39081         - application/xml
39082       responses:
39083         "default":
39084           description: Response codes found in [response codes](https://wiki.onap.org/).
39085       parameters:
39086         - name: pnf-name
39087           in: path
39088           description: unique name of Physical Network Function.
39089           required: true
39090           type: string
39091           example: __PNF-NAME__
39092         - name: interface-name
39093           in: path
39094           description: Name that identifies the physical interface
39095           required: true
39096           type: string
39097           example: __INTERFACE-NAME__
39098         - name: pf-pci-id
39099           in: path
39100           description: Identifier for the sriov-pf
39101           required: true
39102           type: string
39103           example: __PF-PCI-ID__
39104         - name: body
39105           in: body
39106           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
39107           required: true
39108           schema:
39109             $ref: "#/definitions/relationship"
39110     delete:
39111       tags:
39112         - Network
39113       summary: delete an existing relationship
39114       description: delete an existing relationship
39115       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
39116       consumes:
39117         - application/json
39118         - application/xml
39119       produces:
39120         - application/json
39121         - application/xml
39122       responses:
39123         "default":
39124           description: Response codes found in [response codes](https://wiki.onap.org/).
39125       parameters:
39126         - name: pnf-name
39127           in: path
39128           description: unique name of Physical Network Function.
39129           required: true
39130           type: string
39131           example: __PNF-NAME__
39132         - name: interface-name
39133           in: path
39134           description: Name that identifies the physical interface
39135           required: true
39136           type: string
39137           example: __INTERFACE-NAME__
39138         - name: pf-pci-id
39139           in: path
39140           description: Identifier for the sriov-pf
39141           required: true
39142           type: string
39143           example: __PF-PCI-ID__
39144   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
39145     get:
39146       tags:
39147         - Network
39148       summary: returns sriov-pf
39149       description: returns sriov-pf
39150       operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39151       produces:
39152         - application/json
39153         - application/xml
39154       responses:
39155         "200":
39156           description: successful operation
39157           schema:
39158               $ref: "#/getDefinitions/sriov-pf"
39159         "default":
39160           description: Response codes found in [response codes](https://wiki.onap.org/).
39161       parameters:
39162         - name: pnf-name
39163           in: path
39164           description: unique name of Physical Network Function.
39165           required: true
39166           type: string
39167           example: __PNF-NAME__
39168         - name: interface-name
39169           in: path
39170           description: Name that identifies the physical interface
39171           required: true
39172           type: string
39173           example: __INTERFACE-NAME__
39174         - name: pf-pci-id
39175           in: path
39176           description: Identifier for the sriov-pf
39177           required: true
39178           type: string
39179           example: __PF-PCI-ID__
39180     put:
39181       tags:
39182         - Network
39183       summary: create or update an existing sriov-pf
39184       description: |
39185         Create or update an existing sriov-pf.
39186         #
39187         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39188       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39189       consumes:
39190         - application/json
39191         - application/xml
39192       produces:
39193         - application/json
39194         - application/xml
39195       responses:
39196         "default":
39197           description: Response codes found in [response codes](https://wiki.onap.org/).
39198       parameters:
39199         - name: pnf-name
39200           in: path
39201           description: unique name of Physical Network Function.
39202           required: true
39203           type: string
39204           example: __PNF-NAME__
39205         - name: interface-name
39206           in: path
39207           description: Name that identifies the physical interface
39208           required: true
39209           type: string
39210           example: __INTERFACE-NAME__
39211         - name: pf-pci-id
39212           in: path
39213           description: Identifier for the sriov-pf
39214           required: true
39215           type: string
39216           example: __PF-PCI-ID__
39217         - name: body
39218           in: body
39219           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
39220           required: true
39221           schema:
39222             $ref: "#/definitions/sriov-pf"
39223     patch:
39224       tags:
39225         - Network
39226       summary: update an existing sriov-pf
39227       description: |
39228         Update an existing sriov-pf
39229         #
39230         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39231         The PUT operation will entirely replace an existing object.
39232         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39233         #
39234         Other differences between PUT and PATCH are:
39235         #
39236         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39237         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39238         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39239       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39240       consumes:
39241         - application/json
39242         - application/xml
39243       produces:
39244         - application/json
39245         - application/xml
39246       responses:
39247         "default":
39248           description: Response codes found in [response codes](https://wiki.onap.org/).
39249       parameters:
39250         - name: pnf-name
39251           in: path
39252           description: unique name of Physical Network Function.
39253           required: true
39254           type: string
39255           example: __PNF-NAME__
39256         - name: interface-name
39257           in: path
39258           description: Name that identifies the physical interface
39259           required: true
39260           type: string
39261           example: __INTERFACE-NAME__
39262         - name: pf-pci-id
39263           in: path
39264           description: Identifier for the sriov-pf
39265           required: true
39266           type: string
39267           example: __PF-PCI-ID__
39268         - name: body
39269           in: body
39270           description: sriov-pf object that needs to be updated.
39271           required: true
39272           schema:
39273             $ref: "#/patchDefinitions/sriov-pf"
39274     delete:
39275       tags:
39276         - Network
39277       summary: delete an existing sriov-pf
39278       description: delete an existing sriov-pf
39279       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39280       consumes:
39281         - application/json
39282         - application/xml
39283       produces:
39284         - application/json
39285         - application/xml
39286       responses:
39287         "default":
39288           description: Response codes found in [response codes](https://wiki.onap.org/).
39289       parameters:
39290         - name: pnf-name
39291           in: path
39292           description: unique name of Physical Network Function.
39293           required: true
39294           type: string
39295           example: __PNF-NAME__
39296         - name: interface-name
39297           in: path
39298           description: Name that identifies the physical interface
39299           required: true
39300           type: string
39301           example: __INTERFACE-NAME__
39302         - name: pf-pci-id
39303           in: path
39304           description: Identifier for the sriov-pf
39305           required: true
39306           type: string
39307           example: __PF-PCI-ID__
39308         - name: resource-version
39309           in: query
39310           description: resource-version for concurrency
39311           required: true
39312           type: string
39313   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
39314     get:
39315       tags:
39316         - Network
39317       summary: returns sriov-pfs
39318       description: returns sriov-pfs
39319       operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs
39320       produces:
39321         - application/json
39322         - application/xml
39323       responses:
39324         "200":
39325           description: successful operation
39326           schema:
39327               $ref: "#/getDefinitions/sriov-pfs"
39328         "default":
39329           description: Response codes found in [response codes](https://wiki.onap.org/).
39330       parameters:
39331         - name: pnf-name
39332           in: path
39333           description: unique name of Physical Network Function.
39334           required: true
39335           type: string
39336           example: __PNF-NAME__
39337         - name: interface-name
39338           in: path
39339           description: Name that identifies the physical interface
39340           required: true
39341           type: string
39342           example: __INTERFACE-NAME__
39343         - name: pf-pci-id
39344           in: query
39345           description:
39346           required: false
39347           type: string
39348   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
39349     put:
39350       tags:
39351         - Network
39352       summary: see node definition for valid relationships
39353       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
39354       consumes:
39355         - application/json
39356         - application/xml
39357       produces:
39358         - application/json
39359         - application/xml
39360       responses:
39361         "default":
39362           description: Response codes found in [response codes](https://wiki.onap.org/).
39363       parameters:
39364         - name: pnf-name
39365           in: path
39366           description: unique name of Physical Network Function.
39367           required: true
39368           type: string
39369           example: __PNF-NAME__
39370         - name: interface-name
39371           in: path
39372           description: Name that identifies the physical interface
39373           required: true
39374           type: string
39375           example: __INTERFACE-NAME__
39376         - name: interface-name
39377           in: path
39378           description: Name given to the interface
39379           required: true
39380           type: string
39381           example: __INTERFACE-NAME__
39382         - name: vlan-interface
39383           in: path
39384           description: String that identifies the interface
39385           required: true
39386           type: string
39387           example: __VLAN-INTERFACE__
39388         - name: body
39389           in: body
39390           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
39391           required: true
39392           schema:
39393             $ref: "#/definitions/relationship"
39394     delete:
39395       tags:
39396         - Network
39397       summary: delete an existing relationship
39398       description: delete an existing relationship
39399       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
39400       consumes:
39401         - application/json
39402         - application/xml
39403       produces:
39404         - application/json
39405         - application/xml
39406       responses:
39407         "default":
39408           description: Response codes found in [response codes](https://wiki.onap.org/).
39409       parameters:
39410         - name: pnf-name
39411           in: path
39412           description: unique name of Physical Network Function.
39413           required: true
39414           type: string
39415           example: __PNF-NAME__
39416         - name: interface-name
39417           in: path
39418           description: Name that identifies the physical interface
39419           required: true
39420           type: string
39421           example: __INTERFACE-NAME__
39422         - name: interface-name
39423           in: path
39424           description: Name given to the interface
39425           required: true
39426           type: string
39427           example: __INTERFACE-NAME__
39428         - name: vlan-interface
39429           in: path
39430           description: String that identifies the interface
39431           required: true
39432           type: string
39433           example: __VLAN-INTERFACE__
39434   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
39435     put:
39436       tags:
39437         - Network
39438       summary: see node definition for valid relationships
39439       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
39440       consumes:
39441         - application/json
39442         - application/xml
39443       produces:
39444         - application/json
39445         - application/xml
39446       responses:
39447         "default":
39448           description: Response codes found in [response codes](https://wiki.onap.org/).
39449       parameters:
39450         - name: pnf-name
39451           in: path
39452           description: unique name of Physical Network Function.
39453           required: true
39454           type: string
39455           example: __PNF-NAME__
39456         - name: interface-name
39457           in: path
39458           description: Name that identifies the physical interface
39459           required: true
39460           type: string
39461           example: __INTERFACE-NAME__
39462         - name: interface-name
39463           in: path
39464           description: Name given to the interface
39465           required: true
39466           type: string
39467           example: __INTERFACE-NAME__
39468         - name: vlan-interface
39469           in: path
39470           description: String that identifies the interface
39471           required: true
39472           type: string
39473           example: __VLAN-INTERFACE__
39474         - name: l3-interface-ipv4-address
39475           in: path
39476           description: IP address
39477           required: true
39478           type: string
39479           example: __L3-INTERFACE-IPV4-ADDRESS__
39480         - name: body
39481           in: body
39482           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
39483           required: true
39484           schema:
39485             $ref: "#/definitions/relationship"
39486     delete:
39487       tags:
39488         - Network
39489       summary: delete an existing relationship
39490       description: delete an existing relationship
39491       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
39492       consumes:
39493         - application/json
39494         - application/xml
39495       produces:
39496         - application/json
39497         - application/xml
39498       responses:
39499         "default":
39500           description: Response codes found in [response codes](https://wiki.onap.org/).
39501       parameters:
39502         - name: pnf-name
39503           in: path
39504           description: unique name of Physical Network Function.
39505           required: true
39506           type: string
39507           example: __PNF-NAME__
39508         - name: interface-name
39509           in: path
39510           description: Name that identifies the physical interface
39511           required: true
39512           type: string
39513           example: __INTERFACE-NAME__
39514         - name: interface-name
39515           in: path
39516           description: Name given to the interface
39517           required: true
39518           type: string
39519           example: __INTERFACE-NAME__
39520         - name: vlan-interface
39521           in: path
39522           description: String that identifies the interface
39523           required: true
39524           type: string
39525           example: __VLAN-INTERFACE__
39526         - name: l3-interface-ipv4-address
39527           in: path
39528           description: IP address
39529           required: true
39530           type: string
39531           example: __L3-INTERFACE-IPV4-ADDRESS__
39532   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
39533     get:
39534       tags:
39535         - Network
39536       summary: returns l3-interface-ipv4-address-list
39537       description: returns l3-interface-ipv4-address-list
39538       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39539       produces:
39540         - application/json
39541         - application/xml
39542       responses:
39543         "200":
39544           description: successful operation
39545           schema:
39546               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39547         "default":
39548           description: Response codes found in [response codes](https://wiki.onap.org/).
39549       parameters:
39550         - name: pnf-name
39551           in: path
39552           description: unique name of Physical Network Function.
39553           required: true
39554           type: string
39555           example: __PNF-NAME__
39556         - name: interface-name
39557           in: path
39558           description: Name that identifies the physical interface
39559           required: true
39560           type: string
39561           example: __INTERFACE-NAME__
39562         - name: interface-name
39563           in: path
39564           description: Name given to the interface
39565           required: true
39566           type: string
39567           example: __INTERFACE-NAME__
39568         - name: vlan-interface
39569           in: path
39570           description: String that identifies the interface
39571           required: true
39572           type: string
39573           example: __VLAN-INTERFACE__
39574         - name: l3-interface-ipv4-address
39575           in: path
39576           description: IP address
39577           required: true
39578           type: string
39579           example: __L3-INTERFACE-IPV4-ADDRESS__
39580     put:
39581       tags:
39582         - Network
39583       summary: create or update an existing l3-interface-ipv4-address-list
39584       description: |
39585         Create or update an existing l3-interface-ipv4-address-list.
39586         #
39587         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39588       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39589       consumes:
39590         - application/json
39591         - application/xml
39592       produces:
39593         - application/json
39594         - application/xml
39595       responses:
39596         "default":
39597           description: Response codes found in [response codes](https://wiki.onap.org/).
39598       parameters:
39599         - name: pnf-name
39600           in: path
39601           description: unique name of Physical Network Function.
39602           required: true
39603           type: string
39604           example: __PNF-NAME__
39605         - name: interface-name
39606           in: path
39607           description: Name that identifies the physical interface
39608           required: true
39609           type: string
39610           example: __INTERFACE-NAME__
39611         - name: interface-name
39612           in: path
39613           description: Name given to the interface
39614           required: true
39615           type: string
39616           example: __INTERFACE-NAME__
39617         - name: vlan-interface
39618           in: path
39619           description: String that identifies the interface
39620           required: true
39621           type: string
39622           example: __VLAN-INTERFACE__
39623         - name: l3-interface-ipv4-address
39624           in: path
39625           description: IP address
39626           required: true
39627           type: string
39628           example: __L3-INTERFACE-IPV4-ADDRESS__
39629         - name: body
39630           in: body
39631           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
39632           required: true
39633           schema:
39634             $ref: "#/definitions/l3-interface-ipv4-address-list"
39635     patch:
39636       tags:
39637         - Network
39638       summary: update an existing l3-interface-ipv4-address-list
39639       description: |
39640         Update an existing l3-interface-ipv4-address-list
39641         #
39642         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39643         The PUT operation will entirely replace an existing object.
39644         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39645         #
39646         Other differences between PUT and PATCH are:
39647         #
39648         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39649         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39650         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39651       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39652       consumes:
39653         - application/json
39654         - application/xml
39655       produces:
39656         - application/json
39657         - application/xml
39658       responses:
39659         "default":
39660           description: Response codes found in [response codes](https://wiki.onap.org/).
39661       parameters:
39662         - name: pnf-name
39663           in: path
39664           description: unique name of Physical Network Function.
39665           required: true
39666           type: string
39667           example: __PNF-NAME__
39668         - name: interface-name
39669           in: path
39670           description: Name that identifies the physical interface
39671           required: true
39672           type: string
39673           example: __INTERFACE-NAME__
39674         - name: interface-name
39675           in: path
39676           description: Name given to the interface
39677           required: true
39678           type: string
39679           example: __INTERFACE-NAME__
39680         - name: vlan-interface
39681           in: path
39682           description: String that identifies the interface
39683           required: true
39684           type: string
39685           example: __VLAN-INTERFACE__
39686         - name: l3-interface-ipv4-address
39687           in: path
39688           description: IP address
39689           required: true
39690           type: string
39691           example: __L3-INTERFACE-IPV4-ADDRESS__
39692         - name: body
39693           in: body
39694           description: l3-interface-ipv4-address-list object that needs to be updated.
39695           required: true
39696           schema:
39697             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
39698     delete:
39699       tags:
39700         - Network
39701       summary: delete an existing l3-interface-ipv4-address-list
39702       description: delete an existing l3-interface-ipv4-address-list
39703       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39704       consumes:
39705         - application/json
39706         - application/xml
39707       produces:
39708         - application/json
39709         - application/xml
39710       responses:
39711         "default":
39712           description: Response codes found in [response codes](https://wiki.onap.org/).
39713       parameters:
39714         - name: pnf-name
39715           in: path
39716           description: unique name of Physical Network Function.
39717           required: true
39718           type: string
39719           example: __PNF-NAME__
39720         - name: interface-name
39721           in: path
39722           description: Name that identifies the physical interface
39723           required: true
39724           type: string
39725           example: __INTERFACE-NAME__
39726         - name: interface-name
39727           in: path
39728           description: Name given to the interface
39729           required: true
39730           type: string
39731           example: __INTERFACE-NAME__
39732         - name: vlan-interface
39733           in: path
39734           description: String that identifies the interface
39735           required: true
39736           type: string
39737           example: __VLAN-INTERFACE__
39738         - name: l3-interface-ipv4-address
39739           in: path
39740           description: IP address
39741           required: true
39742           type: string
39743           example: __L3-INTERFACE-IPV4-ADDRESS__
39744         - name: resource-version
39745           in: query
39746           description: resource-version for concurrency
39747           required: true
39748           type: string
39749   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
39750     put:
39751       tags:
39752         - Network
39753       summary: see node definition for valid relationships
39754       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
39755       consumes:
39756         - application/json
39757         - application/xml
39758       produces:
39759         - application/json
39760         - application/xml
39761       responses:
39762         "default":
39763           description: Response codes found in [response codes](https://wiki.onap.org/).
39764       parameters:
39765         - name: pnf-name
39766           in: path
39767           description: unique name of Physical Network Function.
39768           required: true
39769           type: string
39770           example: __PNF-NAME__
39771         - name: interface-name
39772           in: path
39773           description: Name that identifies the physical interface
39774           required: true
39775           type: string
39776           example: __INTERFACE-NAME__
39777         - name: interface-name
39778           in: path
39779           description: Name given to the interface
39780           required: true
39781           type: string
39782           example: __INTERFACE-NAME__
39783         - name: vlan-interface
39784           in: path
39785           description: String that identifies the interface
39786           required: true
39787           type: string
39788           example: __VLAN-INTERFACE__
39789         - name: l3-interface-ipv6-address
39790           in: path
39791           description: IP address
39792           required: true
39793           type: string
39794           example: __L3-INTERFACE-IPV6-ADDRESS__
39795         - name: body
39796           in: body
39797           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
39798           required: true
39799           schema:
39800             $ref: "#/definitions/relationship"
39801     delete:
39802       tags:
39803         - Network
39804       summary: delete an existing relationship
39805       description: delete an existing relationship
39806       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
39807       consumes:
39808         - application/json
39809         - application/xml
39810       produces:
39811         - application/json
39812         - application/xml
39813       responses:
39814         "default":
39815           description: Response codes found in [response codes](https://wiki.onap.org/).
39816       parameters:
39817         - name: pnf-name
39818           in: path
39819           description: unique name of Physical Network Function.
39820           required: true
39821           type: string
39822           example: __PNF-NAME__
39823         - name: interface-name
39824           in: path
39825           description: Name that identifies the physical interface
39826           required: true
39827           type: string
39828           example: __INTERFACE-NAME__
39829         - name: interface-name
39830           in: path
39831           description: Name given to the interface
39832           required: true
39833           type: string
39834           example: __INTERFACE-NAME__
39835         - name: vlan-interface
39836           in: path
39837           description: String that identifies the interface
39838           required: true
39839           type: string
39840           example: __VLAN-INTERFACE__
39841         - name: l3-interface-ipv6-address
39842           in: path
39843           description: IP address
39844           required: true
39845           type: string
39846           example: __L3-INTERFACE-IPV6-ADDRESS__
39847   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
39848     get:
39849       tags:
39850         - Network
39851       summary: returns l3-interface-ipv6-address-list
39852       description: returns l3-interface-ipv6-address-list
39853       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39854       produces:
39855         - application/json
39856         - application/xml
39857       responses:
39858         "200":
39859           description: successful operation
39860           schema:
39861               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
39862         "default":
39863           description: Response codes found in [response codes](https://wiki.onap.org/).
39864       parameters:
39865         - name: pnf-name
39866           in: path
39867           description: unique name of Physical Network Function.
39868           required: true
39869           type: string
39870           example: __PNF-NAME__
39871         - name: interface-name
39872           in: path
39873           description: Name that identifies the physical interface
39874           required: true
39875           type: string
39876           example: __INTERFACE-NAME__
39877         - name: interface-name
39878           in: path
39879           description: Name given to the interface
39880           required: true
39881           type: string
39882           example: __INTERFACE-NAME__
39883         - name: vlan-interface
39884           in: path
39885           description: String that identifies the interface
39886           required: true
39887           type: string
39888           example: __VLAN-INTERFACE__
39889         - name: l3-interface-ipv6-address
39890           in: path
39891           description: IP address
39892           required: true
39893           type: string
39894           example: __L3-INTERFACE-IPV6-ADDRESS__
39895     put:
39896       tags:
39897         - Network
39898       summary: create or update an existing l3-interface-ipv6-address-list
39899       description: |
39900         Create or update an existing l3-interface-ipv6-address-list.
39901         #
39902         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39903       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39904       consumes:
39905         - application/json
39906         - application/xml
39907       produces:
39908         - application/json
39909         - application/xml
39910       responses:
39911         "default":
39912           description: Response codes found in [response codes](https://wiki.onap.org/).
39913       parameters:
39914         - name: pnf-name
39915           in: path
39916           description: unique name of Physical Network Function.
39917           required: true
39918           type: string
39919           example: __PNF-NAME__
39920         - name: interface-name
39921           in: path
39922           description: Name that identifies the physical interface
39923           required: true
39924           type: string
39925           example: __INTERFACE-NAME__
39926         - name: interface-name
39927           in: path
39928           description: Name given to the interface
39929           required: true
39930           type: string
39931           example: __INTERFACE-NAME__
39932         - name: vlan-interface
39933           in: path
39934           description: String that identifies the interface
39935           required: true
39936           type: string
39937           example: __VLAN-INTERFACE__
39938         - name: l3-interface-ipv6-address
39939           in: path
39940           description: IP address
39941           required: true
39942           type: string
39943           example: __L3-INTERFACE-IPV6-ADDRESS__
39944         - name: body
39945           in: body
39946           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
39947           required: true
39948           schema:
39949             $ref: "#/definitions/l3-interface-ipv6-address-list"
39950     patch:
39951       tags:
39952         - Network
39953       summary: update an existing l3-interface-ipv6-address-list
39954       description: |
39955         Update an existing l3-interface-ipv6-address-list
39956         #
39957         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39958         The PUT operation will entirely replace an existing object.
39959         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39960         #
39961         Other differences between PUT and PATCH are:
39962         #
39963         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39964         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39965         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39966       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39967       consumes:
39968         - application/json
39969         - application/xml
39970       produces:
39971         - application/json
39972         - application/xml
39973       responses:
39974         "default":
39975           description: Response codes found in [response codes](https://wiki.onap.org/).
39976       parameters:
39977         - name: pnf-name
39978           in: path
39979           description: unique name of Physical Network Function.
39980           required: true
39981           type: string
39982           example: __PNF-NAME__
39983         - name: interface-name
39984           in: path
39985           description: Name that identifies the physical interface
39986           required: true
39987           type: string
39988           example: __INTERFACE-NAME__
39989         - name: interface-name
39990           in: path
39991           description: Name given to the interface
39992           required: true
39993           type: string
39994           example: __INTERFACE-NAME__
39995         - name: vlan-interface
39996           in: path
39997           description: String that identifies the interface
39998           required: true
39999           type: string
40000           example: __VLAN-INTERFACE__
40001         - name: l3-interface-ipv6-address
40002           in: path
40003           description: IP address
40004           required: true
40005           type: string
40006           example: __L3-INTERFACE-IPV6-ADDRESS__
40007         - name: body
40008           in: body
40009           description: l3-interface-ipv6-address-list object that needs to be updated.
40010           required: true
40011           schema:
40012             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
40013     delete:
40014       tags:
40015         - Network
40016       summary: delete an existing l3-interface-ipv6-address-list
40017       description: delete an existing l3-interface-ipv6-address-list
40018       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40019       consumes:
40020         - application/json
40021         - application/xml
40022       produces:
40023         - application/json
40024         - application/xml
40025       responses:
40026         "default":
40027           description: Response codes found in [response codes](https://wiki.onap.org/).
40028       parameters:
40029         - name: pnf-name
40030           in: path
40031           description: unique name of Physical Network Function.
40032           required: true
40033           type: string
40034           example: __PNF-NAME__
40035         - name: interface-name
40036           in: path
40037           description: Name that identifies the physical interface
40038           required: true
40039           type: string
40040           example: __INTERFACE-NAME__
40041         - name: interface-name
40042           in: path
40043           description: Name given to the interface
40044           required: true
40045           type: string
40046           example: __INTERFACE-NAME__
40047         - name: vlan-interface
40048           in: path
40049           description: String that identifies the interface
40050           required: true
40051           type: string
40052           example: __VLAN-INTERFACE__
40053         - name: l3-interface-ipv6-address
40054           in: path
40055           description: IP address
40056           required: true
40057           type: string
40058           example: __L3-INTERFACE-IPV6-ADDRESS__
40059         - name: resource-version
40060           in: query
40061           description: resource-version for concurrency
40062           required: true
40063           type: string
40064   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
40065     get:
40066       tags:
40067         - Network
40068       summary: returns vlan
40069       description: returns vlan
40070       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40071       produces:
40072         - application/json
40073         - application/xml
40074       responses:
40075         "200":
40076           description: successful operation
40077           schema:
40078               $ref: "#/getDefinitions/vlan"
40079         "default":
40080           description: Response codes found in [response codes](https://wiki.onap.org/).
40081       parameters:
40082         - name: pnf-name
40083           in: path
40084           description: unique name of Physical Network Function.
40085           required: true
40086           type: string
40087           example: __PNF-NAME__
40088         - name: interface-name
40089           in: path
40090           description: Name that identifies the physical interface
40091           required: true
40092           type: string
40093           example: __INTERFACE-NAME__
40094         - name: interface-name
40095           in: path
40096           description: Name given to the interface
40097           required: true
40098           type: string
40099           example: __INTERFACE-NAME__
40100         - name: vlan-interface
40101           in: path
40102           description: String that identifies the interface
40103           required: true
40104           type: string
40105           example: __VLAN-INTERFACE__
40106     put:
40107       tags:
40108         - Network
40109       summary: create or update an existing vlan
40110       description: |
40111         Create or update an existing vlan.
40112         #
40113         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40114       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40115       consumes:
40116         - application/json
40117         - application/xml
40118       produces:
40119         - application/json
40120         - application/xml
40121       responses:
40122         "default":
40123           description: Response codes found in [response codes](https://wiki.onap.org/).
40124       parameters:
40125         - name: pnf-name
40126           in: path
40127           description: unique name of Physical Network Function.
40128           required: true
40129           type: string
40130           example: __PNF-NAME__
40131         - name: interface-name
40132           in: path
40133           description: Name that identifies the physical interface
40134           required: true
40135           type: string
40136           example: __INTERFACE-NAME__
40137         - name: interface-name
40138           in: path
40139           description: Name given to the interface
40140           required: true
40141           type: string
40142           example: __INTERFACE-NAME__
40143         - name: vlan-interface
40144           in: path
40145           description: String that identifies the interface
40146           required: true
40147           type: string
40148           example: __VLAN-INTERFACE__
40149         - name: body
40150           in: body
40151           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
40152           required: true
40153           schema:
40154             $ref: "#/definitions/vlan"
40155     patch:
40156       tags:
40157         - Network
40158       summary: update an existing vlan
40159       description: |
40160         Update an existing vlan
40161         #
40162         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40163         The PUT operation will entirely replace an existing object.
40164         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40165         #
40166         Other differences between PUT and PATCH are:
40167         #
40168         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40169         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40170         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40171       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40172       consumes:
40173         - application/json
40174         - application/xml
40175       produces:
40176         - application/json
40177         - application/xml
40178       responses:
40179         "default":
40180           description: Response codes found in [response codes](https://wiki.onap.org/).
40181       parameters:
40182         - name: pnf-name
40183           in: path
40184           description: unique name of Physical Network Function.
40185           required: true
40186           type: string
40187           example: __PNF-NAME__
40188         - name: interface-name
40189           in: path
40190           description: Name that identifies the physical interface
40191           required: true
40192           type: string
40193           example: __INTERFACE-NAME__
40194         - name: interface-name
40195           in: path
40196           description: Name given to the interface
40197           required: true
40198           type: string
40199           example: __INTERFACE-NAME__
40200         - name: vlan-interface
40201           in: path
40202           description: String that identifies the interface
40203           required: true
40204           type: string
40205           example: __VLAN-INTERFACE__
40206         - name: body
40207           in: body
40208           description: vlan object that needs to be updated.
40209           required: true
40210           schema:
40211             $ref: "#/patchDefinitions/vlan"
40212     delete:
40213       tags:
40214         - Network
40215       summary: delete an existing vlan
40216       description: delete an existing vlan
40217       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40218       consumes:
40219         - application/json
40220         - application/xml
40221       produces:
40222         - application/json
40223         - application/xml
40224       responses:
40225         "default":
40226           description: Response codes found in [response codes](https://wiki.onap.org/).
40227       parameters:
40228         - name: pnf-name
40229           in: path
40230           description: unique name of Physical Network Function.
40231           required: true
40232           type: string
40233           example: __PNF-NAME__
40234         - name: interface-name
40235           in: path
40236           description: Name that identifies the physical interface
40237           required: true
40238           type: string
40239           example: __INTERFACE-NAME__
40240         - name: interface-name
40241           in: path
40242           description: Name given to the interface
40243           required: true
40244           type: string
40245           example: __INTERFACE-NAME__
40246         - name: vlan-interface
40247           in: path
40248           description: String that identifies the interface
40249           required: true
40250           type: string
40251           example: __VLAN-INTERFACE__
40252         - name: resource-version
40253           in: query
40254           description: resource-version for concurrency
40255           required: true
40256           type: string
40257   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
40258     get:
40259       tags:
40260         - Network
40261       summary: returns vlans
40262       description: returns vlans
40263       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
40264       produces:
40265         - application/json
40266         - application/xml
40267       responses:
40268         "200":
40269           description: successful operation
40270           schema:
40271               $ref: "#/getDefinitions/vlans"
40272         "default":
40273           description: Response codes found in [response codes](https://wiki.onap.org/).
40274       parameters:
40275         - name: pnf-name
40276           in: path
40277           description: unique name of Physical Network Function.
40278           required: true
40279           type: string
40280           example: __PNF-NAME__
40281         - name: interface-name
40282           in: path
40283           description: Name that identifies the physical interface
40284           required: true
40285           type: string
40286           example: __INTERFACE-NAME__
40287         - name: interface-name
40288           in: path
40289           description: Name given to the interface
40290           required: true
40291           type: string
40292           example: __INTERFACE-NAME__
40293         - name: vlan-interface
40294           in: query
40295           description:
40296           required: false
40297           type: string
40298         - name: vlan-id-inner
40299           in: query
40300           description:
40301           required: false
40302           type: integer
40303           format: int64
40304         - name: vpn-key
40305           in: query
40306           description:
40307           required: false
40308           type: string
40309   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
40310     put:
40311       tags:
40312         - Network
40313       summary: see node definition for valid relationships
40314       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
40315       consumes:
40316         - application/json
40317         - application/xml
40318       produces:
40319         - application/json
40320         - application/xml
40321       responses:
40322         "default":
40323           description: Response codes found in [response codes](https://wiki.onap.org/).
40324       parameters:
40325         - name: pnf-name
40326           in: path
40327           description: unique name of Physical Network Function.
40328           required: true
40329           type: string
40330           example: __PNF-NAME__
40331         - name: interface-name
40332           in: path
40333           description: Name that identifies the physical interface
40334           required: true
40335           type: string
40336           example: __INTERFACE-NAME__
40337         - name: interface-name
40338           in: path
40339           description: Name given to the interface
40340           required: true
40341           type: string
40342           example: __INTERFACE-NAME__
40343         - name: pci-id
40344           in: path
40345           description: PCI ID used to identify the sriov-vf
40346           required: true
40347           type: string
40348           example: __PCI-ID__
40349         - name: body
40350           in: body
40351           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
40352           required: true
40353           schema:
40354             $ref: "#/definitions/relationship"
40355     delete:
40356       tags:
40357         - Network
40358       summary: delete an existing relationship
40359       description: delete an existing relationship
40360       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
40361       consumes:
40362         - application/json
40363         - application/xml
40364       produces:
40365         - application/json
40366         - application/xml
40367       responses:
40368         "default":
40369           description: Response codes found in [response codes](https://wiki.onap.org/).
40370       parameters:
40371         - name: pnf-name
40372           in: path
40373           description: unique name of Physical Network Function.
40374           required: true
40375           type: string
40376           example: __PNF-NAME__
40377         - name: interface-name
40378           in: path
40379           description: Name that identifies the physical interface
40380           required: true
40381           type: string
40382           example: __INTERFACE-NAME__
40383         - name: interface-name
40384           in: path
40385           description: Name given to the interface
40386           required: true
40387           type: string
40388           example: __INTERFACE-NAME__
40389         - name: pci-id
40390           in: path
40391           description: PCI ID used to identify the sriov-vf
40392           required: true
40393           type: string
40394           example: __PCI-ID__
40395   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
40396     get:
40397       tags:
40398         - Network
40399       summary: returns sriov-vf
40400       description: returns sriov-vf
40401       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40402       produces:
40403         - application/json
40404         - application/xml
40405       responses:
40406         "200":
40407           description: successful operation
40408           schema:
40409               $ref: "#/getDefinitions/sriov-vf"
40410         "default":
40411           description: Response codes found in [response codes](https://wiki.onap.org/).
40412       parameters:
40413         - name: pnf-name
40414           in: path
40415           description: unique name of Physical Network Function.
40416           required: true
40417           type: string
40418           example: __PNF-NAME__
40419         - name: interface-name
40420           in: path
40421           description: Name that identifies the physical interface
40422           required: true
40423           type: string
40424           example: __INTERFACE-NAME__
40425         - name: interface-name
40426           in: path
40427           description: Name given to the interface
40428           required: true
40429           type: string
40430           example: __INTERFACE-NAME__
40431         - name: pci-id
40432           in: path
40433           description: PCI ID used to identify the sriov-vf
40434           required: true
40435           type: string
40436           example: __PCI-ID__
40437     put:
40438       tags:
40439         - Network
40440       summary: create or update an existing sriov-vf
40441       description: |
40442         Create or update an existing sriov-vf.
40443         #
40444         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40445       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40446       consumes:
40447         - application/json
40448         - application/xml
40449       produces:
40450         - application/json
40451         - application/xml
40452       responses:
40453         "default":
40454           description: Response codes found in [response codes](https://wiki.onap.org/).
40455       parameters:
40456         - name: pnf-name
40457           in: path
40458           description: unique name of Physical Network Function.
40459           required: true
40460           type: string
40461           example: __PNF-NAME__
40462         - name: interface-name
40463           in: path
40464           description: Name that identifies the physical interface
40465           required: true
40466           type: string
40467           example: __INTERFACE-NAME__
40468         - name: interface-name
40469           in: path
40470           description: Name given to the interface
40471           required: true
40472           type: string
40473           example: __INTERFACE-NAME__
40474         - name: pci-id
40475           in: path
40476           description: PCI ID used to identify the sriov-vf
40477           required: true
40478           type: string
40479           example: __PCI-ID__
40480         - name: body
40481           in: body
40482           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
40483           required: true
40484           schema:
40485             $ref: "#/definitions/sriov-vf"
40486     patch:
40487       tags:
40488         - Network
40489       summary: update an existing sriov-vf
40490       description: |
40491         Update an existing sriov-vf
40492         #
40493         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40494         The PUT operation will entirely replace an existing object.
40495         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40496         #
40497         Other differences between PUT and PATCH are:
40498         #
40499         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40500         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40501         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40502       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40503       consumes:
40504         - application/json
40505         - application/xml
40506       produces:
40507         - application/json
40508         - application/xml
40509       responses:
40510         "default":
40511           description: Response codes found in [response codes](https://wiki.onap.org/).
40512       parameters:
40513         - name: pnf-name
40514           in: path
40515           description: unique name of Physical Network Function.
40516           required: true
40517           type: string
40518           example: __PNF-NAME__
40519         - name: interface-name
40520           in: path
40521           description: Name that identifies the physical interface
40522           required: true
40523           type: string
40524           example: __INTERFACE-NAME__
40525         - name: interface-name
40526           in: path
40527           description: Name given to the interface
40528           required: true
40529           type: string
40530           example: __INTERFACE-NAME__
40531         - name: pci-id
40532           in: path
40533           description: PCI ID used to identify the sriov-vf
40534           required: true
40535           type: string
40536           example: __PCI-ID__
40537         - name: body
40538           in: body
40539           description: sriov-vf object that needs to be updated.
40540           required: true
40541           schema:
40542             $ref: "#/patchDefinitions/sriov-vf"
40543     delete:
40544       tags:
40545         - Network
40546       summary: delete an existing sriov-vf
40547       description: delete an existing sriov-vf
40548       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40549       consumes:
40550         - application/json
40551         - application/xml
40552       produces:
40553         - application/json
40554         - application/xml
40555       responses:
40556         "default":
40557           description: Response codes found in [response codes](https://wiki.onap.org/).
40558       parameters:
40559         - name: pnf-name
40560           in: path
40561           description: unique name of Physical Network Function.
40562           required: true
40563           type: string
40564           example: __PNF-NAME__
40565         - name: interface-name
40566           in: path
40567           description: Name that identifies the physical interface
40568           required: true
40569           type: string
40570           example: __INTERFACE-NAME__
40571         - name: interface-name
40572           in: path
40573           description: Name given to the interface
40574           required: true
40575           type: string
40576           example: __INTERFACE-NAME__
40577         - name: pci-id
40578           in: path
40579           description: PCI ID used to identify the sriov-vf
40580           required: true
40581           type: string
40582           example: __PCI-ID__
40583         - name: resource-version
40584           in: query
40585           description: resource-version for concurrency
40586           required: true
40587           type: string
40588   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
40589     get:
40590       tags:
40591         - Network
40592       summary: returns sriov-vfs
40593       description: returns sriov-vfs
40594       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
40595       produces:
40596         - application/json
40597         - application/xml
40598       responses:
40599         "200":
40600           description: successful operation
40601           schema:
40602               $ref: "#/getDefinitions/sriov-vfs"
40603         "default":
40604           description: Response codes found in [response codes](https://wiki.onap.org/).
40605       parameters:
40606         - name: pnf-name
40607           in: path
40608           description: unique name of Physical Network Function.
40609           required: true
40610           type: string
40611           example: __PNF-NAME__
40612         - name: interface-name
40613           in: path
40614           description: Name that identifies the physical interface
40615           required: true
40616           type: string
40617           example: __INTERFACE-NAME__
40618         - name: interface-name
40619           in: path
40620           description: Name given to the interface
40621           required: true
40622           type: string
40623           example: __INTERFACE-NAME__
40624         - name: pci-id
40625           in: query
40626           description:
40627           required: false
40628           type: string
40629         - name: vf-vlan-filter
40630           in: query
40631           description:
40632           required: false
40633           type: string
40634         - name: vf-mac-filter
40635           in: query
40636           description:
40637           required: false
40638           type: string
40639         - name: vf-vlan-strip
40640           in: query
40641           description:
40642           required: false
40643           type: boolean
40644         - name: neutron-network-id
40645           in: query
40646           description:
40647           required: false
40648           type: string
40649   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
40650     put:
40651       tags:
40652         - Network
40653       summary: see node definition for valid relationships
40654       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
40655       consumes:
40656         - application/json
40657         - application/xml
40658       produces:
40659         - application/json
40660         - application/xml
40661       responses:
40662         "default":
40663           description: Response codes found in [response codes](https://wiki.onap.org/).
40664       parameters:
40665         - name: pnf-name
40666           in: path
40667           description: unique name of Physical Network Function.
40668           required: true
40669           type: string
40670           example: __PNF-NAME__
40671         - name: interface-name
40672           in: path
40673           description: Name that identifies the physical interface
40674           required: true
40675           type: string
40676           example: __INTERFACE-NAME__
40677         - name: interface-name
40678           in: path
40679           description: Name given to the interface
40680           required: true
40681           type: string
40682           example: __INTERFACE-NAME__
40683         - name: body
40684           in: body
40685           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
40686           required: true
40687           schema:
40688             $ref: "#/definitions/relationship"
40689     delete:
40690       tags:
40691         - Network
40692       summary: delete an existing relationship
40693       description: delete an existing relationship
40694       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
40695       consumes:
40696         - application/json
40697         - application/xml
40698       produces:
40699         - application/json
40700         - application/xml
40701       responses:
40702         "default":
40703           description: Response codes found in [response codes](https://wiki.onap.org/).
40704       parameters:
40705         - name: pnf-name
40706           in: path
40707           description: unique name of Physical Network Function.
40708           required: true
40709           type: string
40710           example: __PNF-NAME__
40711         - name: interface-name
40712           in: path
40713           description: Name that identifies the physical interface
40714           required: true
40715           type: string
40716           example: __INTERFACE-NAME__
40717         - name: interface-name
40718           in: path
40719           description: Name given to the interface
40720           required: true
40721           type: string
40722           example: __INTERFACE-NAME__
40723   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
40724     put:
40725       tags:
40726         - Network
40727       summary: see node definition for valid relationships
40728       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
40729       consumes:
40730         - application/json
40731         - application/xml
40732       produces:
40733         - application/json
40734         - application/xml
40735       responses:
40736         "default":
40737           description: Response codes found in [response codes](https://wiki.onap.org/).
40738       parameters:
40739         - name: pnf-name
40740           in: path
40741           description: unique name of Physical Network Function.
40742           required: true
40743           type: string
40744           example: __PNF-NAME__
40745         - name: interface-name
40746           in: path
40747           description: Name that identifies the physical interface
40748           required: true
40749           type: string
40750           example: __INTERFACE-NAME__
40751         - name: interface-name
40752           in: path
40753           description: Name given to the interface
40754           required: true
40755           type: string
40756           example: __INTERFACE-NAME__
40757         - name: l3-interface-ipv4-address
40758           in: path
40759           description: IP address
40760           required: true
40761           type: string
40762           example: __L3-INTERFACE-IPV4-ADDRESS__
40763         - name: body
40764           in: body
40765           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
40766           required: true
40767           schema:
40768             $ref: "#/definitions/relationship"
40769     delete:
40770       tags:
40771         - Network
40772       summary: delete an existing relationship
40773       description: delete an existing relationship
40774       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
40775       consumes:
40776         - application/json
40777         - application/xml
40778       produces:
40779         - application/json
40780         - application/xml
40781       responses:
40782         "default":
40783           description: Response codes found in [response codes](https://wiki.onap.org/).
40784       parameters:
40785         - name: pnf-name
40786           in: path
40787           description: unique name of Physical Network Function.
40788           required: true
40789           type: string
40790           example: __PNF-NAME__
40791         - name: interface-name
40792           in: path
40793           description: Name that identifies the physical interface
40794           required: true
40795           type: string
40796           example: __INTERFACE-NAME__
40797         - name: interface-name
40798           in: path
40799           description: Name given to the interface
40800           required: true
40801           type: string
40802           example: __INTERFACE-NAME__
40803         - name: l3-interface-ipv4-address
40804           in: path
40805           description: IP address
40806           required: true
40807           type: string
40808           example: __L3-INTERFACE-IPV4-ADDRESS__
40809   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
40810     get:
40811       tags:
40812         - Network
40813       summary: returns l3-interface-ipv4-address-list
40814       description: returns l3-interface-ipv4-address-list
40815       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40816       produces:
40817         - application/json
40818         - application/xml
40819       responses:
40820         "200":
40821           description: successful operation
40822           schema:
40823               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
40824         "default":
40825           description: Response codes found in [response codes](https://wiki.onap.org/).
40826       parameters:
40827         - name: pnf-name
40828           in: path
40829           description: unique name of Physical Network Function.
40830           required: true
40831           type: string
40832           example: __PNF-NAME__
40833         - name: interface-name
40834           in: path
40835           description: Name that identifies the physical interface
40836           required: true
40837           type: string
40838           example: __INTERFACE-NAME__
40839         - name: interface-name
40840           in: path
40841           description: Name given to the interface
40842           required: true
40843           type: string
40844           example: __INTERFACE-NAME__
40845         - name: l3-interface-ipv4-address
40846           in: path
40847           description: IP address
40848           required: true
40849           type: string
40850           example: __L3-INTERFACE-IPV4-ADDRESS__
40851     put:
40852       tags:
40853         - Network
40854       summary: create or update an existing l3-interface-ipv4-address-list
40855       description: |
40856         Create or update an existing l3-interface-ipv4-address-list.
40857         #
40858         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40859       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40860       consumes:
40861         - application/json
40862         - application/xml
40863       produces:
40864         - application/json
40865         - application/xml
40866       responses:
40867         "default":
40868           description: Response codes found in [response codes](https://wiki.onap.org/).
40869       parameters:
40870         - name: pnf-name
40871           in: path
40872           description: unique name of Physical Network Function.
40873           required: true
40874           type: string
40875           example: __PNF-NAME__
40876         - name: interface-name
40877           in: path
40878           description: Name that identifies the physical interface
40879           required: true
40880           type: string
40881           example: __INTERFACE-NAME__
40882         - name: interface-name
40883           in: path
40884           description: Name given to the interface
40885           required: true
40886           type: string
40887           example: __INTERFACE-NAME__
40888         - name: l3-interface-ipv4-address
40889           in: path
40890           description: IP address
40891           required: true
40892           type: string
40893           example: __L3-INTERFACE-IPV4-ADDRESS__
40894         - name: body
40895           in: body
40896           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
40897           required: true
40898           schema:
40899             $ref: "#/definitions/l3-interface-ipv4-address-list"
40900     patch:
40901       tags:
40902         - Network
40903       summary: update an existing l3-interface-ipv4-address-list
40904       description: |
40905         Update an existing l3-interface-ipv4-address-list
40906         #
40907         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40908         The PUT operation will entirely replace an existing object.
40909         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40910         #
40911         Other differences between PUT and PATCH are:
40912         #
40913         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40914         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40915         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40916       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40917       consumes:
40918         - application/json
40919         - application/xml
40920       produces:
40921         - application/json
40922         - application/xml
40923       responses:
40924         "default":
40925           description: Response codes found in [response codes](https://wiki.onap.org/).
40926       parameters:
40927         - name: pnf-name
40928           in: path
40929           description: unique name of Physical Network Function.
40930           required: true
40931           type: string
40932           example: __PNF-NAME__
40933         - name: interface-name
40934           in: path
40935           description: Name that identifies the physical interface
40936           required: true
40937           type: string
40938           example: __INTERFACE-NAME__
40939         - name: interface-name
40940           in: path
40941           description: Name given to the interface
40942           required: true
40943           type: string
40944           example: __INTERFACE-NAME__
40945         - name: l3-interface-ipv4-address
40946           in: path
40947           description: IP address
40948           required: true
40949           type: string
40950           example: __L3-INTERFACE-IPV4-ADDRESS__
40951         - name: body
40952           in: body
40953           description: l3-interface-ipv4-address-list object that needs to be updated.
40954           required: true
40955           schema:
40956             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
40957     delete:
40958       tags:
40959         - Network
40960       summary: delete an existing l3-interface-ipv4-address-list
40961       description: delete an existing l3-interface-ipv4-address-list
40962       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40963       consumes:
40964         - application/json
40965         - application/xml
40966       produces:
40967         - application/json
40968         - application/xml
40969       responses:
40970         "default":
40971           description: Response codes found in [response codes](https://wiki.onap.org/).
40972       parameters:
40973         - name: pnf-name
40974           in: path
40975           description: unique name of Physical Network Function.
40976           required: true
40977           type: string
40978           example: __PNF-NAME__
40979         - name: interface-name
40980           in: path
40981           description: Name that identifies the physical interface
40982           required: true
40983           type: string
40984           example: __INTERFACE-NAME__
40985         - name: interface-name
40986           in: path
40987           description: Name given to the interface
40988           required: true
40989           type: string
40990           example: __INTERFACE-NAME__
40991         - name: l3-interface-ipv4-address
40992           in: path
40993           description: IP address
40994           required: true
40995           type: string
40996           example: __L3-INTERFACE-IPV4-ADDRESS__
40997         - name: resource-version
40998           in: query
40999           description: resource-version for concurrency
41000           required: true
41001           type: string
41002   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
41003     put:
41004       tags:
41005         - Network
41006       summary: see node definition for valid relationships
41007       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
41008       consumes:
41009         - application/json
41010         - application/xml
41011       produces:
41012         - application/json
41013         - application/xml
41014       responses:
41015         "default":
41016           description: Response codes found in [response codes](https://wiki.onap.org/).
41017       parameters:
41018         - name: pnf-name
41019           in: path
41020           description: unique name of Physical Network Function.
41021           required: true
41022           type: string
41023           example: __PNF-NAME__
41024         - name: interface-name
41025           in: path
41026           description: Name that identifies the physical interface
41027           required: true
41028           type: string
41029           example: __INTERFACE-NAME__
41030         - name: interface-name
41031           in: path
41032           description: Name given to the interface
41033           required: true
41034           type: string
41035           example: __INTERFACE-NAME__
41036         - name: l3-interface-ipv6-address
41037           in: path
41038           description: IP address
41039           required: true
41040           type: string
41041           example: __L3-INTERFACE-IPV6-ADDRESS__
41042         - name: body
41043           in: body
41044           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
41045           required: true
41046           schema:
41047             $ref: "#/definitions/relationship"
41048     delete:
41049       tags:
41050         - Network
41051       summary: delete an existing relationship
41052       description: delete an existing relationship
41053       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
41054       consumes:
41055         - application/json
41056         - application/xml
41057       produces:
41058         - application/json
41059         - application/xml
41060       responses:
41061         "default":
41062           description: Response codes found in [response codes](https://wiki.onap.org/).
41063       parameters:
41064         - name: pnf-name
41065           in: path
41066           description: unique name of Physical Network Function.
41067           required: true
41068           type: string
41069           example: __PNF-NAME__
41070         - name: interface-name
41071           in: path
41072           description: Name that identifies the physical interface
41073           required: true
41074           type: string
41075           example: __INTERFACE-NAME__
41076         - name: interface-name
41077           in: path
41078           description: Name given to the interface
41079           required: true
41080           type: string
41081           example: __INTERFACE-NAME__
41082         - name: l3-interface-ipv6-address
41083           in: path
41084           description: IP address
41085           required: true
41086           type: string
41087           example: __L3-INTERFACE-IPV6-ADDRESS__
41088   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
41089     get:
41090       tags:
41091         - Network
41092       summary: returns l3-interface-ipv6-address-list
41093       description: returns l3-interface-ipv6-address-list
41094       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41095       produces:
41096         - application/json
41097         - application/xml
41098       responses:
41099         "200":
41100           description: successful operation
41101           schema:
41102               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
41103         "default":
41104           description: Response codes found in [response codes](https://wiki.onap.org/).
41105       parameters:
41106         - name: pnf-name
41107           in: path
41108           description: unique name of Physical Network Function.
41109           required: true
41110           type: string
41111           example: __PNF-NAME__
41112         - name: interface-name
41113           in: path
41114           description: Name that identifies the physical interface
41115           required: true
41116           type: string
41117           example: __INTERFACE-NAME__
41118         - name: interface-name
41119           in: path
41120           description: Name given to the interface
41121           required: true
41122           type: string
41123           example: __INTERFACE-NAME__
41124         - name: l3-interface-ipv6-address
41125           in: path
41126           description: IP address
41127           required: true
41128           type: string
41129           example: __L3-INTERFACE-IPV6-ADDRESS__
41130     put:
41131       tags:
41132         - Network
41133       summary: create or update an existing l3-interface-ipv6-address-list
41134       description: |
41135         Create or update an existing l3-interface-ipv6-address-list.
41136         #
41137         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41138       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41139       consumes:
41140         - application/json
41141         - application/xml
41142       produces:
41143         - application/json
41144         - application/xml
41145       responses:
41146         "default":
41147           description: Response codes found in [response codes](https://wiki.onap.org/).
41148       parameters:
41149         - name: pnf-name
41150           in: path
41151           description: unique name of Physical Network Function.
41152           required: true
41153           type: string
41154           example: __PNF-NAME__
41155         - name: interface-name
41156           in: path
41157           description: Name that identifies the physical interface
41158           required: true
41159           type: string
41160           example: __INTERFACE-NAME__
41161         - name: interface-name
41162           in: path
41163           description: Name given to the interface
41164           required: true
41165           type: string
41166           example: __INTERFACE-NAME__
41167         - name: l3-interface-ipv6-address
41168           in: path
41169           description: IP address
41170           required: true
41171           type: string
41172           example: __L3-INTERFACE-IPV6-ADDRESS__
41173         - name: body
41174           in: body
41175           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
41176           required: true
41177           schema:
41178             $ref: "#/definitions/l3-interface-ipv6-address-list"
41179     patch:
41180       tags:
41181         - Network
41182       summary: update an existing l3-interface-ipv6-address-list
41183       description: |
41184         Update an existing l3-interface-ipv6-address-list
41185         #
41186         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41187         The PUT operation will entirely replace an existing object.
41188         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41189         #
41190         Other differences between PUT and PATCH are:
41191         #
41192         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41193         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41194         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41195       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41196       consumes:
41197         - application/json
41198         - application/xml
41199       produces:
41200         - application/json
41201         - application/xml
41202       responses:
41203         "default":
41204           description: Response codes found in [response codes](https://wiki.onap.org/).
41205       parameters:
41206         - name: pnf-name
41207           in: path
41208           description: unique name of Physical Network Function.
41209           required: true
41210           type: string
41211           example: __PNF-NAME__
41212         - name: interface-name
41213           in: path
41214           description: Name that identifies the physical interface
41215           required: true
41216           type: string
41217           example: __INTERFACE-NAME__
41218         - name: interface-name
41219           in: path
41220           description: Name given to the interface
41221           required: true
41222           type: string
41223           example: __INTERFACE-NAME__
41224         - name: l3-interface-ipv6-address
41225           in: path
41226           description: IP address
41227           required: true
41228           type: string
41229           example: __L3-INTERFACE-IPV6-ADDRESS__
41230         - name: body
41231           in: body
41232           description: l3-interface-ipv6-address-list object that needs to be updated.
41233           required: true
41234           schema:
41235             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
41236     delete:
41237       tags:
41238         - Network
41239       summary: delete an existing l3-interface-ipv6-address-list
41240       description: delete an existing l3-interface-ipv6-address-list
41241       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41242       consumes:
41243         - application/json
41244         - application/xml
41245       produces:
41246         - application/json
41247         - application/xml
41248       responses:
41249         "default":
41250           description: Response codes found in [response codes](https://wiki.onap.org/).
41251       parameters:
41252         - name: pnf-name
41253           in: path
41254           description: unique name of Physical Network Function.
41255           required: true
41256           type: string
41257           example: __PNF-NAME__
41258         - name: interface-name
41259           in: path
41260           description: Name that identifies the physical interface
41261           required: true
41262           type: string
41263           example: __INTERFACE-NAME__
41264         - name: interface-name
41265           in: path
41266           description: Name given to the interface
41267           required: true
41268           type: string
41269           example: __INTERFACE-NAME__
41270         - name: l3-interface-ipv6-address
41271           in: path
41272           description: IP address
41273           required: true
41274           type: string
41275           example: __L3-INTERFACE-IPV6-ADDRESS__
41276         - name: resource-version
41277           in: query
41278           description: resource-version for concurrency
41279           required: true
41280           type: string
41281   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
41282     get:
41283       tags:
41284         - Network
41285       summary: returns l-interface
41286       description: returns l-interface
41287       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41288       produces:
41289         - application/json
41290         - application/xml
41291       responses:
41292         "200":
41293           description: successful operation
41294           schema:
41295               $ref: "#/getDefinitions/l-interface"
41296         "default":
41297           description: Response codes found in [response codes](https://wiki.onap.org/).
41298       parameters:
41299         - name: pnf-name
41300           in: path
41301           description: unique name of Physical Network Function.
41302           required: true
41303           type: string
41304           example: __PNF-NAME__
41305         - name: interface-name
41306           in: path
41307           description: Name that identifies the physical interface
41308           required: true
41309           type: string
41310           example: __INTERFACE-NAME__
41311         - name: interface-name
41312           in: path
41313           description: Name given to the interface
41314           required: true
41315           type: string
41316           example: __INTERFACE-NAME__
41317     put:
41318       tags:
41319         - Network
41320       summary: create or update an existing l-interface
41321       description: |
41322         Create or update an existing l-interface.
41323         #
41324         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41325       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41326       consumes:
41327         - application/json
41328         - application/xml
41329       produces:
41330         - application/json
41331         - application/xml
41332       responses:
41333         "default":
41334           description: Response codes found in [response codes](https://wiki.onap.org/).
41335       parameters:
41336         - name: pnf-name
41337           in: path
41338           description: unique name of Physical Network Function.
41339           required: true
41340           type: string
41341           example: __PNF-NAME__
41342         - name: interface-name
41343           in: path
41344           description: Name that identifies the physical interface
41345           required: true
41346           type: string
41347           example: __INTERFACE-NAME__
41348         - name: interface-name
41349           in: path
41350           description: Name given to the interface
41351           required: true
41352           type: string
41353           example: __INTERFACE-NAME__
41354         - name: body
41355           in: body
41356           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
41357           required: true
41358           schema:
41359             $ref: "#/definitions/l-interface"
41360     patch:
41361       tags:
41362         - Network
41363       summary: update an existing l-interface
41364       description: |
41365         Update an existing l-interface
41366         #
41367         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41368         The PUT operation will entirely replace an existing object.
41369         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41370         #
41371         Other differences between PUT and PATCH are:
41372         #
41373         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41374         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41375         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41376       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41377       consumes:
41378         - application/json
41379         - application/xml
41380       produces:
41381         - application/json
41382         - application/xml
41383       responses:
41384         "default":
41385           description: Response codes found in [response codes](https://wiki.onap.org/).
41386       parameters:
41387         - name: pnf-name
41388           in: path
41389           description: unique name of Physical Network Function.
41390           required: true
41391           type: string
41392           example: __PNF-NAME__
41393         - name: interface-name
41394           in: path
41395           description: Name that identifies the physical interface
41396           required: true
41397           type: string
41398           example: __INTERFACE-NAME__
41399         - name: interface-name
41400           in: path
41401           description: Name given to the interface
41402           required: true
41403           type: string
41404           example: __INTERFACE-NAME__
41405         - name: body
41406           in: body
41407           description: l-interface object that needs to be updated.
41408           required: true
41409           schema:
41410             $ref: "#/patchDefinitions/l-interface"
41411     delete:
41412       tags:
41413         - Network
41414       summary: delete an existing l-interface
41415       description: delete an existing l-interface
41416       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41417       consumes:
41418         - application/json
41419         - application/xml
41420       produces:
41421         - application/json
41422         - application/xml
41423       responses:
41424         "default":
41425           description: Response codes found in [response codes](https://wiki.onap.org/).
41426       parameters:
41427         - name: pnf-name
41428           in: path
41429           description: unique name of Physical Network Function.
41430           required: true
41431           type: string
41432           example: __PNF-NAME__
41433         - name: interface-name
41434           in: path
41435           description: Name that identifies the physical interface
41436           required: true
41437           type: string
41438           example: __INTERFACE-NAME__
41439         - name: interface-name
41440           in: path
41441           description: Name given to the interface
41442           required: true
41443           type: string
41444           example: __INTERFACE-NAME__
41445         - name: resource-version
41446           in: query
41447           description: resource-version for concurrency
41448           required: true
41449           type: string
41450   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
41451     get:
41452       tags:
41453         - Network
41454       summary: returns l-interfaces
41455       description: returns l-interfaces
41456       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
41457       produces:
41458         - application/json
41459         - application/xml
41460       responses:
41461         "200":
41462           description: successful operation
41463           schema:
41464               $ref: "#/getDefinitions/l-interfaces"
41465         "default":
41466           description: Response codes found in [response codes](https://wiki.onap.org/).
41467       parameters:
41468         - name: pnf-name
41469           in: path
41470           description: unique name of Physical Network Function.
41471           required: true
41472           type: string
41473           example: __PNF-NAME__
41474         - name: interface-name
41475           in: path
41476           description: Name that identifies the physical interface
41477           required: true
41478           type: string
41479           example: __INTERFACE-NAME__
41480         - name: interface-name
41481           in: query
41482           description:
41483           required: false
41484           type: string
41485         - name: interface-id
41486           in: query
41487           description:
41488           required: false
41489           type: string
41490         - name: macaddr
41491           in: query
41492           description:
41493           required: false
41494           type: string
41495         - name: network-name
41496           in: query
41497           description:
41498           required: false
41499           type: string
41500   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
41501     get:
41502       tags:
41503         - Network
41504       summary: returns p-interface
41505       description: returns p-interface
41506       operationId: getNetworkPnfsPnfPInterfacesPInterface
41507       produces:
41508         - application/json
41509         - application/xml
41510       responses:
41511         "200":
41512           description: successful operation
41513           schema:
41514               $ref: "#/getDefinitions/p-interface"
41515         "default":
41516           description: Response codes found in [response codes](https://wiki.onap.org/).
41517       parameters:
41518         - name: pnf-name
41519           in: path
41520           description: unique name of Physical Network Function.
41521           required: true
41522           type: string
41523           example: __PNF-NAME__
41524         - name: interface-name
41525           in: path
41526           description: Name that identifies the physical interface
41527           required: true
41528           type: string
41529           example: __INTERFACE-NAME__
41530     put:
41531       tags:
41532         - Network
41533       summary: create or update an existing p-interface
41534       description: |
41535         Create or update an existing p-interface.
41536         #
41537         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41538       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
41539       consumes:
41540         - application/json
41541         - application/xml
41542       produces:
41543         - application/json
41544         - application/xml
41545       responses:
41546         "default":
41547           description: Response codes found in [response codes](https://wiki.onap.org/).
41548       parameters:
41549         - name: pnf-name
41550           in: path
41551           description: unique name of Physical Network Function.
41552           required: true
41553           type: string
41554           example: __PNF-NAME__
41555         - name: interface-name
41556           in: path
41557           description: Name that identifies the physical interface
41558           required: true
41559           type: string
41560           example: __INTERFACE-NAME__
41561         - name: body
41562           in: body
41563           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json)
41564           required: true
41565           schema:
41566             $ref: "#/definitions/p-interface"
41567     patch:
41568       tags:
41569         - Network
41570       summary: update an existing p-interface
41571       description: |
41572         Update an existing p-interface
41573         #
41574         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41575         The PUT operation will entirely replace an existing object.
41576         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41577         #
41578         Other differences between PUT and PATCH are:
41579         #
41580         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41581         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41582         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41583       operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
41584       consumes:
41585         - application/json
41586         - application/xml
41587       produces:
41588         - application/json
41589         - application/xml
41590       responses:
41591         "default":
41592           description: Response codes found in [response codes](https://wiki.onap.org/).
41593       parameters:
41594         - name: pnf-name
41595           in: path
41596           description: unique name of Physical Network Function.
41597           required: true
41598           type: string
41599           example: __PNF-NAME__
41600         - name: interface-name
41601           in: path
41602           description: Name that identifies the physical interface
41603           required: true
41604           type: string
41605           example: __INTERFACE-NAME__
41606         - name: body
41607           in: body
41608           description: p-interface object that needs to be updated.
41609           required: true
41610           schema:
41611             $ref: "#/patchDefinitions/p-interface"
41612     delete:
41613       tags:
41614         - Network
41615       summary: delete an existing p-interface
41616       description: delete an existing p-interface
41617       operationId: deleteNetworkPnfsPnfPInterfacesPInterface
41618       consumes:
41619         - application/json
41620         - application/xml
41621       produces:
41622         - application/json
41623         - application/xml
41624       responses:
41625         "default":
41626           description: Response codes found in [response codes](https://wiki.onap.org/).
41627       parameters:
41628         - name: pnf-name
41629           in: path
41630           description: unique name of Physical Network Function.
41631           required: true
41632           type: string
41633           example: __PNF-NAME__
41634         - name: interface-name
41635           in: path
41636           description: Name that identifies the physical interface
41637           required: true
41638           type: string
41639           example: __INTERFACE-NAME__
41640         - name: resource-version
41641           in: query
41642           description: resource-version for concurrency
41643           required: true
41644           type: string
41645   /network/pnfs/pnf/{pnf-name}/p-interfaces:
41646     get:
41647       tags:
41648         - Network
41649       summary: returns p-interfaces
41650       description: returns p-interfaces
41651       operationId: getNetworkPnfsPnfPInterfaces
41652       produces:
41653         - application/json
41654         - application/xml
41655       responses:
41656         "200":
41657           description: successful operation
41658           schema:
41659               $ref: "#/getDefinitions/p-interfaces"
41660         "default":
41661           description: Response codes found in [response codes](https://wiki.onap.org/).
41662       parameters:
41663         - name: pnf-name
41664           in: path
41665           description: unique name of Physical Network Function.
41666           required: true
41667           type: string
41668           example: __PNF-NAME__
41669         - name: interface-name
41670           in: query
41671           description:
41672           required: false
41673           type: string
41674         - name: prov-status
41675           in: query
41676           description:
41677           required: false
41678           type: string
41679   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
41680     put:
41681       tags:
41682         - Network
41683       summary: see node definition for valid relationships
41684       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
41685       consumes:
41686         - application/json
41687         - application/xml
41688       produces:
41689         - application/json
41690         - application/xml
41691       responses:
41692         "default":
41693           description: Response codes found in [response codes](https://wiki.onap.org/).
41694       parameters:
41695         - name: pnf-name
41696           in: path
41697           description: unique name of Physical Network Function.
41698           required: true
41699           type: string
41700           example: __PNF-NAME__
41701         - name: interface-name
41702           in: path
41703           description: Name that identifies the link aggregate interface
41704           required: true
41705           type: string
41706           example: __INTERFACE-NAME__
41707         - name: body
41708           in: body
41709           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json)
41710           required: true
41711           schema:
41712             $ref: "#/definitions/relationship"
41713     delete:
41714       tags:
41715         - Network
41716       summary: delete an existing relationship
41717       description: delete an existing relationship
41718       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
41719       consumes:
41720         - application/json
41721         - application/xml
41722       produces:
41723         - application/json
41724         - application/xml
41725       responses:
41726         "default":
41727           description: Response codes found in [response codes](https://wiki.onap.org/).
41728       parameters:
41729         - name: pnf-name
41730           in: path
41731           description: unique name of Physical Network Function.
41732           required: true
41733           type: string
41734           example: __PNF-NAME__
41735         - name: interface-name
41736           in: path
41737           description: Name that identifies the link aggregate interface
41738           required: true
41739           type: string
41740           example: __INTERFACE-NAME__
41741   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
41742     put:
41743       tags:
41744         - Network
41745       summary: see node definition for valid relationships
41746       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
41747       consumes:
41748         - application/json
41749         - application/xml
41750       produces:
41751         - application/json
41752         - application/xml
41753       responses:
41754         "default":
41755           description: Response codes found in [response codes](https://wiki.onap.org/).
41756       parameters:
41757         - name: pnf-name
41758           in: path
41759           description: unique name of Physical Network Function.
41760           required: true
41761           type: string
41762           example: __PNF-NAME__
41763         - name: interface-name
41764           in: path
41765           description: Name that identifies the link aggregate interface
41766           required: true
41767           type: string
41768           example: __INTERFACE-NAME__
41769         - name: interface-name
41770           in: path
41771           description: Name given to the interface
41772           required: true
41773           type: string
41774           example: __INTERFACE-NAME__
41775         - name: vlan-interface
41776           in: path
41777           description: String that identifies the interface
41778           required: true
41779           type: string
41780           example: __VLAN-INTERFACE__
41781         - name: body
41782           in: body
41783           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
41784           required: true
41785           schema:
41786             $ref: "#/definitions/relationship"
41787     delete:
41788       tags:
41789         - Network
41790       summary: delete an existing relationship
41791       description: delete an existing relationship
41792       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
41793       consumes:
41794         - application/json
41795         - application/xml
41796       produces:
41797         - application/json
41798         - application/xml
41799       responses:
41800         "default":
41801           description: Response codes found in [response codes](https://wiki.onap.org/).
41802       parameters:
41803         - name: pnf-name
41804           in: path
41805           description: unique name of Physical Network Function.
41806           required: true
41807           type: string
41808           example: __PNF-NAME__
41809         - name: interface-name
41810           in: path
41811           description: Name that identifies the link aggregate interface
41812           required: true
41813           type: string
41814           example: __INTERFACE-NAME__
41815         - name: interface-name
41816           in: path
41817           description: Name given to the interface
41818           required: true
41819           type: string
41820           example: __INTERFACE-NAME__
41821         - name: vlan-interface
41822           in: path
41823           description: String that identifies the interface
41824           required: true
41825           type: string
41826           example: __VLAN-INTERFACE__
41827   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
41828     put:
41829       tags:
41830         - Network
41831       summary: see node definition for valid relationships
41832       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
41833       consumes:
41834         - application/json
41835         - application/xml
41836       produces:
41837         - application/json
41838         - application/xml
41839       responses:
41840         "default":
41841           description: Response codes found in [response codes](https://wiki.onap.org/).
41842       parameters:
41843         - name: pnf-name
41844           in: path
41845           description: unique name of Physical Network Function.
41846           required: true
41847           type: string
41848           example: __PNF-NAME__
41849         - name: interface-name
41850           in: path
41851           description: Name that identifies the link aggregate interface
41852           required: true
41853           type: string
41854           example: __INTERFACE-NAME__
41855         - name: interface-name
41856           in: path
41857           description: Name given to the interface
41858           required: true
41859           type: string
41860           example: __INTERFACE-NAME__
41861         - name: vlan-interface
41862           in: path
41863           description: String that identifies the interface
41864           required: true
41865           type: string
41866           example: __VLAN-INTERFACE__
41867         - name: l3-interface-ipv4-address
41868           in: path
41869           description: IP address
41870           required: true
41871           type: string
41872           example: __L3-INTERFACE-IPV4-ADDRESS__
41873         - name: body
41874           in: body
41875           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
41876           required: true
41877           schema:
41878             $ref: "#/definitions/relationship"
41879     delete:
41880       tags:
41881         - Network
41882       summary: delete an existing relationship
41883       description: delete an existing relationship
41884       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
41885       consumes:
41886         - application/json
41887         - application/xml
41888       produces:
41889         - application/json
41890         - application/xml
41891       responses:
41892         "default":
41893           description: Response codes found in [response codes](https://wiki.onap.org/).
41894       parameters:
41895         - name: pnf-name
41896           in: path
41897           description: unique name of Physical Network Function.
41898           required: true
41899           type: string
41900           example: __PNF-NAME__
41901         - name: interface-name
41902           in: path
41903           description: Name that identifies the link aggregate interface
41904           required: true
41905           type: string
41906           example: __INTERFACE-NAME__
41907         - name: interface-name
41908           in: path
41909           description: Name given to the interface
41910           required: true
41911           type: string
41912           example: __INTERFACE-NAME__
41913         - name: vlan-interface
41914           in: path
41915           description: String that identifies the interface
41916           required: true
41917           type: string
41918           example: __VLAN-INTERFACE__
41919         - name: l3-interface-ipv4-address
41920           in: path
41921           description: IP address
41922           required: true
41923           type: string
41924           example: __L3-INTERFACE-IPV4-ADDRESS__
41925   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
41926     get:
41927       tags:
41928         - Network
41929       summary: returns l3-interface-ipv4-address-list
41930       description: returns l3-interface-ipv4-address-list
41931       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
41932       produces:
41933         - application/json
41934         - application/xml
41935       responses:
41936         "200":
41937           description: successful operation
41938           schema:
41939               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
41940         "default":
41941           description: Response codes found in [response codes](https://wiki.onap.org/).
41942       parameters:
41943         - name: pnf-name
41944           in: path
41945           description: unique name of Physical Network Function.
41946           required: true
41947           type: string
41948           example: __PNF-NAME__
41949         - name: interface-name
41950           in: path
41951           description: Name that identifies the link aggregate interface
41952           required: true
41953           type: string
41954           example: __INTERFACE-NAME__
41955         - name: interface-name
41956           in: path
41957           description: Name given to the interface
41958           required: true
41959           type: string
41960           example: __INTERFACE-NAME__
41961         - name: vlan-interface
41962           in: path
41963           description: String that identifies the interface
41964           required: true
41965           type: string
41966           example: __VLAN-INTERFACE__
41967         - name: l3-interface-ipv4-address
41968           in: path
41969           description: IP address
41970           required: true
41971           type: string
41972           example: __L3-INTERFACE-IPV4-ADDRESS__
41973     put:
41974       tags:
41975         - Network
41976       summary: create or update an existing l3-interface-ipv4-address-list
41977       description: |
41978         Create or update an existing l3-interface-ipv4-address-list.
41979         #
41980         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41981       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
41982       consumes:
41983         - application/json
41984         - application/xml
41985       produces:
41986         - application/json
41987         - application/xml
41988       responses:
41989         "default":
41990           description: Response codes found in [response codes](https://wiki.onap.org/).
41991       parameters:
41992         - name: pnf-name
41993           in: path
41994           description: unique name of Physical Network Function.
41995           required: true
41996           type: string
41997           example: __PNF-NAME__
41998         - name: interface-name
41999           in: path
42000           description: Name that identifies the link aggregate interface
42001           required: true
42002           type: string
42003           example: __INTERFACE-NAME__
42004         - name: interface-name
42005           in: path
42006           description: Name given to the interface
42007           required: true
42008           type: string
42009           example: __INTERFACE-NAME__
42010         - name: vlan-interface
42011           in: path
42012           description: String that identifies the interface
42013           required: true
42014           type: string
42015           example: __VLAN-INTERFACE__
42016         - name: l3-interface-ipv4-address
42017           in: path
42018           description: IP address
42019           required: true
42020           type: string
42021           example: __L3-INTERFACE-IPV4-ADDRESS__
42022         - name: body
42023           in: body
42024           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
42025           required: true
42026           schema:
42027             $ref: "#/definitions/l3-interface-ipv4-address-list"
42028     patch:
42029       tags:
42030         - Network
42031       summary: update an existing l3-interface-ipv4-address-list
42032       description: |
42033         Update an existing l3-interface-ipv4-address-list
42034         #
42035         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42036         The PUT operation will entirely replace an existing object.
42037         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42038         #
42039         Other differences between PUT and PATCH are:
42040         #
42041         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42042         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42043         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42044       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42045       consumes:
42046         - application/json
42047         - application/xml
42048       produces:
42049         - application/json
42050         - application/xml
42051       responses:
42052         "default":
42053           description: Response codes found in [response codes](https://wiki.onap.org/).
42054       parameters:
42055         - name: pnf-name
42056           in: path
42057           description: unique name of Physical Network Function.
42058           required: true
42059           type: string
42060           example: __PNF-NAME__
42061         - name: interface-name
42062           in: path
42063           description: Name that identifies the link aggregate interface
42064           required: true
42065           type: string
42066           example: __INTERFACE-NAME__
42067         - name: interface-name
42068           in: path
42069           description: Name given to the interface
42070           required: true
42071           type: string
42072           example: __INTERFACE-NAME__
42073         - name: vlan-interface
42074           in: path
42075           description: String that identifies the interface
42076           required: true
42077           type: string
42078           example: __VLAN-INTERFACE__
42079         - name: l3-interface-ipv4-address
42080           in: path
42081           description: IP address
42082           required: true
42083           type: string
42084           example: __L3-INTERFACE-IPV4-ADDRESS__
42085         - name: body
42086           in: body
42087           description: l3-interface-ipv4-address-list object that needs to be updated.
42088           required: true
42089           schema:
42090             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
42091     delete:
42092       tags:
42093         - Network
42094       summary: delete an existing l3-interface-ipv4-address-list
42095       description: delete an existing l3-interface-ipv4-address-list
42096       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42097       consumes:
42098         - application/json
42099         - application/xml
42100       produces:
42101         - application/json
42102         - application/xml
42103       responses:
42104         "default":
42105           description: Response codes found in [response codes](https://wiki.onap.org/).
42106       parameters:
42107         - name: pnf-name
42108           in: path
42109           description: unique name of Physical Network Function.
42110           required: true
42111           type: string
42112           example: __PNF-NAME__
42113         - name: interface-name
42114           in: path
42115           description: Name that identifies the link aggregate interface
42116           required: true
42117           type: string
42118           example: __INTERFACE-NAME__
42119         - name: interface-name
42120           in: path
42121           description: Name given to the interface
42122           required: true
42123           type: string
42124           example: __INTERFACE-NAME__
42125         - name: vlan-interface
42126           in: path
42127           description: String that identifies the interface
42128           required: true
42129           type: string
42130           example: __VLAN-INTERFACE__
42131         - name: l3-interface-ipv4-address
42132           in: path
42133           description: IP address
42134           required: true
42135           type: string
42136           example: __L3-INTERFACE-IPV4-ADDRESS__
42137         - name: resource-version
42138           in: query
42139           description: resource-version for concurrency
42140           required: true
42141           type: string
42142   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
42143     put:
42144       tags:
42145         - Network
42146       summary: see node definition for valid relationships
42147       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42148       consumes:
42149         - application/json
42150         - application/xml
42151       produces:
42152         - application/json
42153         - application/xml
42154       responses:
42155         "default":
42156           description: Response codes found in [response codes](https://wiki.onap.org/).
42157       parameters:
42158         - name: pnf-name
42159           in: path
42160           description: unique name of Physical Network Function.
42161           required: true
42162           type: string
42163           example: __PNF-NAME__
42164         - name: interface-name
42165           in: path
42166           description: Name that identifies the link aggregate interface
42167           required: true
42168           type: string
42169           example: __INTERFACE-NAME__
42170         - name: interface-name
42171           in: path
42172           description: Name given to the interface
42173           required: true
42174           type: string
42175           example: __INTERFACE-NAME__
42176         - name: vlan-interface
42177           in: path
42178           description: String that identifies the interface
42179           required: true
42180           type: string
42181           example: __VLAN-INTERFACE__
42182         - name: l3-interface-ipv6-address
42183           in: path
42184           description: IP address
42185           required: true
42186           type: string
42187           example: __L3-INTERFACE-IPV6-ADDRESS__
42188         - name: body
42189           in: body
42190           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
42191           required: true
42192           schema:
42193             $ref: "#/definitions/relationship"
42194     delete:
42195       tags:
42196         - Network
42197       summary: delete an existing relationship
42198       description: delete an existing relationship
42199       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42200       consumes:
42201         - application/json
42202         - application/xml
42203       produces:
42204         - application/json
42205         - application/xml
42206       responses:
42207         "default":
42208           description: Response codes found in [response codes](https://wiki.onap.org/).
42209       parameters:
42210         - name: pnf-name
42211           in: path
42212           description: unique name of Physical Network Function.
42213           required: true
42214           type: string
42215           example: __PNF-NAME__
42216         - name: interface-name
42217           in: path
42218           description: Name that identifies the link aggregate interface
42219           required: true
42220           type: string
42221           example: __INTERFACE-NAME__
42222         - name: interface-name
42223           in: path
42224           description: Name given to the interface
42225           required: true
42226           type: string
42227           example: __INTERFACE-NAME__
42228         - name: vlan-interface
42229           in: path
42230           description: String that identifies the interface
42231           required: true
42232           type: string
42233           example: __VLAN-INTERFACE__
42234         - name: l3-interface-ipv6-address
42235           in: path
42236           description: IP address
42237           required: true
42238           type: string
42239           example: __L3-INTERFACE-IPV6-ADDRESS__
42240   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
42241     get:
42242       tags:
42243         - Network
42244       summary: returns l3-interface-ipv6-address-list
42245       description: returns l3-interface-ipv6-address-list
42246       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42247       produces:
42248         - application/json
42249         - application/xml
42250       responses:
42251         "200":
42252           description: successful operation
42253           schema:
42254               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
42255         "default":
42256           description: Response codes found in [response codes](https://wiki.onap.org/).
42257       parameters:
42258         - name: pnf-name
42259           in: path
42260           description: unique name of Physical Network Function.
42261           required: true
42262           type: string
42263           example: __PNF-NAME__
42264         - name: interface-name
42265           in: path
42266           description: Name that identifies the link aggregate interface
42267           required: true
42268           type: string
42269           example: __INTERFACE-NAME__
42270         - name: interface-name
42271           in: path
42272           description: Name given to the interface
42273           required: true
42274           type: string
42275           example: __INTERFACE-NAME__
42276         - name: vlan-interface
42277           in: path
42278           description: String that identifies the interface
42279           required: true
42280           type: string
42281           example: __VLAN-INTERFACE__
42282         - name: l3-interface-ipv6-address
42283           in: path
42284           description: IP address
42285           required: true
42286           type: string
42287           example: __L3-INTERFACE-IPV6-ADDRESS__
42288     put:
42289       tags:
42290         - Network
42291       summary: create or update an existing l3-interface-ipv6-address-list
42292       description: |
42293         Create or update an existing l3-interface-ipv6-address-list.
42294         #
42295         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42296       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42297       consumes:
42298         - application/json
42299         - application/xml
42300       produces:
42301         - application/json
42302         - application/xml
42303       responses:
42304         "default":
42305           description: Response codes found in [response codes](https://wiki.onap.org/).
42306       parameters:
42307         - name: pnf-name
42308           in: path
42309           description: unique name of Physical Network Function.
42310           required: true
42311           type: string
42312           example: __PNF-NAME__
42313         - name: interface-name
42314           in: path
42315           description: Name that identifies the link aggregate interface
42316           required: true
42317           type: string
42318           example: __INTERFACE-NAME__
42319         - name: interface-name
42320           in: path
42321           description: Name given to the interface
42322           required: true
42323           type: string
42324           example: __INTERFACE-NAME__
42325         - name: vlan-interface
42326           in: path
42327           description: String that identifies the interface
42328           required: true
42329           type: string
42330           example: __VLAN-INTERFACE__
42331         - name: l3-interface-ipv6-address
42332           in: path
42333           description: IP address
42334           required: true
42335           type: string
42336           example: __L3-INTERFACE-IPV6-ADDRESS__
42337         - name: body
42338           in: body
42339           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
42340           required: true
42341           schema:
42342             $ref: "#/definitions/l3-interface-ipv6-address-list"
42343     patch:
42344       tags:
42345         - Network
42346       summary: update an existing l3-interface-ipv6-address-list
42347       description: |
42348         Update an existing l3-interface-ipv6-address-list
42349         #
42350         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42351         The PUT operation will entirely replace an existing object.
42352         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42353         #
42354         Other differences between PUT and PATCH are:
42355         #
42356         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42357         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42358         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42359       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42360       consumes:
42361         - application/json
42362         - application/xml
42363       produces:
42364         - application/json
42365         - application/xml
42366       responses:
42367         "default":
42368           description: Response codes found in [response codes](https://wiki.onap.org/).
42369       parameters:
42370         - name: pnf-name
42371           in: path
42372           description: unique name of Physical Network Function.
42373           required: true
42374           type: string
42375           example: __PNF-NAME__
42376         - name: interface-name
42377           in: path
42378           description: Name that identifies the link aggregate interface
42379           required: true
42380           type: string
42381           example: __INTERFACE-NAME__
42382         - name: interface-name
42383           in: path
42384           description: Name given to the interface
42385           required: true
42386           type: string
42387           example: __INTERFACE-NAME__
42388         - name: vlan-interface
42389           in: path
42390           description: String that identifies the interface
42391           required: true
42392           type: string
42393           example: __VLAN-INTERFACE__
42394         - name: l3-interface-ipv6-address
42395           in: path
42396           description: IP address
42397           required: true
42398           type: string
42399           example: __L3-INTERFACE-IPV6-ADDRESS__
42400         - name: body
42401           in: body
42402           description: l3-interface-ipv6-address-list object that needs to be updated.
42403           required: true
42404           schema:
42405             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
42406     delete:
42407       tags:
42408         - Network
42409       summary: delete an existing l3-interface-ipv6-address-list
42410       description: delete an existing l3-interface-ipv6-address-list
42411       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42412       consumes:
42413         - application/json
42414         - application/xml
42415       produces:
42416         - application/json
42417         - application/xml
42418       responses:
42419         "default":
42420           description: Response codes found in [response codes](https://wiki.onap.org/).
42421       parameters:
42422         - name: pnf-name
42423           in: path
42424           description: unique name of Physical Network Function.
42425           required: true
42426           type: string
42427           example: __PNF-NAME__
42428         - name: interface-name
42429           in: path
42430           description: Name that identifies the link aggregate interface
42431           required: true
42432           type: string
42433           example: __INTERFACE-NAME__
42434         - name: interface-name
42435           in: path
42436           description: Name given to the interface
42437           required: true
42438           type: string
42439           example: __INTERFACE-NAME__
42440         - name: vlan-interface
42441           in: path
42442           description: String that identifies the interface
42443           required: true
42444           type: string
42445           example: __VLAN-INTERFACE__
42446         - name: l3-interface-ipv6-address
42447           in: path
42448           description: IP address
42449           required: true
42450           type: string
42451           example: __L3-INTERFACE-IPV6-ADDRESS__
42452         - name: resource-version
42453           in: query
42454           description: resource-version for concurrency
42455           required: true
42456           type: string
42457   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
42458     get:
42459       tags:
42460         - Network
42461       summary: returns vlan
42462       description: returns vlan
42463       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42464       produces:
42465         - application/json
42466         - application/xml
42467       responses:
42468         "200":
42469           description: successful operation
42470           schema:
42471               $ref: "#/getDefinitions/vlan"
42472         "default":
42473           description: Response codes found in [response codes](https://wiki.onap.org/).
42474       parameters:
42475         - name: pnf-name
42476           in: path
42477           description: unique name of Physical Network Function.
42478           required: true
42479           type: string
42480           example: __PNF-NAME__
42481         - name: interface-name
42482           in: path
42483           description: Name that identifies the link aggregate interface
42484           required: true
42485           type: string
42486           example: __INTERFACE-NAME__
42487         - name: interface-name
42488           in: path
42489           description: Name given to the interface
42490           required: true
42491           type: string
42492           example: __INTERFACE-NAME__
42493         - name: vlan-interface
42494           in: path
42495           description: String that identifies the interface
42496           required: true
42497           type: string
42498           example: __VLAN-INTERFACE__
42499     put:
42500       tags:
42501         - Network
42502       summary: create or update an existing vlan
42503       description: |
42504         Create or update an existing vlan.
42505         #
42506         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42507       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42508       consumes:
42509         - application/json
42510         - application/xml
42511       produces:
42512         - application/json
42513         - application/xml
42514       responses:
42515         "default":
42516           description: Response codes found in [response codes](https://wiki.onap.org/).
42517       parameters:
42518         - name: pnf-name
42519           in: path
42520           description: unique name of Physical Network Function.
42521           required: true
42522           type: string
42523           example: __PNF-NAME__
42524         - name: interface-name
42525           in: path
42526           description: Name that identifies the link aggregate interface
42527           required: true
42528           type: string
42529           example: __INTERFACE-NAME__
42530         - name: interface-name
42531           in: path
42532           description: Name given to the interface
42533           required: true
42534           type: string
42535           example: __INTERFACE-NAME__
42536         - name: vlan-interface
42537           in: path
42538           description: String that identifies the interface
42539           required: true
42540           type: string
42541           example: __VLAN-INTERFACE__
42542         - name: body
42543           in: body
42544           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
42545           required: true
42546           schema:
42547             $ref: "#/definitions/vlan"
42548     patch:
42549       tags:
42550         - Network
42551       summary: update an existing vlan
42552       description: |
42553         Update an existing vlan
42554         #
42555         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42556         The PUT operation will entirely replace an existing object.
42557         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42558         #
42559         Other differences between PUT and PATCH are:
42560         #
42561         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42562         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42563         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42564       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42565       consumes:
42566         - application/json
42567         - application/xml
42568       produces:
42569         - application/json
42570         - application/xml
42571       responses:
42572         "default":
42573           description: Response codes found in [response codes](https://wiki.onap.org/).
42574       parameters:
42575         - name: pnf-name
42576           in: path
42577           description: unique name of Physical Network Function.
42578           required: true
42579           type: string
42580           example: __PNF-NAME__
42581         - name: interface-name
42582           in: path
42583           description: Name that identifies the link aggregate interface
42584           required: true
42585           type: string
42586           example: __INTERFACE-NAME__
42587         - name: interface-name
42588           in: path
42589           description: Name given to the interface
42590           required: true
42591           type: string
42592           example: __INTERFACE-NAME__
42593         - name: vlan-interface
42594           in: path
42595           description: String that identifies the interface
42596           required: true
42597           type: string
42598           example: __VLAN-INTERFACE__
42599         - name: body
42600           in: body
42601           description: vlan object that needs to be updated.
42602           required: true
42603           schema:
42604             $ref: "#/patchDefinitions/vlan"
42605     delete:
42606       tags:
42607         - Network
42608       summary: delete an existing vlan
42609       description: delete an existing vlan
42610       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42611       consumes:
42612         - application/json
42613         - application/xml
42614       produces:
42615         - application/json
42616         - application/xml
42617       responses:
42618         "default":
42619           description: Response codes found in [response codes](https://wiki.onap.org/).
42620       parameters:
42621         - name: pnf-name
42622           in: path
42623           description: unique name of Physical Network Function.
42624           required: true
42625           type: string
42626           example: __PNF-NAME__
42627         - name: interface-name
42628           in: path
42629           description: Name that identifies the link aggregate interface
42630           required: true
42631           type: string
42632           example: __INTERFACE-NAME__
42633         - name: interface-name
42634           in: path
42635           description: Name given to the interface
42636           required: true
42637           type: string
42638           example: __INTERFACE-NAME__
42639         - name: vlan-interface
42640           in: path
42641           description: String that identifies the interface
42642           required: true
42643           type: string
42644           example: __VLAN-INTERFACE__
42645         - name: resource-version
42646           in: query
42647           description: resource-version for concurrency
42648           required: true
42649           type: string
42650   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
42651     get:
42652       tags:
42653         - Network
42654       summary: returns vlans
42655       description: returns vlans
42656       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
42657       produces:
42658         - application/json
42659         - application/xml
42660       responses:
42661         "200":
42662           description: successful operation
42663           schema:
42664               $ref: "#/getDefinitions/vlans"
42665         "default":
42666           description: Response codes found in [response codes](https://wiki.onap.org/).
42667       parameters:
42668         - name: pnf-name
42669           in: path
42670           description: unique name of Physical Network Function.
42671           required: true
42672           type: string
42673           example: __PNF-NAME__
42674         - name: interface-name
42675           in: path
42676           description: Name that identifies the link aggregate interface
42677           required: true
42678           type: string
42679           example: __INTERFACE-NAME__
42680         - name: interface-name
42681           in: path
42682           description: Name given to the interface
42683           required: true
42684           type: string
42685           example: __INTERFACE-NAME__
42686         - name: vlan-interface
42687           in: query
42688           description:
42689           required: false
42690           type: string
42691         - name: vlan-id-inner
42692           in: query
42693           description:
42694           required: false
42695           type: integer
42696           format: int64
42697         - name: vpn-key
42698           in: query
42699           description:
42700           required: false
42701           type: string
42702   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
42703     put:
42704       tags:
42705         - Network
42706       summary: see node definition for valid relationships
42707       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
42708       consumes:
42709         - application/json
42710         - application/xml
42711       produces:
42712         - application/json
42713         - application/xml
42714       responses:
42715         "default":
42716           description: Response codes found in [response codes](https://wiki.onap.org/).
42717       parameters:
42718         - name: pnf-name
42719           in: path
42720           description: unique name of Physical Network Function.
42721           required: true
42722           type: string
42723           example: __PNF-NAME__
42724         - name: interface-name
42725           in: path
42726           description: Name that identifies the link aggregate interface
42727           required: true
42728           type: string
42729           example: __INTERFACE-NAME__
42730         - name: interface-name
42731           in: path
42732           description: Name given to the interface
42733           required: true
42734           type: string
42735           example: __INTERFACE-NAME__
42736         - name: pci-id
42737           in: path
42738           description: PCI ID used to identify the sriov-vf
42739           required: true
42740           type: string
42741           example: __PCI-ID__
42742         - name: body
42743           in: body
42744           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
42745           required: true
42746           schema:
42747             $ref: "#/definitions/relationship"
42748     delete:
42749       tags:
42750         - Network
42751       summary: delete an existing relationship
42752       description: delete an existing relationship
42753       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
42754       consumes:
42755         - application/json
42756         - application/xml
42757       produces:
42758         - application/json
42759         - application/xml
42760       responses:
42761         "default":
42762           description: Response codes found in [response codes](https://wiki.onap.org/).
42763       parameters:
42764         - name: pnf-name
42765           in: path
42766           description: unique name of Physical Network Function.
42767           required: true
42768           type: string
42769           example: __PNF-NAME__
42770         - name: interface-name
42771           in: path
42772           description: Name that identifies the link aggregate interface
42773           required: true
42774           type: string
42775           example: __INTERFACE-NAME__
42776         - name: interface-name
42777           in: path
42778           description: Name given to the interface
42779           required: true
42780           type: string
42781           example: __INTERFACE-NAME__
42782         - name: pci-id
42783           in: path
42784           description: PCI ID used to identify the sriov-vf
42785           required: true
42786           type: string
42787           example: __PCI-ID__
42788   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
42789     get:
42790       tags:
42791         - Network
42792       summary: returns sriov-vf
42793       description: returns sriov-vf
42794       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
42795       produces:
42796         - application/json
42797         - application/xml
42798       responses:
42799         "200":
42800           description: successful operation
42801           schema:
42802               $ref: "#/getDefinitions/sriov-vf"
42803         "default":
42804           description: Response codes found in [response codes](https://wiki.onap.org/).
42805       parameters:
42806         - name: pnf-name
42807           in: path
42808           description: unique name of Physical Network Function.
42809           required: true
42810           type: string
42811           example: __PNF-NAME__
42812         - name: interface-name
42813           in: path
42814           description: Name that identifies the link aggregate interface
42815           required: true
42816           type: string
42817           example: __INTERFACE-NAME__
42818         - name: interface-name
42819           in: path
42820           description: Name given to the interface
42821           required: true
42822           type: string
42823           example: __INTERFACE-NAME__
42824         - name: pci-id
42825           in: path
42826           description: PCI ID used to identify the sriov-vf
42827           required: true
42828           type: string
42829           example: __PCI-ID__
42830     put:
42831       tags:
42832         - Network
42833       summary: create or update an existing sriov-vf
42834       description: |
42835         Create or update an existing sriov-vf.
42836         #
42837         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42838       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
42839       consumes:
42840         - application/json
42841         - application/xml
42842       produces:
42843         - application/json
42844         - application/xml
42845       responses:
42846         "default":
42847           description: Response codes found in [response codes](https://wiki.onap.org/).
42848       parameters:
42849         - name: pnf-name
42850           in: path
42851           description: unique name of Physical Network Function.
42852           required: true
42853           type: string
42854           example: __PNF-NAME__
42855         - name: interface-name
42856           in: path
42857           description: Name that identifies the link aggregate interface
42858           required: true
42859           type: string
42860           example: __INTERFACE-NAME__
42861         - name: interface-name
42862           in: path
42863           description: Name given to the interface
42864           required: true
42865           type: string
42866           example: __INTERFACE-NAME__
42867         - name: pci-id
42868           in: path
42869           description: PCI ID used to identify the sriov-vf
42870           required: true
42871           type: string
42872           example: __PCI-ID__
42873         - name: body
42874           in: body
42875           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
42876           required: true
42877           schema:
42878             $ref: "#/definitions/sriov-vf"
42879     patch:
42880       tags:
42881         - Network
42882       summary: update an existing sriov-vf
42883       description: |
42884         Update an existing sriov-vf
42885         #
42886         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42887         The PUT operation will entirely replace an existing object.
42888         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42889         #
42890         Other differences between PUT and PATCH are:
42891         #
42892         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42893         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42894         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42895       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
42896       consumes:
42897         - application/json
42898         - application/xml
42899       produces:
42900         - application/json
42901         - application/xml
42902       responses:
42903         "default":
42904           description: Response codes found in [response codes](https://wiki.onap.org/).
42905       parameters:
42906         - name: pnf-name
42907           in: path
42908           description: unique name of Physical Network Function.
42909           required: true
42910           type: string
42911           example: __PNF-NAME__
42912         - name: interface-name
42913           in: path
42914           description: Name that identifies the link aggregate interface
42915           required: true
42916           type: string
42917           example: __INTERFACE-NAME__
42918         - name: interface-name
42919           in: path
42920           description: Name given to the interface
42921           required: true
42922           type: string
42923           example: __INTERFACE-NAME__
42924         - name: pci-id
42925           in: path
42926           description: PCI ID used to identify the sriov-vf
42927           required: true
42928           type: string
42929           example: __PCI-ID__
42930         - name: body
42931           in: body
42932           description: sriov-vf object that needs to be updated.
42933           required: true
42934           schema:
42935             $ref: "#/patchDefinitions/sriov-vf"
42936     delete:
42937       tags:
42938         - Network
42939       summary: delete an existing sriov-vf
42940       description: delete an existing sriov-vf
42941       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
42942       consumes:
42943         - application/json
42944         - application/xml
42945       produces:
42946         - application/json
42947         - application/xml
42948       responses:
42949         "default":
42950           description: Response codes found in [response codes](https://wiki.onap.org/).
42951       parameters:
42952         - name: pnf-name
42953           in: path
42954           description: unique name of Physical Network Function.
42955           required: true
42956           type: string
42957           example: __PNF-NAME__
42958         - name: interface-name
42959           in: path
42960           description: Name that identifies the link aggregate interface
42961           required: true
42962           type: string
42963           example: __INTERFACE-NAME__
42964         - name: interface-name
42965           in: path
42966           description: Name given to the interface
42967           required: true
42968           type: string
42969           example: __INTERFACE-NAME__
42970         - name: pci-id
42971           in: path
42972           description: PCI ID used to identify the sriov-vf
42973           required: true
42974           type: string
42975           example: __PCI-ID__
42976         - name: resource-version
42977           in: query
42978           description: resource-version for concurrency
42979           required: true
42980           type: string
42981   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
42982     get:
42983       tags:
42984         - Network
42985       summary: returns sriov-vfs
42986       description: returns sriov-vfs
42987       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
42988       produces:
42989         - application/json
42990         - application/xml
42991       responses:
42992         "200":
42993           description: successful operation
42994           schema:
42995               $ref: "#/getDefinitions/sriov-vfs"
42996         "default":
42997           description: Response codes found in [response codes](https://wiki.onap.org/).
42998       parameters:
42999         - name: pnf-name
43000           in: path
43001           description: unique name of Physical Network Function.
43002           required: true
43003           type: string
43004           example: __PNF-NAME__
43005         - name: interface-name
43006           in: path
43007           description: Name that identifies the link aggregate interface
43008           required: true
43009           type: string
43010           example: __INTERFACE-NAME__
43011         - name: interface-name
43012           in: path
43013           description: Name given to the interface
43014           required: true
43015           type: string
43016           example: __INTERFACE-NAME__
43017         - name: pci-id
43018           in: query
43019           description:
43020           required: false
43021           type: string
43022         - name: vf-vlan-filter
43023           in: query
43024           description:
43025           required: false
43026           type: string
43027         - name: vf-mac-filter
43028           in: query
43029           description:
43030           required: false
43031           type: string
43032         - name: vf-vlan-strip
43033           in: query
43034           description:
43035           required: false
43036           type: boolean
43037         - name: neutron-network-id
43038           in: query
43039           description:
43040           required: false
43041           type: string
43042   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
43043     put:
43044       tags:
43045         - Network
43046       summary: see node definition for valid relationships
43047       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
43048       consumes:
43049         - application/json
43050         - application/xml
43051       produces:
43052         - application/json
43053         - application/xml
43054       responses:
43055         "default":
43056           description: Response codes found in [response codes](https://wiki.onap.org/).
43057       parameters:
43058         - name: pnf-name
43059           in: path
43060           description: unique name of Physical Network Function.
43061           required: true
43062           type: string
43063           example: __PNF-NAME__
43064         - name: interface-name
43065           in: path
43066           description: Name that identifies the link aggregate interface
43067           required: true
43068           type: string
43069           example: __INTERFACE-NAME__
43070         - name: interface-name
43071           in: path
43072           description: Name given to the interface
43073           required: true
43074           type: string
43075           example: __INTERFACE-NAME__
43076         - name: body
43077           in: body
43078           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
43079           required: true
43080           schema:
43081             $ref: "#/definitions/relationship"
43082     delete:
43083       tags:
43084         - Network
43085       summary: delete an existing relationship
43086       description: delete an existing relationship
43087       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
43088       consumes:
43089         - application/json
43090         - application/xml
43091       produces:
43092         - application/json
43093         - application/xml
43094       responses:
43095         "default":
43096           description: Response codes found in [response codes](https://wiki.onap.org/).
43097       parameters:
43098         - name: pnf-name
43099           in: path
43100           description: unique name of Physical Network Function.
43101           required: true
43102           type: string
43103           example: __PNF-NAME__
43104         - name: interface-name
43105           in: path
43106           description: Name that identifies the link aggregate interface
43107           required: true
43108           type: string
43109           example: __INTERFACE-NAME__
43110         - name: interface-name
43111           in: path
43112           description: Name given to the interface
43113           required: true
43114           type: string
43115           example: __INTERFACE-NAME__
43116   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
43117     put:
43118       tags:
43119         - Network
43120       summary: see node definition for valid relationships
43121       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43122       consumes:
43123         - application/json
43124         - application/xml
43125       produces:
43126         - application/json
43127         - application/xml
43128       responses:
43129         "default":
43130           description: Response codes found in [response codes](https://wiki.onap.org/).
43131       parameters:
43132         - name: pnf-name
43133           in: path
43134           description: unique name of Physical Network Function.
43135           required: true
43136           type: string
43137           example: __PNF-NAME__
43138         - name: interface-name
43139           in: path
43140           description: Name that identifies the link aggregate interface
43141           required: true
43142           type: string
43143           example: __INTERFACE-NAME__
43144         - name: interface-name
43145           in: path
43146           description: Name given to the interface
43147           required: true
43148           type: string
43149           example: __INTERFACE-NAME__
43150         - name: l3-interface-ipv4-address
43151           in: path
43152           description: IP address
43153           required: true
43154           type: string
43155           example: __L3-INTERFACE-IPV4-ADDRESS__
43156         - name: body
43157           in: body
43158           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
43159           required: true
43160           schema:
43161             $ref: "#/definitions/relationship"
43162     delete:
43163       tags:
43164         - Network
43165       summary: delete an existing relationship
43166       description: delete an existing relationship
43167       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43168       consumes:
43169         - application/json
43170         - application/xml
43171       produces:
43172         - application/json
43173         - application/xml
43174       responses:
43175         "default":
43176           description: Response codes found in [response codes](https://wiki.onap.org/).
43177       parameters:
43178         - name: pnf-name
43179           in: path
43180           description: unique name of Physical Network Function.
43181           required: true
43182           type: string
43183           example: __PNF-NAME__
43184         - name: interface-name
43185           in: path
43186           description: Name that identifies the link aggregate interface
43187           required: true
43188           type: string
43189           example: __INTERFACE-NAME__
43190         - name: interface-name
43191           in: path
43192           description: Name given to the interface
43193           required: true
43194           type: string
43195           example: __INTERFACE-NAME__
43196         - name: l3-interface-ipv4-address
43197           in: path
43198           description: IP address
43199           required: true
43200           type: string
43201           example: __L3-INTERFACE-IPV4-ADDRESS__
43202   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
43203     get:
43204       tags:
43205         - Network
43206       summary: returns l3-interface-ipv4-address-list
43207       description: returns l3-interface-ipv4-address-list
43208       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43209       produces:
43210         - application/json
43211         - application/xml
43212       responses:
43213         "200":
43214           description: successful operation
43215           schema:
43216               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
43217         "default":
43218           description: Response codes found in [response codes](https://wiki.onap.org/).
43219       parameters:
43220         - name: pnf-name
43221           in: path
43222           description: unique name of Physical Network Function.
43223           required: true
43224           type: string
43225           example: __PNF-NAME__
43226         - name: interface-name
43227           in: path
43228           description: Name that identifies the link aggregate interface
43229           required: true
43230           type: string
43231           example: __INTERFACE-NAME__
43232         - name: interface-name
43233           in: path
43234           description: Name given to the interface
43235           required: true
43236           type: string
43237           example: __INTERFACE-NAME__
43238         - name: l3-interface-ipv4-address
43239           in: path
43240           description: IP address
43241           required: true
43242           type: string
43243           example: __L3-INTERFACE-IPV4-ADDRESS__
43244     put:
43245       tags:
43246         - Network
43247       summary: create or update an existing l3-interface-ipv4-address-list
43248       description: |
43249         Create or update an existing l3-interface-ipv4-address-list.
43250         #
43251         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43252       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43253       consumes:
43254         - application/json
43255         - application/xml
43256       produces:
43257         - application/json
43258         - application/xml
43259       responses:
43260         "default":
43261           description: Response codes found in [response codes](https://wiki.onap.org/).
43262       parameters:
43263         - name: pnf-name
43264           in: path
43265           description: unique name of Physical Network Function.
43266           required: true
43267           type: string
43268           example: __PNF-NAME__
43269         - name: interface-name
43270           in: path
43271           description: Name that identifies the link aggregate interface
43272           required: true
43273           type: string
43274           example: __INTERFACE-NAME__
43275         - name: interface-name
43276           in: path
43277           description: Name given to the interface
43278           required: true
43279           type: string
43280           example: __INTERFACE-NAME__
43281         - name: l3-interface-ipv4-address
43282           in: path
43283           description: IP address
43284           required: true
43285           type: string
43286           example: __L3-INTERFACE-IPV4-ADDRESS__
43287         - name: body
43288           in: body
43289           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
43290           required: true
43291           schema:
43292             $ref: "#/definitions/l3-interface-ipv4-address-list"
43293     patch:
43294       tags:
43295         - Network
43296       summary: update an existing l3-interface-ipv4-address-list
43297       description: |
43298         Update an existing l3-interface-ipv4-address-list
43299         #
43300         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43301         The PUT operation will entirely replace an existing object.
43302         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43303         #
43304         Other differences between PUT and PATCH are:
43305         #
43306         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43307         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43308         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43309       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43310       consumes:
43311         - application/json
43312         - application/xml
43313       produces:
43314         - application/json
43315         - application/xml
43316       responses:
43317         "default":
43318           description: Response codes found in [response codes](https://wiki.onap.org/).
43319       parameters:
43320         - name: pnf-name
43321           in: path
43322           description: unique name of Physical Network Function.
43323           required: true
43324           type: string
43325           example: __PNF-NAME__
43326         - name: interface-name
43327           in: path
43328           description: Name that identifies the link aggregate interface
43329           required: true
43330           type: string
43331           example: __INTERFACE-NAME__
43332         - name: interface-name
43333           in: path
43334           description: Name given to the interface
43335           required: true
43336           type: string
43337           example: __INTERFACE-NAME__
43338         - name: l3-interface-ipv4-address
43339           in: path
43340           description: IP address
43341           required: true
43342           type: string
43343           example: __L3-INTERFACE-IPV4-ADDRESS__
43344         - name: body
43345           in: body
43346           description: l3-interface-ipv4-address-list object that needs to be updated.
43347           required: true
43348           schema:
43349             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
43350     delete:
43351       tags:
43352         - Network
43353       summary: delete an existing l3-interface-ipv4-address-list
43354       description: delete an existing l3-interface-ipv4-address-list
43355       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43356       consumes:
43357         - application/json
43358         - application/xml
43359       produces:
43360         - application/json
43361         - application/xml
43362       responses:
43363         "default":
43364           description: Response codes found in [response codes](https://wiki.onap.org/).
43365       parameters:
43366         - name: pnf-name
43367           in: path
43368           description: unique name of Physical Network Function.
43369           required: true
43370           type: string
43371           example: __PNF-NAME__
43372         - name: interface-name
43373           in: path
43374           description: Name that identifies the link aggregate interface
43375           required: true
43376           type: string
43377           example: __INTERFACE-NAME__
43378         - name: interface-name
43379           in: path
43380           description: Name given to the interface
43381           required: true
43382           type: string
43383           example: __INTERFACE-NAME__
43384         - name: l3-interface-ipv4-address
43385           in: path
43386           description: IP address
43387           required: true
43388           type: string
43389           example: __L3-INTERFACE-IPV4-ADDRESS__
43390         - name: resource-version
43391           in: query
43392           description: resource-version for concurrency
43393           required: true
43394           type: string
43395   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
43396     put:
43397       tags:
43398         - Network
43399       summary: see node definition for valid relationships
43400       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
43401       consumes:
43402         - application/json
43403         - application/xml
43404       produces:
43405         - application/json
43406         - application/xml
43407       responses:
43408         "default":
43409           description: Response codes found in [response codes](https://wiki.onap.org/).
43410       parameters:
43411         - name: pnf-name
43412           in: path
43413           description: unique name of Physical Network Function.
43414           required: true
43415           type: string
43416           example: __PNF-NAME__
43417         - name: interface-name
43418           in: path
43419           description: Name that identifies the link aggregate interface
43420           required: true
43421           type: string
43422           example: __INTERFACE-NAME__
43423         - name: interface-name
43424           in: path
43425           description: Name given to the interface
43426           required: true
43427           type: string
43428           example: __INTERFACE-NAME__
43429         - name: l3-interface-ipv6-address
43430           in: path
43431           description: IP address
43432           required: true
43433           type: string
43434           example: __L3-INTERFACE-IPV6-ADDRESS__
43435         - name: body
43436           in: body
43437           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
43438           required: true
43439           schema:
43440             $ref: "#/definitions/relationship"
43441     delete:
43442       tags:
43443         - Network
43444       summary: delete an existing relationship
43445       description: delete an existing relationship
43446       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
43447       consumes:
43448         - application/json
43449         - application/xml
43450       produces:
43451         - application/json
43452         - application/xml
43453       responses:
43454         "default":
43455           description: Response codes found in [response codes](https://wiki.onap.org/).
43456       parameters:
43457         - name: pnf-name
43458           in: path
43459           description: unique name of Physical Network Function.
43460           required: true
43461           type: string
43462           example: __PNF-NAME__
43463         - name: interface-name
43464           in: path
43465           description: Name that identifies the link aggregate interface
43466           required: true
43467           type: string
43468           example: __INTERFACE-NAME__
43469         - name: interface-name
43470           in: path
43471           description: Name given to the interface
43472           required: true
43473           type: string
43474           example: __INTERFACE-NAME__
43475         - name: l3-interface-ipv6-address
43476           in: path
43477           description: IP address
43478           required: true
43479           type: string
43480           example: __L3-INTERFACE-IPV6-ADDRESS__
43481   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
43482     get:
43483       tags:
43484         - Network
43485       summary: returns l3-interface-ipv6-address-list
43486       description: returns l3-interface-ipv6-address-list
43487       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43488       produces:
43489         - application/json
43490         - application/xml
43491       responses:
43492         "200":
43493           description: successful operation
43494           schema:
43495               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
43496         "default":
43497           description: Response codes found in [response codes](https://wiki.onap.org/).
43498       parameters:
43499         - name: pnf-name
43500           in: path
43501           description: unique name of Physical Network Function.
43502           required: true
43503           type: string
43504           example: __PNF-NAME__
43505         - name: interface-name
43506           in: path
43507           description: Name that identifies the link aggregate interface
43508           required: true
43509           type: string
43510           example: __INTERFACE-NAME__
43511         - name: interface-name
43512           in: path
43513           description: Name given to the interface
43514           required: true
43515           type: string
43516           example: __INTERFACE-NAME__
43517         - name: l3-interface-ipv6-address
43518           in: path
43519           description: IP address
43520           required: true
43521           type: string
43522           example: __L3-INTERFACE-IPV6-ADDRESS__
43523     put:
43524       tags:
43525         - Network
43526       summary: create or update an existing l3-interface-ipv6-address-list
43527       description: |
43528         Create or update an existing l3-interface-ipv6-address-list.
43529         #
43530         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43531       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43532       consumes:
43533         - application/json
43534         - application/xml
43535       produces:
43536         - application/json
43537         - application/xml
43538       responses:
43539         "default":
43540           description: Response codes found in [response codes](https://wiki.onap.org/).
43541       parameters:
43542         - name: pnf-name
43543           in: path
43544           description: unique name of Physical Network Function.
43545           required: true
43546           type: string
43547           example: __PNF-NAME__
43548         - name: interface-name
43549           in: path
43550           description: Name that identifies the link aggregate interface
43551           required: true
43552           type: string
43553           example: __INTERFACE-NAME__
43554         - name: interface-name
43555           in: path
43556           description: Name given to the interface
43557           required: true
43558           type: string
43559           example: __INTERFACE-NAME__
43560         - name: l3-interface-ipv6-address
43561           in: path
43562           description: IP address
43563           required: true
43564           type: string
43565           example: __L3-INTERFACE-IPV6-ADDRESS__
43566         - name: body
43567           in: body
43568           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
43569           required: true
43570           schema:
43571             $ref: "#/definitions/l3-interface-ipv6-address-list"
43572     patch:
43573       tags:
43574         - Network
43575       summary: update an existing l3-interface-ipv6-address-list
43576       description: |
43577         Update an existing l3-interface-ipv6-address-list
43578         #
43579         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43580         The PUT operation will entirely replace an existing object.
43581         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43582         #
43583         Other differences between PUT and PATCH are:
43584         #
43585         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43586         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43587         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43588       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43589       consumes:
43590         - application/json
43591         - application/xml
43592       produces:
43593         - application/json
43594         - application/xml
43595       responses:
43596         "default":
43597           description: Response codes found in [response codes](https://wiki.onap.org/).
43598       parameters:
43599         - name: pnf-name
43600           in: path
43601           description: unique name of Physical Network Function.
43602           required: true
43603           type: string
43604           example: __PNF-NAME__
43605         - name: interface-name
43606           in: path
43607           description: Name that identifies the link aggregate interface
43608           required: true
43609           type: string
43610           example: __INTERFACE-NAME__
43611         - name: interface-name
43612           in: path
43613           description: Name given to the interface
43614           required: true
43615           type: string
43616           example: __INTERFACE-NAME__
43617         - name: l3-interface-ipv6-address
43618           in: path
43619           description: IP address
43620           required: true
43621           type: string
43622           example: __L3-INTERFACE-IPV6-ADDRESS__
43623         - name: body
43624           in: body
43625           description: l3-interface-ipv6-address-list object that needs to be updated.
43626           required: true
43627           schema:
43628             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
43629     delete:
43630       tags:
43631         - Network
43632       summary: delete an existing l3-interface-ipv6-address-list
43633       description: delete an existing l3-interface-ipv6-address-list
43634       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43635       consumes:
43636         - application/json
43637         - application/xml
43638       produces:
43639         - application/json
43640         - application/xml
43641       responses:
43642         "default":
43643           description: Response codes found in [response codes](https://wiki.onap.org/).
43644       parameters:
43645         - name: pnf-name
43646           in: path
43647           description: unique name of Physical Network Function.
43648           required: true
43649           type: string
43650           example: __PNF-NAME__
43651         - name: interface-name
43652           in: path
43653           description: Name that identifies the link aggregate interface
43654           required: true
43655           type: string
43656           example: __INTERFACE-NAME__
43657         - name: interface-name
43658           in: path
43659           description: Name given to the interface
43660           required: true
43661           type: string
43662           example: __INTERFACE-NAME__
43663         - name: l3-interface-ipv6-address
43664           in: path
43665           description: IP address
43666           required: true
43667           type: string
43668           example: __L3-INTERFACE-IPV6-ADDRESS__
43669         - name: resource-version
43670           in: query
43671           description: resource-version for concurrency
43672           required: true
43673           type: string
43674   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
43675     get:
43676       tags:
43677         - Network
43678       summary: returns l-interface
43679       description: returns l-interface
43680       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
43681       produces:
43682         - application/json
43683         - application/xml
43684       responses:
43685         "200":
43686           description: successful operation
43687           schema:
43688               $ref: "#/getDefinitions/l-interface"
43689         "default":
43690           description: Response codes found in [response codes](https://wiki.onap.org/).
43691       parameters:
43692         - name: pnf-name
43693           in: path
43694           description: unique name of Physical Network Function.
43695           required: true
43696           type: string
43697           example: __PNF-NAME__
43698         - name: interface-name
43699           in: path
43700           description: Name that identifies the link aggregate interface
43701           required: true
43702           type: string
43703           example: __INTERFACE-NAME__
43704         - name: interface-name
43705           in: path
43706           description: Name given to the interface
43707           required: true
43708           type: string
43709           example: __INTERFACE-NAME__
43710     put:
43711       tags:
43712         - Network
43713       summary: create or update an existing l-interface
43714       description: |
43715         Create or update an existing l-interface.
43716         #
43717         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43718       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
43719       consumes:
43720         - application/json
43721         - application/xml
43722       produces:
43723         - application/json
43724         - application/xml
43725       responses:
43726         "default":
43727           description: Response codes found in [response codes](https://wiki.onap.org/).
43728       parameters:
43729         - name: pnf-name
43730           in: path
43731           description: unique name of Physical Network Function.
43732           required: true
43733           type: string
43734           example: __PNF-NAME__
43735         - name: interface-name
43736           in: path
43737           description: Name that identifies the link aggregate interface
43738           required: true
43739           type: string
43740           example: __INTERFACE-NAME__
43741         - name: interface-name
43742           in: path
43743           description: Name given to the interface
43744           required: true
43745           type: string
43746           example: __INTERFACE-NAME__
43747         - name: body
43748           in: body
43749           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
43750           required: true
43751           schema:
43752             $ref: "#/definitions/l-interface"
43753     patch:
43754       tags:
43755         - Network
43756       summary: update an existing l-interface
43757       description: |
43758         Update an existing l-interface
43759         #
43760         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43761         The PUT operation will entirely replace an existing object.
43762         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43763         #
43764         Other differences between PUT and PATCH are:
43765         #
43766         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43767         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43768         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43769       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
43770       consumes:
43771         - application/json
43772         - application/xml
43773       produces:
43774         - application/json
43775         - application/xml
43776       responses:
43777         "default":
43778           description: Response codes found in [response codes](https://wiki.onap.org/).
43779       parameters:
43780         - name: pnf-name
43781           in: path
43782           description: unique name of Physical Network Function.
43783           required: true
43784           type: string
43785           example: __PNF-NAME__
43786         - name: interface-name
43787           in: path
43788           description: Name that identifies the link aggregate interface
43789           required: true
43790           type: string
43791           example: __INTERFACE-NAME__
43792         - name: interface-name
43793           in: path
43794           description: Name given to the interface
43795           required: true
43796           type: string
43797           example: __INTERFACE-NAME__
43798         - name: body
43799           in: body
43800           description: l-interface object that needs to be updated.
43801           required: true
43802           schema:
43803             $ref: "#/patchDefinitions/l-interface"
43804     delete:
43805       tags:
43806         - Network
43807       summary: delete an existing l-interface
43808       description: delete an existing l-interface
43809       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
43810       consumes:
43811         - application/json
43812         - application/xml
43813       produces:
43814         - application/json
43815         - application/xml
43816       responses:
43817         "default":
43818           description: Response codes found in [response codes](https://wiki.onap.org/).
43819       parameters:
43820         - name: pnf-name
43821           in: path
43822           description: unique name of Physical Network Function.
43823           required: true
43824           type: string
43825           example: __PNF-NAME__
43826         - name: interface-name
43827           in: path
43828           description: Name that identifies the link aggregate interface
43829           required: true
43830           type: string
43831           example: __INTERFACE-NAME__
43832         - name: interface-name
43833           in: path
43834           description: Name given to the interface
43835           required: true
43836           type: string
43837           example: __INTERFACE-NAME__
43838         - name: resource-version
43839           in: query
43840           description: resource-version for concurrency
43841           required: true
43842           type: string
43843   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
43844     get:
43845       tags:
43846         - Network
43847       summary: returns l-interfaces
43848       description: returns l-interfaces
43849       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
43850       produces:
43851         - application/json
43852         - application/xml
43853       responses:
43854         "200":
43855           description: successful operation
43856           schema:
43857               $ref: "#/getDefinitions/l-interfaces"
43858         "default":
43859           description: Response codes found in [response codes](https://wiki.onap.org/).
43860       parameters:
43861         - name: pnf-name
43862           in: path
43863           description: unique name of Physical Network Function.
43864           required: true
43865           type: string
43866           example: __PNF-NAME__
43867         - name: interface-name
43868           in: path
43869           description: Name that identifies the link aggregate interface
43870           required: true
43871           type: string
43872           example: __INTERFACE-NAME__
43873         - name: interface-name
43874           in: query
43875           description:
43876           required: false
43877           type: string
43878         - name: interface-id
43879           in: query
43880           description:
43881           required: false
43882           type: string
43883         - name: macaddr
43884           in: query
43885           description:
43886           required: false
43887           type: string
43888         - name: network-name
43889           in: query
43890           description:
43891           required: false
43892           type: string
43893   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
43894     get:
43895       tags:
43896         - Network
43897       summary: returns lag-interface
43898       description: returns lag-interface
43899       operationId: getNetworkPnfsPnfLagInterfacesLagInterface
43900       produces:
43901         - application/json
43902         - application/xml
43903       responses:
43904         "200":
43905           description: successful operation
43906           schema:
43907               $ref: "#/getDefinitions/lag-interface"
43908         "default":
43909           description: Response codes found in [response codes](https://wiki.onap.org/).
43910       parameters:
43911         - name: pnf-name
43912           in: path
43913           description: unique name of Physical Network Function.
43914           required: true
43915           type: string
43916           example: __PNF-NAME__
43917         - name: interface-name
43918           in: path
43919           description: Name that identifies the link aggregate interface
43920           required: true
43921           type: string
43922           example: __INTERFACE-NAME__
43923     put:
43924       tags:
43925         - Network
43926       summary: create or update an existing lag-interface
43927       description: |
43928         Create or update an existing lag-interface.
43929         #
43930         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43931       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
43932       consumes:
43933         - application/json
43934         - application/xml
43935       produces:
43936         - application/json
43937         - application/xml
43938       responses:
43939         "default":
43940           description: Response codes found in [response codes](https://wiki.onap.org/).
43941       parameters:
43942         - name: pnf-name
43943           in: path
43944           description: unique name of Physical Network Function.
43945           required: true
43946           type: string
43947           example: __PNF-NAME__
43948         - name: interface-name
43949           in: path
43950           description: Name that identifies the link aggregate interface
43951           required: true
43952           type: string
43953           example: __INTERFACE-NAME__
43954         - name: body
43955           in: body
43956           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json)
43957           required: true
43958           schema:
43959             $ref: "#/definitions/lag-interface"
43960     patch:
43961       tags:
43962         - Network
43963       summary: update an existing lag-interface
43964       description: |
43965         Update an existing lag-interface
43966         #
43967         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43968         The PUT operation will entirely replace an existing object.
43969         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43970         #
43971         Other differences between PUT and PATCH are:
43972         #
43973         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43974         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43975         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43976       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
43977       consumes:
43978         - application/json
43979         - application/xml
43980       produces:
43981         - application/json
43982         - application/xml
43983       responses:
43984         "default":
43985           description: Response codes found in [response codes](https://wiki.onap.org/).
43986       parameters:
43987         - name: pnf-name
43988           in: path
43989           description: unique name of Physical Network Function.
43990           required: true
43991           type: string
43992           example: __PNF-NAME__
43993         - name: interface-name
43994           in: path
43995           description: Name that identifies the link aggregate interface
43996           required: true
43997           type: string
43998           example: __INTERFACE-NAME__
43999         - name: body
44000           in: body
44001           description: lag-interface object that needs to be updated.
44002           required: true
44003           schema:
44004             $ref: "#/patchDefinitions/lag-interface"
44005     delete:
44006       tags:
44007         - Network
44008       summary: delete an existing lag-interface
44009       description: delete an existing lag-interface
44010       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
44011       consumes:
44012         - application/json
44013         - application/xml
44014       produces:
44015         - application/json
44016         - application/xml
44017       responses:
44018         "default":
44019           description: Response codes found in [response codes](https://wiki.onap.org/).
44020       parameters:
44021         - name: pnf-name
44022           in: path
44023           description: unique name of Physical Network Function.
44024           required: true
44025           type: string
44026           example: __PNF-NAME__
44027         - name: interface-name
44028           in: path
44029           description: Name that identifies the link aggregate interface
44030           required: true
44031           type: string
44032           example: __INTERFACE-NAME__
44033         - name: resource-version
44034           in: query
44035           description: resource-version for concurrency
44036           required: true
44037           type: string
44038   /network/pnfs/pnf/{pnf-name}/lag-interfaces:
44039     get:
44040       tags:
44041         - Network
44042       summary: returns lag-interfaces
44043       description: returns lag-interfaces
44044       operationId: getNetworkPnfsPnfLagInterfaces
44045       produces:
44046         - application/json
44047         - application/xml
44048       responses:
44049         "200":
44050           description: successful operation
44051           schema:
44052               $ref: "#/getDefinitions/lag-interfaces"
44053         "default":
44054           description: Response codes found in [response codes](https://wiki.onap.org/).
44055       parameters:
44056         - name: pnf-name
44057           in: path
44058           description: unique name of Physical Network Function.
44059           required: true
44060           type: string
44061           example: __PNF-NAME__
44062         - name: interface-name
44063           in: query
44064           description:
44065           required: false
44066           type: string
44067         - name: interface-id
44068           in: query
44069           description:
44070           required: false
44071           type: string
44072         - name: interface-role
44073           in: query
44074           description:
44075           required: false
44076           type: string
44077   /network/pnfs/pnf/{pnf-name}:
44078     get:
44079       tags:
44080         - Network
44081       summary: returns pnf
44082       description: returns pnf
44083       operationId: getNetworkPnfsPnf
44084       produces:
44085         - application/json
44086         - application/xml
44087       responses:
44088         "200":
44089           description: successful operation
44090           schema:
44091               $ref: "#/getDefinitions/pnf"
44092         "default":
44093           description: Response codes found in [response codes](https://wiki.onap.org/).
44094       parameters:
44095         - name: pnf-name
44096           in: path
44097           description: unique name of Physical Network Function.
44098           required: true
44099           type: string
44100           example: __PNF-NAME__
44101     put:
44102       tags:
44103         - Network
44104       summary: create or update an existing pnf
44105       description: |
44106         Create or update an existing pnf.
44107         #
44108         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44109       operationId: createOrUpdateNetworkPnfsPnf
44110       consumes:
44111         - application/json
44112         - application/xml
44113       produces:
44114         - application/json
44115         - application/xml
44116       responses:
44117         "default":
44118           description: Response codes found in [response codes](https://wiki.onap.org/).
44119       parameters:
44120         - name: pnf-name
44121           in: path
44122           description: unique name of Physical Network Function.
44123           required: true
44124           type: string
44125           example: __PNF-NAME__
44126         - name: body
44127           in: body
44128           description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json)
44129           required: true
44130           schema:
44131             $ref: "#/definitions/pnf"
44132     patch:
44133       tags:
44134         - Network
44135       summary: update an existing pnf
44136       description: |
44137         Update an existing pnf
44138         #
44139         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44140         The PUT operation will entirely replace an existing object.
44141         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44142         #
44143         Other differences between PUT and PATCH are:
44144         #
44145         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44146         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44147         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44148       operationId: UpdateNetworkPnfsPnf
44149       consumes:
44150         - application/json
44151         - application/xml
44152       produces:
44153         - application/json
44154         - application/xml
44155       responses:
44156         "default":
44157           description: Response codes found in [response codes](https://wiki.onap.org/).
44158       parameters:
44159         - name: pnf-name
44160           in: path
44161           description: unique name of Physical Network Function.
44162           required: true
44163           type: string
44164           example: __PNF-NAME__
44165         - name: body
44166           in: body
44167           description: pnf object that needs to be updated.
44168           required: true
44169           schema:
44170             $ref: "#/patchDefinitions/pnf"
44171     delete:
44172       tags:
44173         - Network
44174       summary: delete an existing pnf
44175       description: delete an existing pnf
44176       operationId: deleteNetworkPnfsPnf
44177       consumes:
44178         - application/json
44179         - application/xml
44180       produces:
44181         - application/json
44182         - application/xml
44183       responses:
44184         "default":
44185           description: Response codes found in [response codes](https://wiki.onap.org/).
44186       parameters:
44187         - name: pnf-name
44188           in: path
44189           description: unique name of Physical Network Function.
44190           required: true
44191           type: string
44192           example: __PNF-NAME__
44193         - name: resource-version
44194           in: query
44195           description: resource-version for concurrency
44196           required: true
44197           type: string
44198   /network/pnfs:
44199     get:
44200       tags:
44201         - Network
44202       summary: returns pnfs
44203       description: returns pnfs
44204       operationId: getNetworkPnfs
44205       produces:
44206         - application/json
44207         - application/xml
44208       responses:
44209         "200":
44210           description: successful operation
44211           schema:
44212               $ref: "#/getDefinitions/pnfs"
44213         "default":
44214           description: Response codes found in [response codes](https://wiki.onap.org/).
44215       parameters:
44216         - name: pnf-name
44217           in: query
44218           description:
44219           required: false
44220           type: string
44221         - name: inv-status
44222           in: query
44223           description:
44224           required: false
44225           type: string
44226   /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
44227     put:
44228       tags:
44229         - Network
44230       summary: see node definition for valid relationships
44231       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
44232       consumes:
44233         - application/json
44234         - application/xml
44235       produces:
44236         - application/json
44237         - application/xml
44238       responses:
44239         "default":
44240           description: Response codes found in [response codes](https://wiki.onap.org/).
44241       parameters:
44242         - name: link-name
44243           in: path
44244           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44245           required: true
44246           type: string
44247           example: __LINK-NAME__
44248         - name: body
44249           in: body
44250           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPhysicalLinksPhysicalLink.json)
44251           required: true
44252           schema:
44253             $ref: "#/definitions/relationship"
44254     delete:
44255       tags:
44256         - Network
44257       summary: delete an existing relationship
44258       description: delete an existing relationship
44259       operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
44260       consumes:
44261         - application/json
44262         - application/xml
44263       produces:
44264         - application/json
44265         - application/xml
44266       responses:
44267         "default":
44268           description: Response codes found in [response codes](https://wiki.onap.org/).
44269       parameters:
44270         - name: link-name
44271           in: path
44272           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44273           required: true
44274           type: string
44275           example: __LINK-NAME__
44276   /network/physical-links/physical-link/{link-name}:
44277     get:
44278       tags:
44279         - Network
44280       summary: returns physical-link
44281       description: returns physical-link
44282       operationId: getNetworkPhysicalLinksPhysicalLink
44283       produces:
44284         - application/json
44285         - application/xml
44286       responses:
44287         "200":
44288           description: successful operation
44289           schema:
44290               $ref: "#/getDefinitions/physical-link"
44291         "default":
44292           description: Response codes found in [response codes](https://wiki.onap.org/).
44293       parameters:
44294         - name: link-name
44295           in: path
44296           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44297           required: true
44298           type: string
44299           example: __LINK-NAME__
44300     put:
44301       tags:
44302         - Network
44303       summary: create or update an existing physical-link
44304       description: |
44305         Create or update an existing physical-link.
44306         #
44307         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44308       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
44309       consumes:
44310         - application/json
44311         - application/xml
44312       produces:
44313         - application/json
44314         - application/xml
44315       responses:
44316         "default":
44317           description: Response codes found in [response codes](https://wiki.onap.org/).
44318       parameters:
44319         - name: link-name
44320           in: path
44321           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44322           required: true
44323           type: string
44324           example: __LINK-NAME__
44325         - name: body
44326           in: body
44327           description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPhysicalLinksPhysicalLink.json)
44328           required: true
44329           schema:
44330             $ref: "#/definitions/physical-link"
44331     patch:
44332       tags:
44333         - Network
44334       summary: update an existing physical-link
44335       description: |
44336         Update an existing physical-link
44337         #
44338         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44339         The PUT operation will entirely replace an existing object.
44340         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44341         #
44342         Other differences between PUT and PATCH are:
44343         #
44344         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44345         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44346         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44347       operationId: UpdateNetworkPhysicalLinksPhysicalLink
44348       consumes:
44349         - application/json
44350         - application/xml
44351       produces:
44352         - application/json
44353         - application/xml
44354       responses:
44355         "default":
44356           description: Response codes found in [response codes](https://wiki.onap.org/).
44357       parameters:
44358         - name: link-name
44359           in: path
44360           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44361           required: true
44362           type: string
44363           example: __LINK-NAME__
44364         - name: body
44365           in: body
44366           description: physical-link object that needs to be updated.
44367           required: true
44368           schema:
44369             $ref: "#/patchDefinitions/physical-link"
44370     delete:
44371       tags:
44372         - Network
44373       summary: delete an existing physical-link
44374       description: delete an existing physical-link
44375       operationId: deleteNetworkPhysicalLinksPhysicalLink
44376       consumes:
44377         - application/json
44378         - application/xml
44379       produces:
44380         - application/json
44381         - application/xml
44382       responses:
44383         "default":
44384           description: Response codes found in [response codes](https://wiki.onap.org/).
44385       parameters:
44386         - name: link-name
44387           in: path
44388           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44389           required: true
44390           type: string
44391           example: __LINK-NAME__
44392         - name: resource-version
44393           in: query
44394           description: resource-version for concurrency
44395           required: true
44396           type: string
44397   /network/physical-links:
44398     get:
44399       tags:
44400         - Network
44401       summary: returns physical-links
44402       description: returns physical-links
44403       operationId: getNetworkPhysicalLinks
44404       produces:
44405         - application/json
44406         - application/xml
44407       responses:
44408         "200":
44409           description: successful operation
44410           schema:
44411               $ref: "#/getDefinitions/physical-links"
44412         "default":
44413           description: Response codes found in [response codes](https://wiki.onap.org/).
44414       parameters:
44415         - name: link-name
44416           in: query
44417           description:
44418           required: false
44419           type: string
44420         - name: circuit-id
44421           in: query
44422           description:
44423           required: false
44424           type: string
44425   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
44426     put:
44427       tags:
44428         - Network
44429       summary: see node definition for valid relationships
44430       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
44431       consumes:
44432         - application/json
44433         - application/xml
44434       produces:
44435         - application/json
44436         - application/xml
44437       responses:
44438         "default":
44439           description: Response codes found in [response codes](https://wiki.onap.org/).
44440       parameters:
44441         - name: ipsec-configuration-id
44442           in: path
44443           description: UUID of this configuration
44444           required: true
44445           type: string
44446           example: __IPSEC-CONFIGURATION-ID__
44447         - name: body
44448           in: body
44449           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json)
44450           required: true
44451           schema:
44452             $ref: "#/definitions/relationship"
44453     delete:
44454       tags:
44455         - Network
44456       summary: delete an existing relationship
44457       description: delete an existing relationship
44458       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
44459       consumes:
44460         - application/json
44461         - application/xml
44462       produces:
44463         - application/json
44464         - application/xml
44465       responses:
44466         "default":
44467           description: Response codes found in [response codes](https://wiki.onap.org/).
44468       parameters:
44469         - name: ipsec-configuration-id
44470           in: path
44471           description: UUID of this configuration
44472           required: true
44473           type: string
44474           example: __IPSEC-CONFIGURATION-ID__
44475   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
44476     put:
44477       tags:
44478         - Network
44479       summary: see node definition for valid relationships
44480       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
44481       consumes:
44482         - application/json
44483         - application/xml
44484       produces:
44485         - application/json
44486         - application/xml
44487       responses:
44488         "default":
44489           description: Response codes found in [response codes](https://wiki.onap.org/).
44490       parameters:
44491         - name: ipsec-configuration-id
44492           in: path
44493           description: UUID of this configuration
44494           required: true
44495           type: string
44496           example: __IPSEC-CONFIGURATION-ID__
44497         - name: vig-address-type
44498           in: path
44499           description: indicates whether the VIG is for AVPN or INTERNET
44500           required: true
44501           type: string
44502           example: __VIG-ADDRESS-TYPE__
44503         - name: body
44504           in: body
44505           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
44506           required: true
44507           schema:
44508             $ref: "#/definitions/relationship"
44509     delete:
44510       tags:
44511         - Network
44512       summary: delete an existing relationship
44513       description: delete an existing relationship
44514       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
44515       consumes:
44516         - application/json
44517         - application/xml
44518       produces:
44519         - application/json
44520         - application/xml
44521       responses:
44522         "default":
44523           description: Response codes found in [response codes](https://wiki.onap.org/).
44524       parameters:
44525         - name: ipsec-configuration-id
44526           in: path
44527           description: UUID of this configuration
44528           required: true
44529           type: string
44530           example: __IPSEC-CONFIGURATION-ID__
44531         - name: vig-address-type
44532           in: path
44533           description: indicates whether the VIG is for AVPN or INTERNET
44534           required: true
44535           type: string
44536           example: __VIG-ADDRESS-TYPE__
44537   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
44538     get:
44539       tags:
44540         - Network
44541       summary: returns vig-server
44542       description: returns vig-server
44543       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44544       produces:
44545         - application/json
44546         - application/xml
44547       responses:
44548         "200":
44549           description: successful operation
44550           schema:
44551               $ref: "#/getDefinitions/vig-server"
44552         "default":
44553           description: Response codes found in [response codes](https://wiki.onap.org/).
44554       parameters:
44555         - name: ipsec-configuration-id
44556           in: path
44557           description: UUID of this configuration
44558           required: true
44559           type: string
44560           example: __IPSEC-CONFIGURATION-ID__
44561         - name: vig-address-type
44562           in: path
44563           description: indicates whether the VIG is for AVPN or INTERNET
44564           required: true
44565           type: string
44566           example: __VIG-ADDRESS-TYPE__
44567     put:
44568       tags:
44569         - Network
44570       summary: create or update an existing vig-server
44571       description: |
44572         Create or update an existing vig-server.
44573         #
44574         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44575       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44576       consumes:
44577         - application/json
44578         - application/xml
44579       produces:
44580         - application/json
44581         - application/xml
44582       responses:
44583         "default":
44584           description: Response codes found in [response codes](https://wiki.onap.org/).
44585       parameters:
44586         - name: ipsec-configuration-id
44587           in: path
44588           description: UUID of this configuration
44589           required: true
44590           type: string
44591           example: __IPSEC-CONFIGURATION-ID__
44592         - name: vig-address-type
44593           in: path
44594           description: indicates whether the VIG is for AVPN or INTERNET
44595           required: true
44596           type: string
44597           example: __VIG-ADDRESS-TYPE__
44598         - name: body
44599           in: body
44600           description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
44601           required: true
44602           schema:
44603             $ref: "#/definitions/vig-server"
44604     patch:
44605       tags:
44606         - Network
44607       summary: update an existing vig-server
44608       description: |
44609         Update an existing vig-server
44610         #
44611         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44612         The PUT operation will entirely replace an existing object.
44613         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44614         #
44615         Other differences between PUT and PATCH are:
44616         #
44617         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44618         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44619         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44620       operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44621       consumes:
44622         - application/json
44623         - application/xml
44624       produces:
44625         - application/json
44626         - application/xml
44627       responses:
44628         "default":
44629           description: Response codes found in [response codes](https://wiki.onap.org/).
44630       parameters:
44631         - name: ipsec-configuration-id
44632           in: path
44633           description: UUID of this configuration
44634           required: true
44635           type: string
44636           example: __IPSEC-CONFIGURATION-ID__
44637         - name: vig-address-type
44638           in: path
44639           description: indicates whether the VIG is for AVPN or INTERNET
44640           required: true
44641           type: string
44642           example: __VIG-ADDRESS-TYPE__
44643         - name: body
44644           in: body
44645           description: vig-server object that needs to be updated.
44646           required: true
44647           schema:
44648             $ref: "#/patchDefinitions/vig-server"
44649     delete:
44650       tags:
44651         - Network
44652       summary: delete an existing vig-server
44653       description: delete an existing vig-server
44654       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44655       consumes:
44656         - application/json
44657         - application/xml
44658       produces:
44659         - application/json
44660         - application/xml
44661       responses:
44662         "default":
44663           description: Response codes found in [response codes](https://wiki.onap.org/).
44664       parameters:
44665         - name: ipsec-configuration-id
44666           in: path
44667           description: UUID of this configuration
44668           required: true
44669           type: string
44670           example: __IPSEC-CONFIGURATION-ID__
44671         - name: vig-address-type
44672           in: path
44673           description: indicates whether the VIG is for AVPN or INTERNET
44674           required: true
44675           type: string
44676           example: __VIG-ADDRESS-TYPE__
44677         - name: resource-version
44678           in: query
44679           description: resource-version for concurrency
44680           required: true
44681           type: string
44682   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
44683     get:
44684       tags:
44685         - Network
44686       summary: returns vig-servers
44687       description: returns vig-servers
44688       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
44689       produces:
44690         - application/json
44691         - application/xml
44692       responses:
44693         "200":
44694           description: successful operation
44695           schema:
44696               $ref: "#/getDefinitions/vig-servers"
44697         "default":
44698           description: Response codes found in [response codes](https://wiki.onap.org/).
44699       parameters:
44700         - name: ipsec-configuration-id
44701           in: path
44702           description: UUID of this configuration
44703           required: true
44704           type: string
44705           example: __IPSEC-CONFIGURATION-ID__
44706         - name: vig-address-type
44707           in: query
44708           description:
44709           required: false
44710           type: string
44711   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
44712     get:
44713       tags:
44714         - Network
44715       summary: returns ipsec-configuration
44716       description: returns ipsec-configuration
44717       operationId: getNetworkIpsecConfigurationsIpsecConfiguration
44718       produces:
44719         - application/json
44720         - application/xml
44721       responses:
44722         "200":
44723           description: successful operation
44724           schema:
44725               $ref: "#/getDefinitions/ipsec-configuration"
44726         "default":
44727           description: Response codes found in [response codes](https://wiki.onap.org/).
44728       parameters:
44729         - name: ipsec-configuration-id
44730           in: path
44731           description: UUID of this configuration
44732           required: true
44733           type: string
44734           example: __IPSEC-CONFIGURATION-ID__
44735     put:
44736       tags:
44737         - Network
44738       summary: create or update an existing ipsec-configuration
44739       description: |
44740         Create or update an existing ipsec-configuration.
44741         #
44742         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44743       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
44744       consumes:
44745         - application/json
44746         - application/xml
44747       produces:
44748         - application/json
44749         - application/xml
44750       responses:
44751         "default":
44752           description: Response codes found in [response codes](https://wiki.onap.org/).
44753       parameters:
44754         - name: ipsec-configuration-id
44755           in: path
44756           description: UUID of this configuration
44757           required: true
44758           type: string
44759           example: __IPSEC-CONFIGURATION-ID__
44760         - name: body
44761           in: body
44762           description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json)
44763           required: true
44764           schema:
44765             $ref: "#/definitions/ipsec-configuration"
44766     patch:
44767       tags:
44768         - Network
44769       summary: update an existing ipsec-configuration
44770       description: |
44771         Update an existing ipsec-configuration
44772         #
44773         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44774         The PUT operation will entirely replace an existing object.
44775         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44776         #
44777         Other differences between PUT and PATCH are:
44778         #
44779         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44780         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44781         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44782       operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
44783       consumes:
44784         - application/json
44785         - application/xml
44786       produces:
44787         - application/json
44788         - application/xml
44789       responses:
44790         "default":
44791           description: Response codes found in [response codes](https://wiki.onap.org/).
44792       parameters:
44793         - name: ipsec-configuration-id
44794           in: path
44795           description: UUID of this configuration
44796           required: true
44797           type: string
44798           example: __IPSEC-CONFIGURATION-ID__
44799         - name: body
44800           in: body
44801           description: ipsec-configuration object that needs to be updated.
44802           required: true
44803           schema:
44804             $ref: "#/patchDefinitions/ipsec-configuration"
44805     delete:
44806       tags:
44807         - Network
44808       summary: delete an existing ipsec-configuration
44809       description: delete an existing ipsec-configuration
44810       operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
44811       consumes:
44812         - application/json
44813         - application/xml
44814       produces:
44815         - application/json
44816         - application/xml
44817       responses:
44818         "default":
44819           description: Response codes found in [response codes](https://wiki.onap.org/).
44820       parameters:
44821         - name: ipsec-configuration-id
44822           in: path
44823           description: UUID of this configuration
44824           required: true
44825           type: string
44826           example: __IPSEC-CONFIGURATION-ID__
44827         - name: resource-version
44828           in: query
44829           description: resource-version for concurrency
44830           required: true
44831           type: string
44832   /network/ipsec-configurations:
44833     get:
44834       tags:
44835         - Network
44836       summary: returns ipsec-configurations
44837       description: returns ipsec-configurations
44838       operationId: getNetworkIpsecConfigurations
44839       produces:
44840         - application/json
44841         - application/xml
44842       responses:
44843         "200":
44844           description: successful operation
44845           schema:
44846               $ref: "#/getDefinitions/ipsec-configurations"
44847         "default":
44848           description: Response codes found in [response codes](https://wiki.onap.org/).
44849       parameters:
44850         - name: ipsec-configuration-id
44851           in: query
44852           description:
44853           required: false
44854           type: string
44855   /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
44856     put:
44857       tags:
44858         - Network
44859       summary: see node definition for valid relationships
44860       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
44861       consumes:
44862         - application/json
44863         - application/xml
44864       produces:
44865         - application/json
44866         - application/xml
44867       responses:
44868         "default":
44869           description: Response codes found in [response codes](https://wiki.onap.org/).
44870       parameters:
44871         - name: route-table-reference-id
44872           in: path
44873           description: Route Table Reference id, UUID assigned to this instance.
44874           required: true
44875           type: string
44876           example: __ROUTE-TABLE-REFERENCE-ID__
44877         - name: body
44878           in: body
44879           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json)
44880           required: true
44881           schema:
44882             $ref: "#/definitions/relationship"
44883     delete:
44884       tags:
44885         - Network
44886       summary: delete an existing relationship
44887       description: delete an existing relationship
44888       operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
44889       consumes:
44890         - application/json
44891         - application/xml
44892       produces:
44893         - application/json
44894         - application/xml
44895       responses:
44896         "default":
44897           description: Response codes found in [response codes](https://wiki.onap.org/).
44898       parameters:
44899         - name: route-table-reference-id
44900           in: path
44901           description: Route Table Reference id, UUID assigned to this instance.
44902           required: true
44903           type: string
44904           example: __ROUTE-TABLE-REFERENCE-ID__
44905   /network/route-table-references/route-table-reference/{route-table-reference-id}:
44906     get:
44907       tags:
44908         - Network
44909       summary: returns route-table-reference
44910       description: returns route-table-reference
44911       operationId: getNetworkRouteTableReferencesRouteTableReference
44912       produces:
44913         - application/json
44914         - application/xml
44915       responses:
44916         "200":
44917           description: successful operation
44918           schema:
44919               $ref: "#/getDefinitions/route-table-reference"
44920         "default":
44921           description: Response codes found in [response codes](https://wiki.onap.org/).
44922       parameters:
44923         - name: route-table-reference-id
44924           in: path
44925           description: Route Table Reference id, UUID assigned to this instance.
44926           required: true
44927           type: string
44928           example: __ROUTE-TABLE-REFERENCE-ID__
44929     put:
44930       tags:
44931         - Network
44932       summary: create or update an existing route-table-reference
44933       description: |
44934         Create or update an existing route-table-reference.
44935         #
44936         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44937       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
44938       consumes:
44939         - application/json
44940         - application/xml
44941       produces:
44942         - application/json
44943         - application/xml
44944       responses:
44945         "default":
44946           description: Response codes found in [response codes](https://wiki.onap.org/).
44947       parameters:
44948         - name: route-table-reference-id
44949           in: path
44950           description: Route Table Reference id, UUID assigned to this instance.
44951           required: true
44952           type: string
44953           example: __ROUTE-TABLE-REFERENCE-ID__
44954         - name: body
44955           in: body
44956           description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json)
44957           required: true
44958           schema:
44959             $ref: "#/definitions/route-table-reference"
44960     patch:
44961       tags:
44962         - Network
44963       summary: update an existing route-table-reference
44964       description: |
44965         Update an existing route-table-reference
44966         #
44967         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44968         The PUT operation will entirely replace an existing object.
44969         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44970         #
44971         Other differences between PUT and PATCH are:
44972         #
44973         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44974         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44975         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44976       operationId: UpdateNetworkRouteTableReferencesRouteTableReference
44977       consumes:
44978         - application/json
44979         - application/xml
44980       produces:
44981         - application/json
44982         - application/xml
44983       responses:
44984         "default":
44985           description: Response codes found in [response codes](https://wiki.onap.org/).
44986       parameters:
44987         - name: route-table-reference-id
44988           in: path
44989           description: Route Table Reference id, UUID assigned to this instance.
44990           required: true
44991           type: string
44992           example: __ROUTE-TABLE-REFERENCE-ID__
44993         - name: body
44994           in: body
44995           description: route-table-reference object that needs to be updated.
44996           required: true
44997           schema:
44998             $ref: "#/patchDefinitions/route-table-reference"
44999     delete:
45000       tags:
45001         - Network
45002       summary: delete an existing route-table-reference
45003       description: delete an existing route-table-reference
45004       operationId: deleteNetworkRouteTableReferencesRouteTableReference
45005       consumes:
45006         - application/json
45007         - application/xml
45008       produces:
45009         - application/json
45010         - application/xml
45011       responses:
45012         "default":
45013           description: Response codes found in [response codes](https://wiki.onap.org/).
45014       parameters:
45015         - name: route-table-reference-id
45016           in: path
45017           description: Route Table Reference id, UUID assigned to this instance.
45018           required: true
45019           type: string
45020           example: __ROUTE-TABLE-REFERENCE-ID__
45021         - name: resource-version
45022           in: query
45023           description: resource-version for concurrency
45024           required: true
45025           type: string
45026   /network/route-table-references:
45027     get:
45028       tags:
45029         - Network
45030       summary: returns route-table-references
45031       description: returns route-table-references
45032       operationId: getNetworkRouteTableReferences
45033       produces:
45034         - application/json
45035         - application/xml
45036       responses:
45037         "200":
45038           description: successful operation
45039           schema:
45040               $ref: "#/getDefinitions/route-table-references"
45041         "default":
45042           description: Response codes found in [response codes](https://wiki.onap.org/).
45043       parameters:
45044         - name: route-table-reference-id
45045           in: query
45046           description:
45047           required: false
45048           type: string
45049         - name: route-table-reference-fqdn
45050           in: query
45051           description:
45052           required: false
45053           type: string
45054   /network/instance-groups/instance-group/{id}/relationship-list/relationship:
45055     put:
45056       tags:
45057         - Network
45058       summary: see node definition for valid relationships
45059       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
45060       consumes:
45061         - application/json
45062         - application/xml
45063       produces:
45064         - application/json
45065         - application/xml
45066       responses:
45067         "default":
45068           description: Response codes found in [response codes](https://wiki.onap.org/).
45069       parameters:
45070         - name: id
45071           in: path
45072           description: Instance Group ID, UUID assigned to this instance.
45073           required: true
45074           type: string
45075           example: __ID__
45076         - name: body
45077           in: body
45078           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json)
45079           required: true
45080           schema:
45081             $ref: "#/definitions/relationship"
45082     delete:
45083       tags:
45084         - Network
45085       summary: delete an existing relationship
45086       description: delete an existing relationship
45087       operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
45088       consumes:
45089         - application/json
45090         - application/xml
45091       produces:
45092         - application/json
45093         - application/xml
45094       responses:
45095         "default":
45096           description: Response codes found in [response codes](https://wiki.onap.org/).
45097       parameters:
45098         - name: id
45099           in: path
45100           description: Instance Group ID, UUID assigned to this instance.
45101           required: true
45102           type: string
45103           example: __ID__
45104   /network/instance-groups/instance-group/{id}:
45105     get:
45106       tags:
45107         - Network
45108       summary: returns instance-group
45109       description: returns instance-group
45110       operationId: getNetworkInstanceGroupsInstanceGroup
45111       produces:
45112         - application/json
45113         - application/xml
45114       responses:
45115         "200":
45116           description: successful operation
45117           schema:
45118               $ref: "#/getDefinitions/instance-group"
45119         "default":
45120           description: Response codes found in [response codes](https://wiki.onap.org/).
45121       parameters:
45122         - name: id
45123           in: path
45124           description: Instance Group ID, UUID assigned to this instance.
45125           required: true
45126           type: string
45127           example: __ID__
45128     put:
45129       tags:
45130         - Network
45131       summary: create or update an existing instance-group
45132       description: |
45133         Create or update an existing instance-group.
45134         #
45135         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45136       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
45137       consumes:
45138         - application/json
45139         - application/xml
45140       produces:
45141         - application/json
45142         - application/xml
45143       responses:
45144         "default":
45145           description: Response codes found in [response codes](https://wiki.onap.org/).
45146       parameters:
45147         - name: id
45148           in: path
45149           description: Instance Group ID, UUID assigned to this instance.
45150           required: true
45151           type: string
45152           example: __ID__
45153         - name: body
45154           in: body
45155           description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json)
45156           required: true
45157           schema:
45158             $ref: "#/definitions/instance-group"
45159     patch:
45160       tags:
45161         - Network
45162       summary: update an existing instance-group
45163       description: |
45164         Update an existing instance-group
45165         #
45166         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45167         The PUT operation will entirely replace an existing object.
45168         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45169         #
45170         Other differences between PUT and PATCH are:
45171         #
45172         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45173         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45174         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45175       operationId: UpdateNetworkInstanceGroupsInstanceGroup
45176       consumes:
45177         - application/json
45178         - application/xml
45179       produces:
45180         - application/json
45181         - application/xml
45182       responses:
45183         "default":
45184           description: Response codes found in [response codes](https://wiki.onap.org/).
45185       parameters:
45186         - name: id
45187           in: path
45188           description: Instance Group ID, UUID assigned to this instance.
45189           required: true
45190           type: string
45191           example: __ID__
45192         - name: body
45193           in: body
45194           description: instance-group object that needs to be updated.
45195           required: true
45196           schema:
45197             $ref: "#/patchDefinitions/instance-group"
45198     delete:
45199       tags:
45200         - Network
45201       summary: delete an existing instance-group
45202       description: delete an existing instance-group
45203       operationId: deleteNetworkInstanceGroupsInstanceGroup
45204       consumes:
45205         - application/json
45206         - application/xml
45207       produces:
45208         - application/json
45209         - application/xml
45210       responses:
45211         "default":
45212           description: Response codes found in [response codes](https://wiki.onap.org/).
45213       parameters:
45214         - name: id
45215           in: path
45216           description: Instance Group ID, UUID assigned to this instance.
45217           required: true
45218           type: string
45219           example: __ID__
45220         - name: resource-version
45221           in: query
45222           description: resource-version for concurrency
45223           required: true
45224           type: string
45225   /network/instance-groups:
45226     get:
45227       tags:
45228         - Network
45229       summary: returns instance-groups
45230       description: returns instance-groups
45231       operationId: getNetworkInstanceGroups
45232       produces:
45233         - application/json
45234         - application/xml
45235       responses:
45236         "200":
45237           description: successful operation
45238           schema:
45239               $ref: "#/getDefinitions/instance-groups"
45240         "default":
45241           description: Response codes found in [response codes](https://wiki.onap.org/).
45242       parameters:
45243         - name: id
45244           in: query
45245           description:
45246           required: false
45247           type: string
45248         - name: description
45249           in: query
45250           description:
45251           required: false
45252           type: string
45253         - name: type
45254           in: query
45255           description:
45256           required: false
45257           type: string
45258         - name: sub-type
45259           in: query
45260           description:
45261           required: false
45262           type: string
45263   /network/zones/zone/{zone-id}/relationship-list/relationship:
45264     put:
45265       tags:
45266         - Network
45267       summary: see node definition for valid relationships
45268       operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
45269       consumes:
45270         - application/json
45271         - application/xml
45272       produces:
45273         - application/json
45274         - application/xml
45275       responses:
45276         "default":
45277           description: Response codes found in [response codes](https://wiki.onap.org/).
45278       parameters:
45279         - name: zone-id
45280           in: path
45281           description: Code assigned by AIC to the zone
45282           required: true
45283           type: string
45284           example: __ZONE-ID__
45285         - name: body
45286           in: body
45287           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json)
45288           required: true
45289           schema:
45290             $ref: "#/definitions/relationship"
45291     delete:
45292       tags:
45293         - Network
45294       summary: delete an existing relationship
45295       description: delete an existing relationship
45296       operationId: deleteNetworkZonesZoneRelationshipListRelationship
45297       consumes:
45298         - application/json
45299         - application/xml
45300       produces:
45301         - application/json
45302         - application/xml
45303       responses:
45304         "default":
45305           description: Response codes found in [response codes](https://wiki.onap.org/).
45306       parameters:
45307         - name: zone-id
45308           in: path
45309           description: Code assigned by AIC to the zone
45310           required: true
45311           type: string
45312           example: __ZONE-ID__
45313   /network/zones/zone/{zone-id}:
45314     get:
45315       tags:
45316         - Network
45317       summary: returns zone
45318       description: returns zone
45319       operationId: getNetworkZonesZone
45320       produces:
45321         - application/json
45322         - application/xml
45323       responses:
45324         "200":
45325           description: successful operation
45326           schema:
45327               $ref: "#/getDefinitions/zone"
45328         "default":
45329           description: Response codes found in [response codes](https://wiki.onap.org/).
45330       parameters:
45331         - name: zone-id
45332           in: path
45333           description: Code assigned by AIC to the zone
45334           required: true
45335           type: string
45336           example: __ZONE-ID__
45337     put:
45338       tags:
45339         - Network
45340       summary: create or update an existing zone
45341       description: |
45342         Create or update an existing zone.
45343         #
45344         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45345       operationId: createOrUpdateNetworkZonesZone
45346       consumes:
45347         - application/json
45348         - application/xml
45349       produces:
45350         - application/json
45351         - application/xml
45352       responses:
45353         "default":
45354           description: Response codes found in [response codes](https://wiki.onap.org/).
45355       parameters:
45356         - name: zone-id
45357           in: path
45358           description: Code assigned by AIC to the zone
45359           required: true
45360           type: string
45361           example: __ZONE-ID__
45362         - name: body
45363           in: body
45364           description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json)
45365           required: true
45366           schema:
45367             $ref: "#/definitions/zone"
45368     patch:
45369       tags:
45370         - Network
45371       summary: update an existing zone
45372       description: |
45373         Update an existing zone
45374         #
45375         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45376         The PUT operation will entirely replace an existing object.
45377         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45378         #
45379         Other differences between PUT and PATCH are:
45380         #
45381         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45382         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45383         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45384       operationId: UpdateNetworkZonesZone
45385       consumes:
45386         - application/json
45387         - application/xml
45388       produces:
45389         - application/json
45390         - application/xml
45391       responses:
45392         "default":
45393           description: Response codes found in [response codes](https://wiki.onap.org/).
45394       parameters:
45395         - name: zone-id
45396           in: path
45397           description: Code assigned by AIC to the zone
45398           required: true
45399           type: string
45400           example: __ZONE-ID__
45401         - name: body
45402           in: body
45403           description: zone object that needs to be updated.
45404           required: true
45405           schema:
45406             $ref: "#/patchDefinitions/zone"
45407     delete:
45408       tags:
45409         - Network
45410       summary: delete an existing zone
45411       description: delete an existing zone
45412       operationId: deleteNetworkZonesZone
45413       consumes:
45414         - application/json
45415         - application/xml
45416       produces:
45417         - application/json
45418         - application/xml
45419       responses:
45420         "default":
45421           description: Response codes found in [response codes](https://wiki.onap.org/).
45422       parameters:
45423         - name: zone-id
45424           in: path
45425           description: Code assigned by AIC to the zone
45426           required: true
45427           type: string
45428           example: __ZONE-ID__
45429         - name: resource-version
45430           in: query
45431           description: resource-version for concurrency
45432           required: true
45433           type: string
45434   /network/zones:
45435     get:
45436       tags:
45437         - Network
45438       summary: returns zones
45439       description: returns zones
45440       operationId: getNetworkZones
45441       produces:
45442         - application/json
45443         - application/xml
45444       responses:
45445         "200":
45446           description: successful operation
45447           schema:
45448               $ref: "#/getDefinitions/zones"
45449         "default":
45450           description: Response codes found in [response codes](https://wiki.onap.org/).
45451       parameters:
45452         - name: zone-id
45453           in: query
45454           description:
45455           required: false
45456           type: string
45457         - name: design-type
45458           in: query
45459           description:
45460           required: false
45461           type: string
45462         - name: zone-context
45463           in: query
45464           description:
45465           required: false
45466           type: string
45467   /network/configurations/configuration/{configuration-id}/relationship-list/relationship:
45468     put:
45469       tags:
45470         - Network
45471       summary: see node definition for valid relationships
45472       operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship
45473       consumes:
45474         - application/json
45475         - application/xml
45476       produces:
45477         - application/json
45478         - application/xml
45479       responses:
45480         "default":
45481           description: Response codes found in [response codes](https://wiki.onap.org/).
45482       parameters:
45483         - name: configuration-id
45484           in: path
45485           description: UUID assigned to configuration.
45486           required: true
45487           type: string
45488           example: __CONFIGURATION-ID__
45489         - name: body
45490           in: body
45491           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json)
45492           required: true
45493           schema:
45494             $ref: "#/definitions/relationship"
45495     delete:
45496       tags:
45497         - Network
45498       summary: delete an existing relationship
45499       description: delete an existing relationship
45500       operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship
45501       consumes:
45502         - application/json
45503         - application/xml
45504       produces:
45505         - application/json
45506         - application/xml
45507       responses:
45508         "default":
45509           description: Response codes found in [response codes](https://wiki.onap.org/).
45510       parameters:
45511         - name: configuration-id
45512           in: path
45513           description: UUID assigned to configuration.
45514           required: true
45515           type: string
45516           example: __CONFIGURATION-ID__
45517   /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}:
45518     get:
45519       tags:
45520         - Network
45521       summary: returns metadatum
45522       description: returns metadatum
45523       operationId: getNetworkConfigurationsConfigurationMetadataMetadatum
45524       produces:
45525         - application/json
45526         - application/xml
45527       responses:
45528         "200":
45529           description: successful operation
45530           schema:
45531               $ref: "#/getDefinitions/metadatum"
45532         "default":
45533           description: Response codes found in [response codes](https://wiki.onap.org/).
45534       parameters:
45535         - name: configuration-id
45536           in: path
45537           description: UUID assigned to configuration.
45538           required: true
45539           type: string
45540           example: __CONFIGURATION-ID__
45541         - name: metaname
45542           in: path
45543           required: true
45544           type: string
45545           example: __METANAME__
45546     put:
45547       tags:
45548         - Network
45549       summary: create or update an existing metadatum
45550       description: |
45551         Create or update an existing metadatum.
45552         #
45553         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45554       operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum
45555       consumes:
45556         - application/json
45557         - application/xml
45558       produces:
45559         - application/json
45560         - application/xml
45561       responses:
45562         "default":
45563           description: Response codes found in [response codes](https://wiki.onap.org/).
45564       parameters:
45565         - name: configuration-id
45566           in: path
45567           description: UUID assigned to configuration.
45568           required: true
45569           type: string
45570           example: __CONFIGURATION-ID__
45571         - name: metaname
45572           in: path
45573           required: true
45574           type: string
45575           example: __METANAME__
45576         - name: body
45577           in: body
45578           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationMetadataMetadatum.json)
45579           required: true
45580           schema:
45581             $ref: "#/definitions/metadatum"
45582     patch:
45583       tags:
45584         - Network
45585       summary: update an existing metadatum
45586       description: |
45587         Update an existing metadatum
45588         #
45589         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45590         The PUT operation will entirely replace an existing object.
45591         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45592         #
45593         Other differences between PUT and PATCH are:
45594         #
45595         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45596         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45597         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45598       operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum
45599       consumes:
45600         - application/json
45601         - application/xml
45602       produces:
45603         - application/json
45604         - application/xml
45605       responses:
45606         "default":
45607           description: Response codes found in [response codes](https://wiki.onap.org/).
45608       parameters:
45609         - name: configuration-id
45610           in: path
45611           description: UUID assigned to configuration.
45612           required: true
45613           type: string
45614           example: __CONFIGURATION-ID__
45615         - name: metaname
45616           in: path
45617           required: true
45618           type: string
45619           example: __METANAME__
45620         - name: body
45621           in: body
45622           description: metadatum object that needs to be updated.
45623           required: true
45624           schema:
45625             $ref: "#/patchDefinitions/metadatum"
45626     delete:
45627       tags:
45628         - Network
45629       summary: delete an existing metadatum
45630       description: delete an existing metadatum
45631       operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum
45632       consumes:
45633         - application/json
45634         - application/xml
45635       produces:
45636         - application/json
45637         - application/xml
45638       responses:
45639         "default":
45640           description: Response codes found in [response codes](https://wiki.onap.org/).
45641       parameters:
45642         - name: configuration-id
45643           in: path
45644           description: UUID assigned to configuration.
45645           required: true
45646           type: string
45647           example: __CONFIGURATION-ID__
45648         - name: metaname
45649           in: path
45650           required: true
45651           type: string
45652           example: __METANAME__
45653         - name: resource-version
45654           in: query
45655           description: resource-version for concurrency
45656           required: true
45657           type: string
45658   /network/configurations/configuration/{configuration-id}/metadata:
45659     get:
45660       tags:
45661         - Network
45662       summary: returns metadata
45663       description: returns metadata
45664       operationId: getNetworkConfigurationsConfigurationMetadata
45665       produces:
45666         - application/json
45667         - application/xml
45668       responses:
45669         "200":
45670           description: successful operation
45671           schema:
45672               $ref: "#/getDefinitions/metadata"
45673         "default":
45674           description: Response codes found in [response codes](https://wiki.onap.org/).
45675       parameters:
45676         - name: configuration-id
45677           in: path
45678           description: UUID assigned to configuration.
45679           required: true
45680           type: string
45681           example: __CONFIGURATION-ID__
45682         - name: metaname
45683           in: query
45684           description:
45685           required: false
45686           type: string
45687   /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship:
45688     put:
45689       tags:
45690         - Network
45691       summary: see node definition for valid relationships
45692       operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
45693       consumes:
45694         - application/json
45695         - application/xml
45696       produces:
45697         - application/json
45698         - application/xml
45699       responses:
45700         "default":
45701           description: Response codes found in [response codes](https://wiki.onap.org/).
45702       parameters:
45703         - name: configuration-id
45704           in: path
45705           description: UUID assigned to configuration.
45706           required: true
45707           type: string
45708           example: __CONFIGURATION-ID__
45709         - name: forwarder-evc-id
45710           in: path
45711           description: Key for forwarder-evc object
45712           required: true
45713           type: string
45714           example: __FORWARDER-EVC-ID__
45715         - name: body
45716           in: body
45717           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
45718           required: true
45719           schema:
45720             $ref: "#/definitions/relationship"
45721     delete:
45722       tags:
45723         - Network
45724       summary: delete an existing relationship
45725       description: delete an existing relationship
45726       operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
45727       consumes:
45728         - application/json
45729         - application/xml
45730       produces:
45731         - application/json
45732         - application/xml
45733       responses:
45734         "default":
45735           description: Response codes found in [response codes](https://wiki.onap.org/).
45736       parameters:
45737         - name: configuration-id
45738           in: path
45739           description: UUID assigned to configuration.
45740           required: true
45741           type: string
45742           example: __CONFIGURATION-ID__
45743         - name: forwarder-evc-id
45744           in: path
45745           description: Key for forwarder-evc object
45746           required: true
45747           type: string
45748           example: __FORWARDER-EVC-ID__
45749   /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}:
45750     get:
45751       tags:
45752         - Network
45753       summary: returns forwarder-evc
45754       description: returns forwarder-evc
45755       operationId: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
45756       produces:
45757         - application/json
45758         - application/xml
45759       responses:
45760         "200":
45761           description: successful operation
45762           schema:
45763               $ref: "#/getDefinitions/forwarder-evc"
45764         "default":
45765           description: Response codes found in [response codes](https://wiki.onap.org/).
45766       parameters:
45767         - name: configuration-id
45768           in: path
45769           description: UUID assigned to configuration.
45770           required: true
45771           type: string
45772           example: __CONFIGURATION-ID__
45773         - name: forwarder-evc-id
45774           in: path
45775           description: Key for forwarder-evc object
45776           required: true
45777           type: string
45778           example: __FORWARDER-EVC-ID__
45779     put:
45780       tags:
45781         - Network
45782       summary: create or update an existing forwarder-evc
45783       description: |
45784         Create or update an existing forwarder-evc.
45785         #
45786         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45787       operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
45788       consumes:
45789         - application/json
45790         - application/xml
45791       produces:
45792         - application/json
45793         - application/xml
45794       responses:
45795         "default":
45796           description: Response codes found in [response codes](https://wiki.onap.org/).
45797       parameters:
45798         - name: configuration-id
45799           in: path
45800           description: UUID assigned to configuration.
45801           required: true
45802           type: string
45803           example: __CONFIGURATION-ID__
45804         - name: forwarder-evc-id
45805           in: path
45806           description: Key for forwarder-evc object
45807           required: true
45808           type: string
45809           example: __FORWARDER-EVC-ID__
45810         - name: body
45811           in: body
45812           description: forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
45813           required: true
45814           schema:
45815             $ref: "#/definitions/forwarder-evc"
45816     patch:
45817       tags:
45818         - Network
45819       summary: update an existing forwarder-evc
45820       description: |
45821         Update an existing forwarder-evc
45822         #
45823         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45824         The PUT operation will entirely replace an existing object.
45825         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45826         #
45827         Other differences between PUT and PATCH are:
45828         #
45829         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45830         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45831         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45832       operationId: UpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
45833       consumes:
45834         - application/json
45835         - application/xml
45836       produces:
45837         - application/json
45838         - application/xml
45839       responses:
45840         "default":
45841           description: Response codes found in [response codes](https://wiki.onap.org/).
45842       parameters:
45843         - name: configuration-id
45844           in: path
45845           description: UUID assigned to configuration.
45846           required: true
45847           type: string
45848           example: __CONFIGURATION-ID__
45849         - name: forwarder-evc-id
45850           in: path
45851           description: Key for forwarder-evc object
45852           required: true
45853           type: string
45854           example: __FORWARDER-EVC-ID__
45855         - name: body
45856           in: body
45857           description: forwarder-evc object that needs to be updated.
45858           required: true
45859           schema:
45860             $ref: "#/patchDefinitions/forwarder-evc"
45861     delete:
45862       tags:
45863         - Network
45864       summary: delete an existing forwarder-evc
45865       description: delete an existing forwarder-evc
45866       operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
45867       consumes:
45868         - application/json
45869         - application/xml
45870       produces:
45871         - application/json
45872         - application/xml
45873       responses:
45874         "default":
45875           description: Response codes found in [response codes](https://wiki.onap.org/).
45876       parameters:
45877         - name: configuration-id
45878           in: path
45879           description: UUID assigned to configuration.
45880           required: true
45881           type: string
45882           example: __CONFIGURATION-ID__
45883         - name: forwarder-evc-id
45884           in: path
45885           description: Key for forwarder-evc object
45886           required: true
45887           type: string
45888           example: __FORWARDER-EVC-ID__
45889         - name: resource-version
45890           in: query
45891           description: resource-version for concurrency
45892           required: true
45893           type: string
45894   /network/configurations/configuration/{configuration-id}/forwarder-evcs:
45895     get:
45896       tags:
45897         - Network
45898       summary: returns forwarder-evcs
45899       description: returns forwarder-evcs
45900       operationId: getNetworkConfigurationsConfigurationForwarderEvcs
45901       produces:
45902         - application/json
45903         - application/xml
45904       responses:
45905         "200":
45906           description: successful operation
45907           schema:
45908               $ref: "#/getDefinitions/forwarder-evcs"
45909         "default":
45910           description: Response codes found in [response codes](https://wiki.onap.org/).
45911       parameters:
45912         - name: configuration-id
45913           in: path
45914           description: UUID assigned to configuration.
45915           required: true
45916           type: string
45917           example: __CONFIGURATION-ID__
45918   /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship:
45919     put:
45920       tags:
45921         - Network
45922       summary: see node definition for valid relationships
45923       operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
45924       consumes:
45925         - application/json
45926         - application/xml
45927       produces:
45928         - application/json
45929         - application/xml
45930       responses:
45931         "default":
45932           description: Response codes found in [response codes](https://wiki.onap.org/).
45933       parameters:
45934         - name: configuration-id
45935           in: path
45936           description: UUID assigned to configuration.
45937           required: true
45938           type: string
45939           example: __CONFIGURATION-ID__
45940         - name: evc-id
45941           in: path
45942           description: Unique/key field for the evc object
45943           required: true
45944           type: string
45945           example: __EVC-ID__
45946         - name: body
45947           in: body
45948           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json)
45949           required: true
45950           schema:
45951             $ref: "#/definitions/relationship"
45952     delete:
45953       tags:
45954         - Network
45955       summary: delete an existing relationship
45956       description: delete an existing relationship
45957       operationId: deleteNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
45958       consumes:
45959         - application/json
45960         - application/xml
45961       produces:
45962         - application/json
45963         - application/xml
45964       responses:
45965         "default":
45966           description: Response codes found in [response codes](https://wiki.onap.org/).
45967       parameters:
45968         - name: configuration-id
45969           in: path
45970           description: UUID assigned to configuration.
45971           required: true
45972           type: string
45973           example: __CONFIGURATION-ID__
45974         - name: evc-id
45975           in: path
45976           description: Unique/key field for the evc object
45977           required: true
45978           type: string
45979           example: __EVC-ID__
45980   /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}:
45981     get:
45982       tags:
45983         - Network
45984       summary: returns evc
45985       description: returns evc
45986       operationId: getNetworkConfigurationsConfigurationEvcsEvc
45987       produces:
45988         - application/json
45989         - application/xml
45990       responses:
45991         "200":
45992           description: successful operation
45993           schema:
45994               $ref: "#/getDefinitions/evc"
45995         "default":
45996           description: Response codes found in [response codes](https://wiki.onap.org/).
45997       parameters:
45998         - name: configuration-id
45999           in: path
46000           description: UUID assigned to configuration.
46001           required: true
46002           type: string
46003           example: __CONFIGURATION-ID__
46004         - name: evc-id
46005           in: path
46006           description: Unique/key field for the evc object
46007           required: true
46008           type: string
46009           example: __EVC-ID__
46010     put:
46011       tags:
46012         - Network
46013       summary: create or update an existing evc
46014       description: |
46015         Create or update an existing evc.
46016         #
46017         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46018       operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvc
46019       consumes:
46020         - application/json
46021         - application/xml
46022       produces:
46023         - application/json
46024         - application/xml
46025       responses:
46026         "default":
46027           description: Response codes found in [response codes](https://wiki.onap.org/).
46028       parameters:
46029         - name: configuration-id
46030           in: path
46031           description: UUID assigned to configuration.
46032           required: true
46033           type: string
46034           example: __CONFIGURATION-ID__
46035         - name: evc-id
46036           in: path
46037           description: Unique/key field for the evc object
46038           required: true
46039           type: string
46040           example: __EVC-ID__
46041         - name: body
46042           in: body
46043           description: evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json)
46044           required: true
46045           schema:
46046             $ref: "#/definitions/evc"
46047     patch:
46048       tags:
46049         - Network
46050       summary: update an existing evc
46051       description: |
46052         Update an existing evc
46053         #
46054         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46055         The PUT operation will entirely replace an existing object.
46056         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46057         #
46058         Other differences between PUT and PATCH are:
46059         #
46060         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46061         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46062         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46063       operationId: UpdateNetworkConfigurationsConfigurationEvcsEvc
46064       consumes:
46065         - application/json
46066         - application/xml
46067       produces:
46068         - application/json
46069         - application/xml
46070       responses:
46071         "default":
46072           description: Response codes found in [response codes](https://wiki.onap.org/).
46073       parameters:
46074         - name: configuration-id
46075           in: path
46076           description: UUID assigned to configuration.
46077           required: true
46078           type: string
46079           example: __CONFIGURATION-ID__
46080         - name: evc-id
46081           in: path
46082           description: Unique/key field for the evc object
46083           required: true
46084           type: string
46085           example: __EVC-ID__
46086         - name: body
46087           in: body
46088           description: evc object that needs to be updated.
46089           required: true
46090           schema:
46091             $ref: "#/patchDefinitions/evc"
46092     delete:
46093       tags:
46094         - Network
46095       summary: delete an existing evc
46096       description: delete an existing evc
46097       operationId: deleteNetworkConfigurationsConfigurationEvcsEvc
46098       consumes:
46099         - application/json
46100         - application/xml
46101       produces:
46102         - application/json
46103         - application/xml
46104       responses:
46105         "default":
46106           description: Response codes found in [response codes](https://wiki.onap.org/).
46107       parameters:
46108         - name: configuration-id
46109           in: path
46110           description: UUID assigned to configuration.
46111           required: true
46112           type: string
46113           example: __CONFIGURATION-ID__
46114         - name: evc-id
46115           in: path
46116           description: Unique/key field for the evc object
46117           required: true
46118           type: string
46119           example: __EVC-ID__
46120         - name: resource-version
46121           in: query
46122           description: resource-version for concurrency
46123           required: true
46124           type: string
46125   /network/configurations/configuration/{configuration-id}/evcs:
46126     get:
46127       tags:
46128         - Network
46129       summary: returns evcs
46130       description: returns evcs
46131       operationId: getNetworkConfigurationsConfigurationEvcs
46132       produces:
46133         - application/json
46134         - application/xml
46135       responses:
46136         "200":
46137           description: successful operation
46138           schema:
46139               $ref: "#/getDefinitions/evcs"
46140         "default":
46141           description: Response codes found in [response codes](https://wiki.onap.org/).
46142       parameters:
46143         - name: configuration-id
46144           in: path
46145           description: UUID assigned to configuration.
46146           required: true
46147           type: string
46148           example: __CONFIGURATION-ID__
46149   /network/configurations/configuration/{configuration-id}:
46150     get:
46151       tags:
46152         - Network
46153       summary: returns configuration
46154       description: returns configuration
46155       operationId: getNetworkConfigurationsConfiguration
46156       produces:
46157         - application/json
46158         - application/xml
46159       responses:
46160         "200":
46161           description: successful operation
46162           schema:
46163               $ref: "#/getDefinitions/configuration"
46164         "default":
46165           description: Response codes found in [response codes](https://wiki.onap.org/).
46166       parameters:
46167         - name: configuration-id
46168           in: path
46169           description: UUID assigned to configuration.
46170           required: true
46171           type: string
46172           example: __CONFIGURATION-ID__
46173     put:
46174       tags:
46175         - Network
46176       summary: create or update an existing configuration
46177       description: |
46178         Create or update an existing configuration.
46179         #
46180         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46181       operationId: createOrUpdateNetworkConfigurationsConfiguration
46182       consumes:
46183         - application/json
46184         - application/xml
46185       produces:
46186         - application/json
46187         - application/xml
46188       responses:
46189         "default":
46190           description: Response codes found in [response codes](https://wiki.onap.org/).
46191       parameters:
46192         - name: configuration-id
46193           in: path
46194           description: UUID assigned to configuration.
46195           required: true
46196           type: string
46197           example: __CONFIGURATION-ID__
46198         - name: body
46199           in: body
46200           description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json)
46201           required: true
46202           schema:
46203             $ref: "#/definitions/configuration"
46204     patch:
46205       tags:
46206         - Network
46207       summary: update an existing configuration
46208       description: |
46209         Update an existing configuration
46210         #
46211         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46212         The PUT operation will entirely replace an existing object.
46213         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46214         #
46215         Other differences between PUT and PATCH are:
46216         #
46217         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46218         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46219         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46220       operationId: UpdateNetworkConfigurationsConfiguration
46221       consumes:
46222         - application/json
46223         - application/xml
46224       produces:
46225         - application/json
46226         - application/xml
46227       responses:
46228         "default":
46229           description: Response codes found in [response codes](https://wiki.onap.org/).
46230       parameters:
46231         - name: configuration-id
46232           in: path
46233           description: UUID assigned to configuration.
46234           required: true
46235           type: string
46236           example: __CONFIGURATION-ID__
46237         - name: body
46238           in: body
46239           description: configuration object that needs to be updated.
46240           required: true
46241           schema:
46242             $ref: "#/patchDefinitions/configuration"
46243     delete:
46244       tags:
46245         - Network
46246       summary: delete an existing configuration
46247       description: delete an existing configuration
46248       operationId: deleteNetworkConfigurationsConfiguration
46249       consumes:
46250         - application/json
46251         - application/xml
46252       produces:
46253         - application/json
46254         - application/xml
46255       responses:
46256         "default":
46257           description: Response codes found in [response codes](https://wiki.onap.org/).
46258       parameters:
46259         - name: configuration-id
46260           in: path
46261           description: UUID assigned to configuration.
46262           required: true
46263           type: string
46264           example: __CONFIGURATION-ID__
46265         - name: resource-version
46266           in: query
46267           description: resource-version for concurrency
46268           required: true
46269           type: string
46270   /network/configurations:
46271     get:
46272       tags:
46273         - Network
46274       summary: returns configurations
46275       description: returns configurations
46276       operationId: getNetworkConfigurations
46277       produces:
46278         - application/json
46279         - application/xml
46280       responses:
46281         "200":
46282           description: successful operation
46283           schema:
46284               $ref: "#/getDefinitions/configurations"
46285         "default":
46286           description: Response codes found in [response codes](https://wiki.onap.org/).
46287       parameters:
46288         - name: configuration-id
46289           in: query
46290           description:
46291           required: false
46292           type: string
46293         - name: model-invariant-id
46294           in: query
46295           description:
46296           required: false
46297           type: string
46298         - name: model-version-id
46299           in: query
46300           description:
46301           required: false
46302           type: string
46303   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship:
46304     put:
46305       tags:
46306         - Network
46307       summary: see node definition for valid relationships
46308       operationId: createOrUpdateNetworkForwardingPathsForwardingPathRelationshipListRelationship
46309       consumes:
46310         - application/json
46311         - application/xml
46312       produces:
46313         - application/json
46314         - application/xml
46315       responses:
46316         "default":
46317           description: Response codes found in [response codes](https://wiki.onap.org/).
46318       parameters:
46319         - name: forwarding-path-id
46320           in: path
46321           description: Unique ID of this FP
46322           required: true
46323           type: string
46324           example: __FORWARDING-PATH-ID__
46325         - name: body
46326           in: body
46327           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json)
46328           required: true
46329           schema:
46330             $ref: "#/definitions/relationship"
46331     delete:
46332       tags:
46333         - Network
46334       summary: delete an existing relationship
46335       description: delete an existing relationship
46336       operationId: deleteNetworkForwardingPathsForwardingPathRelationshipListRelationship
46337       consumes:
46338         - application/json
46339         - application/xml
46340       produces:
46341         - application/json
46342         - application/xml
46343       responses:
46344         "default":
46345           description: Response codes found in [response codes](https://wiki.onap.org/).
46346       parameters:
46347         - name: forwarding-path-id
46348           in: path
46349           description: Unique ID of this FP
46350           required: true
46351           type: string
46352           example: __FORWARDING-PATH-ID__
46353   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship:
46354     put:
46355       tags:
46356         - Network
46357       summary: see node definition for valid relationships
46358       operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
46359       consumes:
46360         - application/json
46361         - application/xml
46362       produces:
46363         - application/json
46364         - application/xml
46365       responses:
46366         "default":
46367           description: Response codes found in [response codes](https://wiki.onap.org/).
46368       parameters:
46369         - name: forwarding-path-id
46370           in: path
46371           description: Unique ID of this FP
46372           required: true
46373           type: string
46374           example: __FORWARDING-PATH-ID__
46375         - name: sequence
46376           in: path
46377           description: Unique ID of this segmentation
46378           required: true
46379           type: integer
46380           format: int32
46381           example: __SEQUENCE__
46382         - name: body
46383           in: body
46384           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
46385           required: true
46386           schema:
46387             $ref: "#/definitions/relationship"
46388     delete:
46389       tags:
46390         - Network
46391       summary: delete an existing relationship
46392       description: delete an existing relationship
46393       operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
46394       consumes:
46395         - application/json
46396         - application/xml
46397       produces:
46398         - application/json
46399         - application/xml
46400       responses:
46401         "default":
46402           description: Response codes found in [response codes](https://wiki.onap.org/).
46403       parameters:
46404         - name: forwarding-path-id
46405           in: path
46406           description: Unique ID of this FP
46407           required: true
46408           type: string
46409           example: __FORWARDING-PATH-ID__
46410         - name: sequence
46411           in: path
46412           description: Unique ID of this segmentation
46413           required: true
46414           type: integer
46415           format: int32
46416           example: __SEQUENCE__
46417   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}:
46418     get:
46419       tags:
46420         - Network
46421       summary: returns forwarder
46422       description: returns forwarder
46423       operationId: getNetworkForwardingPathsForwardingPathForwardersForwarder
46424       produces:
46425         - application/json
46426         - application/xml
46427       responses:
46428         "200":
46429           description: successful operation
46430           schema:
46431               $ref: "#/getDefinitions/forwarder"
46432         "default":
46433           description: Response codes found in [response codes](https://wiki.onap.org/).
46434       parameters:
46435         - name: forwarding-path-id
46436           in: path
46437           description: Unique ID of this FP
46438           required: true
46439           type: string
46440           example: __FORWARDING-PATH-ID__
46441         - name: sequence
46442           in: path
46443           description: Unique ID of this segmentation
46444           required: true
46445           type: integer
46446           format: int32
46447           example: __SEQUENCE__
46448     put:
46449       tags:
46450         - Network
46451       summary: create or update an existing forwarder
46452       description: |
46453         Create or update an existing forwarder.
46454         #
46455         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46456       operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarder
46457       consumes:
46458         - application/json
46459         - application/xml
46460       produces:
46461         - application/json
46462         - application/xml
46463       responses:
46464         "default":
46465           description: Response codes found in [response codes](https://wiki.onap.org/).
46466       parameters:
46467         - name: forwarding-path-id
46468           in: path
46469           description: Unique ID of this FP
46470           required: true
46471           type: string
46472           example: __FORWARDING-PATH-ID__
46473         - name: sequence
46474           in: path
46475           description: Unique ID of this segmentation
46476           required: true
46477           type: integer
46478           format: int32
46479           example: __SEQUENCE__
46480         - name: body
46481           in: body
46482           description: forwarder object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
46483           required: true
46484           schema:
46485             $ref: "#/definitions/forwarder"
46486     patch:
46487       tags:
46488         - Network
46489       summary: update an existing forwarder
46490       description: |
46491         Update an existing forwarder
46492         #
46493         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46494         The PUT operation will entirely replace an existing object.
46495         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46496         #
46497         Other differences between PUT and PATCH are:
46498         #
46499         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46500         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46501         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46502       operationId: UpdateNetworkForwardingPathsForwardingPathForwardersForwarder
46503       consumes:
46504         - application/json
46505         - application/xml
46506       produces:
46507         - application/json
46508         - application/xml
46509       responses:
46510         "default":
46511           description: Response codes found in [response codes](https://wiki.onap.org/).
46512       parameters:
46513         - name: forwarding-path-id
46514           in: path
46515           description: Unique ID of this FP
46516           required: true
46517           type: string
46518           example: __FORWARDING-PATH-ID__
46519         - name: sequence
46520           in: path
46521           description: Unique ID of this segmentation
46522           required: true
46523           type: integer
46524           format: int32
46525           example: __SEQUENCE__
46526         - name: body
46527           in: body
46528           description: forwarder object that needs to be updated.
46529           required: true
46530           schema:
46531             $ref: "#/patchDefinitions/forwarder"
46532     delete:
46533       tags:
46534         - Network
46535       summary: delete an existing forwarder
46536       description: delete an existing forwarder
46537       operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarder
46538       consumes:
46539         - application/json
46540         - application/xml
46541       produces:
46542         - application/json
46543         - application/xml
46544       responses:
46545         "default":
46546           description: Response codes found in [response codes](https://wiki.onap.org/).
46547       parameters:
46548         - name: forwarding-path-id
46549           in: path
46550           description: Unique ID of this FP
46551           required: true
46552           type: string
46553           example: __FORWARDING-PATH-ID__
46554         - name: sequence
46555           in: path
46556           description: Unique ID of this segmentation
46557           required: true
46558           type: integer
46559           format: int32
46560           example: __SEQUENCE__
46561         - name: resource-version
46562           in: query
46563           description: resource-version for concurrency
46564           required: true
46565           type: string
46566   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders:
46567     get:
46568       tags:
46569         - Network
46570       summary: returns forwarders
46571       description: returns forwarders
46572       operationId: getNetworkForwardingPathsForwardingPathForwarders
46573       produces:
46574         - application/json
46575         - application/xml
46576       responses:
46577         "200":
46578           description: successful operation
46579           schema:
46580               $ref: "#/getDefinitions/forwarders"
46581         "default":
46582           description: Response codes found in [response codes](https://wiki.onap.org/).
46583       parameters:
46584         - name: forwarding-path-id
46585           in: path
46586           description: Unique ID of this FP
46587           required: true
46588           type: string
46589           example: __FORWARDING-PATH-ID__
46590         - name: sequence
46591           in: query
46592           description:
46593           required: false
46594           type: integer
46595           format: int32
46596   /network/forwarding-paths/forwarding-path/{forwarding-path-id}:
46597     get:
46598       tags:
46599         - Network
46600       summary: returns forwarding-path
46601       description: returns forwarding-path
46602       operationId: getNetworkForwardingPathsForwardingPath
46603       produces:
46604         - application/json
46605         - application/xml
46606       responses:
46607         "200":
46608           description: successful operation
46609           schema:
46610               $ref: "#/getDefinitions/forwarding-path"
46611         "default":
46612           description: Response codes found in [response codes](https://wiki.onap.org/).
46613       parameters:
46614         - name: forwarding-path-id
46615           in: path
46616           description: Unique ID of this FP
46617           required: true
46618           type: string
46619           example: __FORWARDING-PATH-ID__
46620     put:
46621       tags:
46622         - Network
46623       summary: create or update an existing forwarding-path
46624       description: |
46625         Create or update an existing forwarding-path.
46626         #
46627         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46628       operationId: createOrUpdateNetworkForwardingPathsForwardingPath
46629       consumes:
46630         - application/json
46631         - application/xml
46632       produces:
46633         - application/json
46634         - application/xml
46635       responses:
46636         "default":
46637           description: Response codes found in [response codes](https://wiki.onap.org/).
46638       parameters:
46639         - name: forwarding-path-id
46640           in: path
46641           description: Unique ID of this FP
46642           required: true
46643           type: string
46644           example: __FORWARDING-PATH-ID__
46645         - name: body
46646           in: body
46647           description: forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json)
46648           required: true
46649           schema:
46650             $ref: "#/definitions/forwarding-path"
46651     patch:
46652       tags:
46653         - Network
46654       summary: update an existing forwarding-path
46655       description: |
46656         Update an existing forwarding-path
46657         #
46658         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46659         The PUT operation will entirely replace an existing object.
46660         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46661         #
46662         Other differences between PUT and PATCH are:
46663         #
46664         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46665         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46666         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46667       operationId: UpdateNetworkForwardingPathsForwardingPath
46668       consumes:
46669         - application/json
46670         - application/xml
46671       produces:
46672         - application/json
46673         - application/xml
46674       responses:
46675         "default":
46676           description: Response codes found in [response codes](https://wiki.onap.org/).
46677       parameters:
46678         - name: forwarding-path-id
46679           in: path
46680           description: Unique ID of this FP
46681           required: true
46682           type: string
46683           example: __FORWARDING-PATH-ID__
46684         - name: body
46685           in: body
46686           description: forwarding-path object that needs to be updated.
46687           required: true
46688           schema:
46689             $ref: "#/patchDefinitions/forwarding-path"
46690     delete:
46691       tags:
46692         - Network
46693       summary: delete an existing forwarding-path
46694       description: delete an existing forwarding-path
46695       operationId: deleteNetworkForwardingPathsForwardingPath
46696       consumes:
46697         - application/json
46698         - application/xml
46699       produces:
46700         - application/json
46701         - application/xml
46702       responses:
46703         "default":
46704           description: Response codes found in [response codes](https://wiki.onap.org/).
46705       parameters:
46706         - name: forwarding-path-id
46707           in: path
46708           description: Unique ID of this FP
46709           required: true
46710           type: string
46711           example: __FORWARDING-PATH-ID__
46712         - name: resource-version
46713           in: query
46714           description: resource-version for concurrency
46715           required: true
46716           type: string
46717   /network/forwarding-paths:
46718     get:
46719       tags:
46720         - Network
46721       summary: returns forwarding-paths
46722       description: returns forwarding-paths
46723       operationId: getNetworkForwardingPaths
46724       produces:
46725         - application/json
46726         - application/xml
46727       responses:
46728         "200":
46729           description: successful operation
46730           schema:
46731               $ref: "#/getDefinitions/forwarding-paths"
46732         "default":
46733           description: Response codes found in [response codes](https://wiki.onap.org/).
46734       parameters:
46735         - name: forwarding-path-id
46736           in: query
46737           description:
46738           required: false
46739           type: string
46740         - name: forwarding-path-name
46741           in: query
46742           description:
46743           required: false
46744           type: string
46745 definitions:
46746   action:
46747     properties:
46748       action-type:
46749         type: string
46750       action-data:
46751         type: array
46752         items:
46753           $ref: "#/definitions/action-data"
46754   action-data:
46755     properties:
46756       property-name:
46757         type: string
46758       property-value:
46759         type: string
46760   actions:
46761     description: |
46762       APIs that are more action related than REST (e.g., notify, update).
46763     properties:
46764       update:
46765         type: object
46766         $ref: "#/definitions/update"
46767       notify:
46768         type: object
46769         $ref: "#/definitions/notify"
46770   allotted-resource:
46771     description: |
46772       Represents a slice or partial piece of a resource that gets separately allotted
46773       ###### Related Nodes
46774       - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
46775       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
46776       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
46777       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
46778       - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
46779       - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
46780       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
46781       - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
46782       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
46783       - TO model-ver( allotted-resource IsA model-ver, Many2One)
46784       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
46785       - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
46786       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
46787       - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
46788
46789       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
46790       -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
46791       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
46792     required:
46793     - id
46794     properties:
46795       id:
46796         type: string
46797         description: Allotted Resource id UUID assigned to this instance.
46798       description:
46799         type: string
46800         description: The descriptive information assigned to this allotted resource instance
46801       selflink:
46802         type: string
46803         description: Link back to more information in the controller
46804       model-invariant-id:
46805         type: string
46806         description: the ASDC model id for this resource or service model.
46807       model-version-id:
46808         type: string
46809         description: the ASDC model version for this resource or service model.
46810       persona-model-version:
46811         type: string
46812         description: the ASDC model version for this resource or service model.
46813       resource-version:
46814         type: string
46815         description: Concurrency value
46816       orchestration-status:
46817         type: string
46818         description: Orchestration status
46819       operational-status:
46820         type: string
46821         description: Indicator for whether the resource is considered operational
46822       type:
46823         type: string
46824         description: Generic description of the type of allotted resource.
46825       role:
46826         type: string
46827         description: role in the network that this resource will be providing.
46828       tunnel-xconnects:
46829         type: array
46830         items:
46831           $ref: "#/definitions/tunnel-xconnect"
46832       relationship-list:
46833         type: array
46834         items:
46835           $ref: "#/definitions/relationship"
46836   allotted-resources:
46837     description: |
46838       This object is used to store slices of services being offered
46839     properties:
46840       allotted-resource:
46841         type: array
46842         items:
46843           $ref: "#/definitions/allotted-resource"
46844   availability-zone:
46845     description: |
46846       Availability zone, a collection of compute hosts/pservers
46847       ###### Related Nodes
46848       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
46849       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
46850       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
46851       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
46852       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
46853       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
46854       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
46855       - FROM vce( vce Uses availability-zone, MANY2MANY)
46856
46857       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
46858       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
46859
46860     required:
46861     - availability-zone-name
46862     - hypervisor-type
46863     properties:
46864       availability-zone-name:
46865         type: string
46866         description: Name of the availability zone.  Unique across a cloud region
46867       hypervisor-type:
46868         type: string
46869         description: Type of hypervisor.  Source of truth should define valid values.
46870       operational-status:
46871         type: string
46872         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
46873       resource-version:
46874         type: string
46875         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46876       relationship-list:
46877         type: array
46878         items:
46879           $ref: "#/definitions/relationship"
46880   availability-zones:
46881     description: |
46882       Collection of availability zones
46883     properties:
46884       availability-zone:
46885         type: array
46886         items:
46887           $ref: "#/definitions/availability-zone"
46888   az-and-dvs-switches:
46889     properties:
46890       dvs-switches:
46891         type: object
46892         $ref: "#/definitions/dvs-switches"
46893       availability-zone:
46894         type: object
46895         $ref: "#/definitions/availability-zone"
46896   business:
46897     description: |
46898       Namespace for business related constructs
46899     properties:
46900       connectors:
46901         type: array
46902         items:
46903           $ref: "#/definitions/connector"
46904       customers:
46905         type: array
46906         items:
46907           $ref: "#/definitions/customer"
46908       lines-of-business:
46909         type: array
46910         items:
46911           $ref: "#/definitions/line-of-business"
46912       owning-entities:
46913         type: array
46914         items:
46915           $ref: "#/definitions/owning-entity"
46916       platforms:
46917         type: array
46918         items:
46919           $ref: "#/definitions/platform"
46920       projects:
46921         type: array
46922         items:
46923           $ref: "#/definitions/project"
46924   class-of-service:
46925     description: |
46926       ###### Related Nodes
46927       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
46928
46929       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
46930     required:
46931     - cos
46932     properties:
46933       cos:
46934         type: string
46935         description: unique identifier of probe
46936       probe-id:
46937         type: string
46938         description: identifier of probe
46939       probe-type:
46940         type: string
46941         description: type of probe
46942       resource-version:
46943         type: string
46944         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46945       relationship-list:
46946         type: array
46947         items:
46948           $ref: "#/definitions/relationship"
46949   classes-of-service:
46950     description: |
46951       class-of-service of probe
46952     properties:
46953       class-of-service:
46954         type: array
46955         items:
46956           $ref: "#/definitions/class-of-service"
46957   cloud-infrastructure:
46958     description: |
46959       Namespace for cloud infrastructure.
46960     properties:
46961       complexes:
46962         type: array
46963         items:
46964           $ref: "#/definitions/complex"
46965       cloud-regions:
46966         type: array
46967         items:
46968           $ref: "#/definitions/cloud-region"
46969       network-profiles:
46970         type: array
46971         items:
46972           $ref: "#/definitions/network-profile"
46973       pservers:
46974         type: array
46975         items:
46976           $ref: "#/definitions/pserver"
46977       virtual-data-centers:
46978         type: array
46979         items:
46980           $ref: "#/definitions/virtual-data-center"
46981       operational-environments:
46982         type: array
46983         items:
46984           $ref: "#/definitions/operational-environment"
46985   cloud-region:
46986     description: |
46987       cloud-region designates an installation of a cloud cluster or region or instantiation.
46988       ###### Related Nodes
46989       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
46990       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
46991       - TO zone( cloud-region LocatedIn zone, MANY2ONE)
46992       - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
46993       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
46994       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
46995       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
46996       - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)
46997       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
46998       - FROM image( image BelongsTo cloud-region, MANY2ONE)
46999       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
47000       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
47001       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
47002       - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
47003       - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
47004       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
47005       - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
47006       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
47007
47008       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
47009       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
47010
47011     required:
47012     - cloud-owner
47013     - cloud-region-id
47014     - sriov-automation
47015     properties:
47016       cloud-owner:
47017         type: string
47018         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
47019       cloud-region-id:
47020         type: string
47021         description: Identifier used by the vendor for the region. Second part of composite key
47022       cloud-type:
47023         type: string
47024         description: Type of the cloud (e.g., openstack)
47025       owner-defined-type:
47026         type: string
47027         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
47028       cloud-region-version:
47029         type: string
47030         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
47031       identity-url:
47032         type: string
47033         description: URL of the keystone identity service
47034       cloud-zone:
47035         type: string
47036         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
47037       complex-name:
47038         type: string
47039         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
47040       sriov-automation:
47041         type: boolean
47042         description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
47043       cloud-extra-info:
47044         type: string
47045         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
47046       cloud-epa-caps:
47047         type: string
47048         description: MultiVIM will discover and expose EPA capabilities.
47049       resource-version:
47050         type: string
47051         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47052       volume-groups:
47053         type: array
47054         items:
47055           $ref: "#/definitions/volume-group"
47056       tenants:
47057         type: array
47058         items:
47059           $ref: "#/definitions/tenant"
47060       flavors:
47061         type: array
47062         items:
47063           $ref: "#/definitions/flavor"
47064       group-assignments:
47065         type: array
47066         items:
47067           $ref: "#/definitions/group-assignment"
47068       snapshots:
47069         type: array
47070         items:
47071           $ref: "#/definitions/snapshot"
47072       images:
47073         type: array
47074         items:
47075           $ref: "#/definitions/image"
47076       dvs-switches:
47077         type: array
47078         items:
47079           $ref: "#/definitions/dvs-switch"
47080       oam-networks:
47081         type: array
47082         items:
47083           $ref: "#/definitions/oam-network"
47084       availability-zones:
47085         type: array
47086         items:
47087           $ref: "#/definitions/availability-zone"
47088       relationship-list:
47089         type: array
47090         items:
47091           $ref: "#/definitions/relationship"
47092       vip-ipv4-address-list:
47093         type: array
47094         items:
47095           $ref: "#/definitions/vip-ipv4-address-list"
47096       vip-ipv6-address-list:
47097         type: array
47098         items:
47099           $ref: "#/definitions/vip-ipv6-address-list"
47100       hpa-capabilities:
47101         type: array
47102         items:
47103           $ref: "#/definitions/hpa-capability"
47104         description: List of cloud-region specific HPA Capabilities
47105   cloud-regions:
47106     properties:
47107       cloud-region:
47108         type: array
47109         items:
47110           $ref: "#/definitions/cloud-region"
47111   complex:
47112     description: |
47113       Collection of physical locations that can house cloud-regions.
47114       ###### Related Nodes
47115       - TO l3-network( complex Uses l3-network, MANY2MANY)
47116       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
47117       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
47118       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
47119       - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
47120       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
47121       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
47122       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
47123       - FROM vce( vce LocatedIn complex, MANY2MANY)
47124       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
47125       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
47126       - FROM zone( zone LocatedIn complex, MANY2ONE)
47127
47128       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
47129       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
47130
47131     required:
47132     - physical-location-id
47133     - physical-location-type
47134     - street1
47135     - city
47136     - postal-code
47137     - country
47138     - region
47139     properties:
47140       physical-location-id:
47141         type: string
47142         description: Unique identifier for physical location, e.g., CLLI
47143       data-center-code:
47144         type: string
47145         description: Data center code which can be an alternate way to identify a complex
47146       complex-name:
47147         type: string
47148         description: Gamma complex name for LCP instance.
47149       identity-url:
47150         type: string
47151         description: URL of the keystone identity service
47152       resource-version:
47153         type: string
47154         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47155       physical-location-type:
47156         type: string
47157         description: Type, e.g., central office, data center.
47158       street1:
47159         type: string
47160       street2:
47161         type: string
47162       city:
47163         type: string
47164       state:
47165         type: string
47166       postal-code:
47167         type: string
47168       country:
47169         type: string
47170       region:
47171         type: string
47172       latitude:
47173         type: string
47174       longitude:
47175         type: string
47176       elevation:
47177         type: string
47178       lata:
47179         type: string
47180       ctag-pools:
47181         type: array
47182         items:
47183           $ref: "#/definitions/ctag-pool"
47184       relationship-list:
47185         type: array
47186         items:
47187           $ref: "#/definitions/relationship"
47188   complexes:
47189     description: |
47190       Collection of physical locations that can house cloud-regions.
47191     properties:
47192       complex:
47193         type: array
47194         items:
47195           $ref: "#/definitions/complex"
47196   configuration:
47197     description: |
47198       Port Mirror Configuration.
47199       ###### Related Nodes
47200       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
47201       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
47202       - TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
47203       - TO pnf( configuration AppliesTo pnf, ONE2MANY)
47204       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
47205       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
47206       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
47207       - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
47208       - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
47209       - FROM evc( evc BelongsTo configuration, ONE2ONE)(1)
47210       - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)
47211
47212       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
47213       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
47214       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
47215     required:
47216     - configuration-id
47217     - configuration-type
47218     - configuration-sub-type
47219     - orchestration-status
47220     - operational-status
47221     - configuration-selflink
47222     - model-customization-id
47223     properties:
47224       configuration-id:
47225         type: string
47226         description: UUID assigned to configuration.
47227       management-option:
47228         type: string
47229         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
47230       configuration-name:
47231         type: string
47232         description: Name of the configuration.
47233       configuration-type:
47234         type: string
47235         description: port-mirroring-configuration.
47236       configuration-sub-type:
47237         type: string
47238         description: vprobe, pprobe.
47239       model-invariant-id:
47240         type: string
47241         description: the ASDC model id for this resource or service model.
47242       model-version-id:
47243         type: string
47244         description: the ASDC model version for this resource or service model.
47245       orchestration-status:
47246         type: string
47247         description: Orchestration status of the configuration.
47248       operational-status:
47249         type: string
47250         description: Indicator for whether the resource is considered operational.
47251       configuration-selflink:
47252         type: string
47253         description: URL to endpoint where AAI can get more details from SDN-GC.
47254       model-customization-id:
47255         type: string
47256         description: id of  the configuration used to customize the resource
47257       tunnel-bandwidth:
47258         type: string
47259         description: DHV Site Effective Bandwidth
47260       vendor-allowed-max-bandwidth:
47261         type: string
47262         description: Velocloud Nominal Throughput - VNT
47263       resource-version:
47264         type: string
47265         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47266       relationship-list:
47267         type: array
47268         items:
47269           $ref: "#/definitions/relationship"
47270       metadata:
47271         type: array
47272         items:
47273           $ref: "#/definitions/metadatum"
47274       forwarder-evcs:
47275         type: array
47276         items:
47277           $ref: "#/definitions/forwarder-evc"
47278       evcs:
47279         type: array
47280         items:
47281           $ref: "#/definitions/evc"
47282   configurations:
47283     description: |
47284       Collection of configurations
47285     properties:
47286       configuration:
47287         type: array
47288         items:
47289           $ref: "#/definitions/configuration"
47290   connector:
47291     description: |
47292       Collection of resource instances used to connect a variety of disparate inventory widgets
47293       ###### Related Nodes
47294       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
47295       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
47296       - FROM service-instance( service-instance Uses connector, MANY2MANY)
47297
47298       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
47299     required:
47300     - resource-instance-id
47301     properties:
47302       resource-instance-id:
47303         type: string
47304         description: Unique id of resource instance.
47305       resource-version:
47306         type: string
47307         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47308       model-invariant-id:
47309         type: string
47310         description: the ASDC model id for this resource or service model.
47311       model-version-id:
47312         type: string
47313         description: the ASDC model version for this resource or service model.
47314       persona-model-version:
47315         type: string
47316         description: the ASDC model version for this resource or service model.
47317       widget-model-id:
47318         type: string
47319         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
47320       widget-model-version:
47321         type: string
47322         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
47323       relationship-list:
47324         type: array
47325         items:
47326           $ref: "#/definitions/relationship"
47327       metadata:
47328         type: array
47329         items:
47330           $ref: "#/definitions/metadatum"
47331   connectors:
47332     description: |
47333       Collection of resource instances used to connect a variety of disparate inventory widgets
47334     properties:
47335       connector:
47336         type: array
47337         items:
47338           $ref: "#/definitions/connector"
47339   constrained-element-set:
47340     description: |
47341       This is how we would capture constraints defining allowed sets of elements.
47342       ###### Related Nodes
47343       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
47344       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
47345       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
47346
47347       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
47348       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
47349     required:
47350     - constrained-element-set-uuid
47351     - constraint-type
47352     - check-type
47353     properties:
47354       constrained-element-set-uuid:
47355         type: string
47356       constraint-type:
47357         type: string
47358       check-type:
47359         type: string
47360       resource-version:
47361         type: string
47362       element-choice-sets:
47363         type: array
47364         items:
47365           $ref: "#/definitions/element-choice-set"
47366       relationship-list:
47367         type: array
47368         items:
47369           $ref: "#/definitions/relationship"
47370   constrained-element-sets:
47371     properties:
47372       constrained-element-set:
47373         type: array
47374         items:
47375           $ref: "#/definitions/constrained-element-set"
47376   ctag-assignment:
47377     description: |
47378       ###### Related Nodes
47379       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
47380       - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
47381
47382       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
47383     required:
47384     - vlan-id-inner
47385     properties:
47386       vlan-id-inner:
47387         type: integer
47388         format: int64
47389         description: id.
47390       resource-version:
47391         type: string
47392         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47393       relationship-list:
47394         type: array
47395         items:
47396           $ref: "#/definitions/relationship"
47397   ctag-assignments:
47398     properties:
47399       ctag-assignment:
47400         type: array
47401         items:
47402           $ref: "#/definitions/ctag-assignment"
47403   ctag-pool:
47404     description: |
47405       A collection of C tags (vlan tags) grouped for a specific purpose.
47406       ###### Related Nodes
47407       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
47408       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
47409       - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
47410       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
47411
47412       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
47413     required:
47414     - target-pe
47415     - availability-zone-name
47416     - ctag-pool-purpose
47417     properties:
47418       target-pe:
47419         type: string
47420         description: The Target provider edge router
47421       availability-zone-name:
47422         type: string
47423         description: Name of the availability zone
47424       ctag-pool-purpose:
47425         type: string
47426         description: Describes what the intended purpose of this pool is.
47427       ctag-values:
47428         type: string
47429         description: Comma separated list of ctags
47430       resource-version:
47431         type: string
47432         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47433       relationship-list:
47434         type: array
47435         items:
47436           $ref: "#/definitions/relationship"
47437   ctag-pools:
47438     properties:
47439       ctag-pool:
47440         type: array
47441         items:
47442           $ref: "#/definitions/ctag-pool"
47443   customer:
47444     description: |
47445       customer identifiers to provide linkage back to BSS information.
47446       ###### Related Nodes
47447       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
47448
47449       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
47450     required:
47451     - global-customer-id
47452     - subscriber-name
47453     - subscriber-type
47454     properties:
47455       global-customer-id:
47456         type: string
47457         description: Global customer id used across ECOMP to uniquely identify customer.
47458       subscriber-name:
47459         type: string
47460         description: Subscriber name, an alternate way to retrieve a customer.
47461       subscriber-type:
47462         type: string
47463         description: Subscriber type, a way to provide VID with only the INFRA customers.
47464       resource-version:
47465         type: string
47466         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47467       service-subscriptions:
47468         type: array
47469         items:
47470           $ref: "#/definitions/service-subscription"
47471       relationship-list:
47472         type: array
47473         items:
47474           $ref: "#/definitions/relationship"
47475   customers:
47476     description: |
47477       Collection of customer identifiers to provide linkage back to BSS information.
47478     properties:
47479       customer:
47480         type: array
47481         items:
47482           $ref: "#/definitions/customer"
47483   cvlan-tag-entry:
47484     required:
47485     - cvlan-tag
47486     properties:
47487       cvlan-tag:
47488         type: integer
47489         format: int64
47490         description: See mis-na-virtualization-platform.yang
47491       resource-version:
47492         type: string
47493         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47494       relationship-list:
47495         type: array
47496         items:
47497           $ref: "#/definitions/relationship"
47498   cvlan-tags:
47499     properties:
47500       cvlan-tag-entry:
47501         type: array
47502         items:
47503           $ref: "#/definitions/cvlan-tag-entry"
47504   dvs-switch:
47505     description: |
47506       Digital virtual switch metadata, used by SDN-C to configure VCEs.  A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
47507       ###### Related Nodes
47508       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
47509       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
47510
47511     required:
47512     - switch-name
47513     - vcenter-url
47514     properties:
47515       switch-name:
47516         type: string
47517         description: DVS switch name
47518       vcenter-url:
47519         type: string
47520         description: URL used to reach the vcenter
47521       resource-version:
47522         type: string
47523         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47524       relationship-list:
47525         type: array
47526         items:
47527           $ref: "#/definitions/relationship"
47528   dvs-switches:
47529     description: |
47530       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
47531     properties:
47532       dvs-switch:
47533         type: array
47534         items:
47535           $ref: "#/definitions/dvs-switch"
47536   edge-prop-names:
47537     description: |
47538       Internal map to define the properties of an edge and interpret the map EdgeRules
47539     properties:
47540       edgeLabel:
47541         type: string
47542       direction:
47543         type: string
47544       multiplicityRule:
47545         type: string
47546       contains-other-v:
47547         type: string
47548       delete-other-v:
47549         type: string
47550       SVC-INFRA:
47551         type: string
47552       prevent-delete:
47553         type: string
47554       aai-uuid:
47555         type: string
47556   edge-tag-query-request:
47557     properties:
47558       edge-tag:
47559         type: string
47560       result-detail:
47561         type: string
47562       start-node-type:
47563         type: string
47564       start-node-filter:
47565         type: array
47566         items:
47567           $ref: "#/definitions/start-node-filter"
47568       include-node-filter:
47569         type: array
47570         items:
47571           $ref: "#/definitions/include-node-filter"
47572       secondary-filter:
47573         type: array
47574         items:
47575           $ref: "#/definitions/secondary-filter"
47576   edge-tag-query-result:
47577     properties:
47578       tagged-inventory-item-list:
47579         type: array
47580         items:
47581           $ref: "#/definitions/tagged-inventory-item-list"
47582   element-choice-set:
47583     description: |
47584       This is how we would capture constraints defining allowed sets of elements.
47585       ###### Related Nodes
47586       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
47587       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
47588
47589       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
47590       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
47591     required:
47592     - element-choice-set-uuid
47593     - element-choice-set-name
47594     properties:
47595       element-choice-set-uuid:
47596         type: string
47597       element-choice-set-name:
47598         type: string
47599       cardinality:
47600         type: string
47601       resource-version:
47602         type: string
47603       model-elements:
47604         type: array
47605         items:
47606           $ref: "#/definitions/model-element"
47607       relationship-list:
47608         type: array
47609         items:
47610           $ref: "#/definitions/relationship"
47611   element-choice-sets:
47612     properties:
47613       element-choice-set:
47614         type: array
47615         items:
47616           $ref: "#/definitions/element-choice-set"
47617   entitlement:
47618     description: |
47619       Metadata for entitlement group.
47620       ###### Related Nodes
47621       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
47622       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
47623
47624       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
47625     required:
47626     - group-uuid
47627     - resource-uuid
47628     properties:
47629       group-uuid:
47630         type: string
47631         description: Unique ID for the entitlement group the resource comes from, should be uuid.
47632       resource-uuid:
47633         type: string
47634         description: Unique ID of an entitlement resource.
47635       resource-version:
47636         type: string
47637         description: Concurrency value
47638       relationship-list:
47639         type: array
47640         items:
47641           $ref: "#/definitions/relationship"
47642   entitlements:
47643     description: |
47644       Entitlements, keyed by group-uuid and resource-uuid, related to license management
47645     properties:
47646       entitlement:
47647         type: array
47648         items:
47649           $ref: "#/definitions/entitlement"
47650   esr-ems:
47651     description: |
47652       Persist EMS address information used by EMS driver.
47653       ###### Related Nodes
47654       - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
47655
47656       -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
47657     required:
47658     - ems-id
47659     properties:
47660       ems-id:
47661         type: string
47662         description: Unique ID of EMS.
47663       resource-version:
47664         type: string
47665         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47666       esr-system-info-list:
47667         type: object
47668         $ref: "#/definitions/esr-system-info-list"
47669       relationship-list:
47670         type: object
47671         $ref: "#/definitions/relationship-list"
47672   esr-ems-list:
47673     properties:
47674       esr-ems:
47675         type: array
47676         items:
47677           $ref: "#/definitions/esr-ems"
47678   esr-system-info:
47679     description: |
47680       Persist common address information of external systems.
47681       ###### Related Nodes
47682       - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
47683       - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
47684       - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
47685       - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
47686
47687       -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
47688     required:
47689     - esr-system-info-id
47690     - user-name
47691     - password
47692     - system-type
47693     properties:
47694       esr-system-info-id:
47695         type: string
47696         description: Unique ID of esr system info.
47697       system-name:
47698         type: string
47699         description: name of external system.
47700       type:
47701         type: string
47702         description: type of external systems.
47703       vendor:
47704         type: string
47705         description: vendor of external systems.
47706       version:
47707         type: string
47708         description: version of external systems.
47709       service-url:
47710         type: string
47711         description: url used to access external systems.
47712       user-name:
47713         type: string
47714         description: username used to access external systems.
47715       password:
47716         type: string
47717         description: password used to access external systems.
47718       system-type:
47719         type: string
47720         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
47721       protocol:
47722         type: string
47723         description: protocol of third party SDNC, for example netconf/snmp.
47724       ssl-cacert:
47725         type: string
47726         description: ca file content if enabled ssl on auth-url.
47727       ssl-insecure:
47728         type: boolean
47729         description: Whether to verify VIM's certificate.
47730       ip-address:
47731         type: string
47732         description: service IP of ftp server.
47733       port:
47734         type: string
47735         description: service port of ftp server.
47736       cloud-domain:
47737         type: string
47738         description: domain info for authentication.
47739       default-tenant:
47740         type: string
47741         description: default tenant of VIM.
47742       passive:
47743         type: boolean
47744         description: ftp passive mode or not.
47745       remote-path:
47746         type: string
47747         description: resource or performance data file path.
47748       system-status:
47749         type: string
47750         description: the status of external system.
47751       resource-version:
47752         type: string
47753         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47754       relationship-list:
47755         type: object
47756         $ref: "#/definitions/relationship-list"
47757   esr-system-info-list:
47758     description: |
47759       Collection of persistent block-level external system auth info.
47760     properties:
47761       esr-system-info:
47762         type: array
47763         items:
47764           $ref: "#/definitions/esr-system-info"
47765   esr-thirdparty-sdnc:
47766     description: |
47767       Persist SDNC address information used by ONAP SDNC.
47768       ###### Related Nodes
47769       - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
47770       - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
47771
47772       -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
47773     required:
47774     - thirdparty-sdnc-id
47775     properties:
47776       thirdparty-sdnc-id:
47777         type: string
47778         description: Unique ID of SDNC.
47779       location:
47780         type: string
47781         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
47782       product-name:
47783         type: string
47784         description: password used to access SDNC server.
47785       resource-version:
47786         type: string
47787         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47788       esr-system-info-list:
47789         type: object
47790         $ref: "#/definitions/esr-system-info-list"
47791       relationship-list:
47792         type: object
47793         $ref: "#/definitions/relationship-list"
47794   esr-thirdparty-sdnc-list:
47795     properties:
47796       esr-thirdparty-sdnc:
47797         type: array
47798         items:
47799           $ref: "#/definitions/esr-thirdparty-sdnc"
47800   esr-vnfm:
47801     description: |
47802       Persist VNFM address information used by VF-C.
47803       ###### Related Nodes
47804       - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
47805
47806       -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
47807     required:
47808     - vnfm-id
47809     properties:
47810       vnfm-id:
47811         type: string
47812         description: Unique ID of VNFM.
47813       vim-id:
47814         type: string
47815         description: indecate the VIM to deploy VNF.
47816       certificate-url:
47817         type: string
47818         description: certificate url of VNFM.
47819       resource-version:
47820         type: string
47821         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47822       esr-system-info-list:
47823         type: object
47824         $ref: "#/definitions/esr-system-info-list"
47825       relationship-list:
47826         type: object
47827         $ref: "#/definitions/relationship-list"
47828   esr-vnfm-list:
47829     properties:
47830       esr-vnfm:
47831         type: array
47832         items:
47833           $ref: "#/definitions/esr-vnfm"
47834   evc:
47835     description: |
47836       evc object is an optional child object of the Configuration object.
47837       ###### Related Nodes
47838       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
47839
47840       -(4) IF this TO node is deleted, this EVC is DELETED also
47841     required:
47842     - evc-id
47843     properties:
47844       evc-id:
47845         type: string
47846         description: Unique/key field for the evc object
47847       forwarding-path-topology:
47848         type: string
47849         description: Point-to-Point, Multi-Point
47850       cir-value:
47851         type: string
47852         description: Commited Information Rate
47853       cir-units:
47854         type: string
47855         description: CIR units
47856       connection-diversity-group-id:
47857         type: string
47858         description: Diversity Group ID
47859       service-hours:
47860         type: string
47861         description: formerly Performance Group
47862       esp-evc-circuit-id:
47863         type: string
47864         description: EVC Circuit ID of ESP EVC
47865       esp-evc-cir-value:
47866         type: string
47867         description: Committed Information Rate (For ESP)
47868       esp-evc-cir-units:
47869         type: string
47870         description: CIR units (For ESP)
47871       esp-itu-code:
47872         type: string
47873         description: Identifies ESP
47874       collector-pop-clli:
47875         type: string
47876         description: Collector POP CLLI (from the hostname of the access pnf)
47877       inter-connect-type-ingress:
47878         type: string
47879         description: Interconnect type on ingress side of EVC.
47880       tagmode-access-ingress:
47881         type: string
47882         description: tagode for collector side of EVC
47883       tagmode-access-egress:
47884         type: string
47885         description: tagMode for network side of EVC
47886       relationship-list:
47887         type: array
47888         items:
47889           $ref: "#/definitions/relationship"
47890       resource-version:
47891         type: string
47892         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47893   evcs:
47894     properties:
47895       evc:
47896         type: array
47897         items:
47898           $ref: "#/definitions/evc"
47899   external-system:
47900     description: |
47901       Namespace for external system.
47902     properties:
47903       esr-ems-list:
47904         type: object
47905         $ref: "#/definitions/esr-ems-list"
47906       esr-vnfm-list:
47907         type: object
47908         $ref: "#/definitions/esr-vnfm-list"
47909       esr-thirdparty-sdnc-list:
47910         type: object
47911         $ref: "#/definitions/esr-thirdparty-sdnc-list"
47912   extra-properties:
47913     description: |
47914       Extra properties for inventory item for response list
47915     properties:
47916       extra-property:
47917         type: array
47918         items:
47919           $ref: "#/definitions/extra-property"
47920   extra-property:
47921     properties:
47922       property-name:
47923         type: string
47924       property-value:
47925         type: string
47926   flavor:
47927     description: |
47928       Openstack flavor.
47929       ###### Related Nodes
47930       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
47931       - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)
47932       - FROM vserver( vserver Uses flavor, MANY2ONE)
47933
47934       -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
47935
47936     required:
47937     - flavor-id
47938     - flavor-name
47939     - flavor-selflink
47940     properties:
47941       flavor-id:
47942         type: string
47943         description: Flavor id, expected to be unique across cloud-region.
47944       flavor-name:
47945         type: string
47946         description: Cloud Region Flavor name
47947       flavor-vcpus:
47948         type: integer
47949         format: int32
47950         description: Number of CPUs
47951       flavor-ram:
47952         type: integer
47953         format: int32
47954         description: Amount of memory
47955       flavor-disk:
47956         type: integer
47957         format: int32
47958         description: Disk space
47959       flavor-ephemeral:
47960         type: integer
47961         format: int32
47962         description: Amount of ephemeral disk space
47963       flavor-swap:
47964         type: string
47965         description: amount of swap space allocation
47966       flavor-is-public:
47967         type: boolean
47968         description: whether flavor is available to all users or private to the tenant it was created in.
47969       flavor-selflink:
47970         type: string
47971         description: URL to endpoint where AAI can get more details
47972       flavor-disabled:
47973         type: boolean
47974         description: Boolean as to whether this flavor is no longer enabled
47975       hpa-capabilities:
47976         type: array
47977         items:
47978           $ref: "#/definitions/hpa-capability"
47979         description: List of flavor specific HPA Capabilities
47980       resource-version:
47981         type: string
47982         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47983       relationship-list:
47984         type: array
47985         items:
47986           $ref: "#/definitions/relationship"
47987   flavors:
47988     description: |
47989       Collection of openstack flavors.
47990     properties:
47991       flavor:
47992         type: array
47993         items:
47994           $ref: "#/definitions/flavor"
47995   forwarder:
47996     description: |
47997       Entity describing a sequenced segment of forwarding path
47998       ###### Related Nodes
47999       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
48000       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
48001       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
48002       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
48003       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
48004
48005       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
48006       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
48007     required:
48008     - sequence
48009     properties:
48010       sequence:
48011         type: integer
48012         format: int32
48013         description: Unique ID of this segmentation
48014       forwarder-role:
48015         type: string
48016         description: ingress, intermediate, egress
48017       relationship-list:
48018         type: array
48019         items:
48020           $ref: "#/definitions/relationship"
48021       resource-version:
48022         type: string
48023         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48024   forwarder-evc:
48025     description: |
48026       forwarder object is an optional child object of the Configuration object.
48027       ###### Related Nodes
48028       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
48029
48030       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
48031     required:
48032     - forwarder-evc-id
48033     properties:
48034       forwarder-evc-id:
48035         type: string
48036         description: Key for forwarder-evc object
48037       circuit-id:
48038         type: string
48039         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
48040       ivlan:
48041         type: string
48042         description: Internal VLAN.
48043       svlan:
48044         type: string
48045         description: SVLAN value for ingress of egress forwarder.
48046       cvlan:
48047         type: string
48048         description: CVLAN value for ingress of egress forwarder.
48049       relationship-list:
48050         type: array
48051         items:
48052           $ref: "#/definitions/relationship"
48053       resource-version:
48054         type: string
48055         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48056   forwarder-evcs:
48057     properties:
48058       forwarder-evc:
48059         type: array
48060         items:
48061           $ref: "#/definitions/forwarder-evc"
48062   forwarders:
48063     properties:
48064       forwarder:
48065         type: array
48066         items:
48067           $ref: "#/definitions/forwarder"
48068   forwarding-path:
48069     description: |
48070       Entity that describes the sequenced forwarding path between interfaces of services or resources
48071       ###### Related Nodes
48072       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
48073       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
48074       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
48075
48076       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
48077       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
48078       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
48079     required:
48080     - forwarding-path-id
48081     - forwarding-path-name
48082     properties:
48083       forwarding-path-id:
48084         type: string
48085         description: Unique ID of this FP
48086       forwarding-path-name:
48087         type: string
48088         description: Name of the FP
48089       relationship-list:
48090         type: array
48091         items:
48092           $ref: "#/definitions/relationship"
48093       resource-version:
48094         type: string
48095         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48096       selflink:
48097         type: string
48098         description: the self link for this FP
48099       forwarders:
48100         type: array
48101         items:
48102           $ref: "#/definitions/forwarder"
48103   forwarding-paths:
48104     properties:
48105       forwarding-path:
48106         type: array
48107         items:
48108           $ref: "#/definitions/forwarding-path"
48109   generic-vnf:
48110     description: |
48111       General purpose VNF
48112       ###### Related Nodes
48113       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
48114       - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
48115       - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
48116       - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
48117       - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
48118       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
48119       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
48120       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
48121       - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
48122       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
48123       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
48124       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
48125       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
48126       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
48127       - TO model-ver( generic-vnf IsA model-ver, Many2One)
48128       - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
48129       - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
48130       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
48131       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
48132       - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
48133       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
48134       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
48135       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
48136       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
48137       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
48138       - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
48139       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
48140       - FROM platform( platform Uses generic-vnf, MANY2MANY)
48141
48142       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
48143       -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
48144     required:
48145     - vnf-id
48146     - vnf-name
48147     - vnf-type
48148     - in-maint
48149     - is-closed-loop-disabled
48150     properties:
48151       vnf-id:
48152         type: string
48153         description: Unique id of VNF.  This is unique across the graph.
48154       vnf-instance-id:
48155         type: string
48156         description: vnf instance id.
48157       vnf-name:
48158         type: string
48159         description: Name of VNF.
48160       vnf-name2:
48161         type: string
48162         description: Alternate name of VNF.
48163       vnf-type:
48164         type: string
48165         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
48166       service-id:
48167         type: string
48168         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
48169       regional-resource-zone:
48170         type: string
48171         description: Regional way of organizing pservers, source of truth should define values
48172       prov-status:
48173         type: string
48174         description: Trigger for operational monitoring of this resource by Service Assurance systems.
48175       operational-status:
48176         type: string
48177         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
48178       license-key:
48179         type: string
48180         description: OBSOLETE -  do not use
48181       equipment-role:
48182         type: string
48183         description: Client should send valid enumerated value
48184       orchestration-status:
48185         type: string
48186         description: Orchestration status of this VNF, used by MSO.
48187       vnf-package-name:
48188         type: string
48189       vnf-discriptor-name:
48190         type: string
48191         description: vnf discriptor name
48192       job-id:
48193         type: string
48194         description: job id corresponding to vnf
48195       heat-stack-id:
48196         type: string
48197         description: Heat stack id corresponding to this instance, managed by MSO
48198       mso-catalog-key:
48199         type: string
48200         description: Corresponds to the SDN-C catalog id used to configure this VCE
48201       management-option:
48202         type: string
48203         description: identifier of managed by ATT or customer
48204       ipv4-oam-address:
48205         type: string
48206         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
48207       ipv4-loopback0-address:
48208         type: string
48209         description: v4 Loopback0 address
48210       nm-lan-v6-address:
48211         type: string
48212         description: v6 Loopback address
48213       management-v6-address:
48214         type: string
48215         description: v6 management address
48216       vcpu:
48217         type: integer
48218         format: int64
48219         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
48220       vcpu-units:
48221         type: string
48222         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
48223       vmemory:
48224         type: integer
48225         format: int64
48226         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
48227       vmemory-units:
48228         type: string
48229         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
48230       vdisk:
48231         type: integer
48232         format: int64
48233         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
48234       vdisk-units:
48235         type: string
48236         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
48237       nshd:
48238         type: integer
48239         format: int64
48240         description: number of associated SHD in vnf.
48241       nvm:
48242         type: integer
48243         format: int64
48244         description: number of vms in vnf.
48245       nnet:
48246         type: integer
48247         format: int64
48248         description: number of network in vnf.
48249       in-maint:
48250         type: boolean
48251         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
48252       is-closed-loop-disabled:
48253         type: boolean
48254         description: used to indicate whether closed loop function is enabled on this node
48255       resource-version:
48256         type: string
48257         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48258       summary-status:
48259         type: string
48260         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
48261       encrypted-access-flag:
48262         type: boolean
48263         description: indicates whether generic-vnf access uses SSH
48264       entitlement-assignment-group-uuid:
48265         type: string
48266         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
48267       entitlement-resource-uuid:
48268         type: string
48269         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
48270       license-assignment-group-uuid:
48271         type: string
48272         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
48273       license-key-uuid:
48274         type: string
48275         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
48276       model-invariant-id:
48277         type: string
48278         description: the ASDC model id for this resource or service model.
48279       model-version-id:
48280         type: string
48281         description: the ASDC model version for this resource or service model.
48282       persona-model-version:
48283         type: string
48284         description: the ASDC model version for this resource or service model.
48285       model-customization-id:
48286         type: string
48287         description: captures the id of all the configuration used to customize the resource for the service.
48288       widget-model-id:
48289         type: string
48290         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48291       widget-model-version:
48292         type: string
48293         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48294       as-number:
48295         type: string
48296         description: as-number of the VNF
48297       regional-resource-subzone:
48298         type: string
48299         description: represents sub zone of the rr plane
48300       nf-type:
48301         type: string
48302         description: Generic description of the type of NF
48303       nf-function:
48304         type: string
48305         description: English description of Network function that the specific VNF deployment is providing
48306       nf-role:
48307         type: string
48308         description: role in the network that this model will be providing
48309       nf-naming-code:
48310         type: string
48311         description: string assigned to this model used for naming purposes
48312       selflink:
48313         type: string
48314         description: Path to the controller object.
48315       ipv4-oam-gateway-address:
48316         type: string
48317         description: Gateway address
48318       ipv4-oam-gateway-address-prefix-length:
48319         type: integer
48320         format: int32
48321         description: Prefix length for oam-address
48322       vlan-id-outer:
48323         type: integer
48324         format: int64
48325         description: Temporary location for S-TAG to get to VCE
48326       nm-profile-name:
48327         type: string
48328         description: Network Management profile of this VNF
48329       relationship-list:
48330         type: array
48331         items:
48332           $ref: "#/definitions/relationship"
48333       l-interfaces:
48334         type: array
48335         items:
48336           $ref: "#/definitions/l-interface"
48337       lag-interfaces:
48338         type: array
48339         items:
48340           $ref: "#/definitions/lag-interface"
48341       vf-modules:
48342         type: array
48343         items:
48344           $ref: "#/definitions/vf-module"
48345       licenses:
48346         type: array
48347         items:
48348           $ref: "#/definitions/license"
48349       entitlements:
48350         type: array
48351         items:
48352           $ref: "#/definitions/entitlement"
48353   generic-vnfs:
48354     description: |
48355       Collection of VNFs
48356     properties:
48357       generic-vnf:
48358         type: array
48359         items:
48360           $ref: "#/definitions/generic-vnf"
48361   group-assignment:
48362     description: |
48363       Openstack group-assignment used to store exclusivity groups (EG).
48364       ###### Related Nodes
48365       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
48366       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
48367       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
48368
48369     required:
48370     - group-id
48371     - group-type
48372     - group-name
48373     properties:
48374       group-id:
48375         type: string
48376         description: Group id, expected to be unique across cloud-region.
48377       group-type:
48378         type: string
48379         description: Group type - the type of group this instance refers to
48380       group-name:
48381         type: string
48382         description: Group name - name assigned to the group
48383       group-description:
48384         type: string
48385         description: Group description - description of the group
48386       resource-version:
48387         type: string
48388         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48389       relationship-list:
48390         type: array
48391         items:
48392           $ref: "#/definitions/relationship"
48393   group-assignments:
48394     description: |
48395       Collection of openstack group assignments
48396     properties:
48397       group-assignment:
48398         type: array
48399         items:
48400           $ref: "#/definitions/group-assignment"
48401   host-route:
48402     description: |
48403       ###### Related Nodes
48404       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
48405
48406       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
48407     required:
48408     - host-route-id
48409     - route-prefix
48410     - next-hop
48411     properties:
48412       host-route-id:
48413         type: string
48414         description: host-route id
48415       route-prefix:
48416         type: string
48417         description: subnet prefix
48418       next-hop:
48419         type: string
48420         description: Could be ip-address, hostname, or service-instance
48421       next-hop-type:
48422         type: string
48423         description: Should be ip-address, hostname, or service-instance to match next-hop
48424       resource-version:
48425         type: string
48426         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48427       relationship-list:
48428         type: array
48429         items:
48430           $ref: "#/definitions/relationship"
48431   host-routes:
48432     properties:
48433       host-route:
48434         type: array
48435         items:
48436           $ref: "#/definitions/host-route"
48437   hpa-capabilities:
48438     description: |
48439       Collection of HPA Capabilities
48440     properties:
48441       hpa-capability:
48442         type: array
48443         items:
48444           $ref: "#/definitions/hpa-capability"
48445   hpa-capability:
48446     description: |
48447       Represents a HPA capability
48448       ###### Related Nodes
48449       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
48450       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
48451       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
48452
48453       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
48454     required:
48455     - hpa-capability-id
48456     - hpa-feature
48457     properties:
48458       hpa-capability-id:
48459         type: string
48460         description: UUID to uniquely identify a HPA capability
48461       hpa-feature:
48462         type: string
48463         description: Name of the HPACapability
48464       hpa-version:
48465         type: string
48466         description: HPA schema version
48467       architecture:
48468         type: string
48469         description: Hardware architecture
48470       resource-version:
48471         type: string
48472         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48473       relationship-list:
48474         type: array
48475         items:
48476           $ref: "#/definitions/relationship"
48477       hpa-feature-attributes:
48478         type: array
48479         items:
48480           $ref: "#/definitions/hpa-feature-attributes"
48481   hpa-feature-attributes:
48482     description: |
48483       HPA Capability Feature attributes
48484       ###### Related Nodes
48485       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
48486
48487       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
48488     required:
48489     - hpa-attribute-key
48490     properties:
48491       hpa-attribute-key:
48492         type: string
48493         description: name of the specific HPA attribute
48494       hpa-attribute-value:
48495         type: string
48496         description: JSON string specifying the value, unit and type of the specific HPA attribute
48497       resource-version:
48498         type: string
48499         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48500       relationship-list:
48501         type: array
48502         items:
48503           $ref: "#/definitions/relationship"
48504   image:
48505     description: |
48506       Openstack image.
48507       ###### Related Nodes
48508       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
48509       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
48510       - FROM vserver( vserver Uses image, MANY2ONE)
48511
48512       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
48513       -IMAGE cannot be deleted if related to VSERVER
48514
48515     required:
48516     - image-id
48517     - image-name
48518     - image-os-distro
48519     - image-os-version
48520     - image-selflink
48521     properties:
48522       image-id:
48523         type: string
48524         description: Image id, expected to be unique across cloud region
48525       image-name:
48526         type: string
48527         description: Image name
48528       image-architecture:
48529         type: string
48530         description: Operating system architecture.
48531       image-os-distro:
48532         type: string
48533         description: The common name of the operating system distribution in lowercase
48534       image-os-version:
48535         type: string
48536         description: The operating system version as specified by the distributor.
48537       application:
48538         type: string
48539         description: The application that the image instantiates.
48540       application-vendor:
48541         type: string
48542         description: The vendor of the application.
48543       application-version:
48544         type: string
48545         description: The version of the application.
48546       image-selflink:
48547         type: string
48548         description: URL to endpoint where AAI can get more details
48549       resource-version:
48550         type: string
48551         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48552       relationship-list:
48553         type: array
48554         items:
48555           $ref: "#/definitions/relationship"
48556       metadata:
48557         type: array
48558         items:
48559           $ref: "#/definitions/metadatum"
48560   images:
48561     description: |
48562       Collectio of Openstack images.
48563     properties:
48564       image:
48565         type: array
48566         items:
48567           $ref: "#/definitions/image"
48568   include-node-filter:
48569     properties:
48570       include-node-type:
48571         type: string
48572   instance-filter:
48573     description: |
48574       InstanceFilter for performing a named-query or model query
48575   instance-filters:
48576     description: |
48577       InstanceFilters for performing a named-query or model query
48578     properties:
48579       instance-filter:
48580         type: array
48581         items:
48582           $ref: "#/definitions/instance-filter"
48583   instance-group:
48584     description: |
48585       General mechanism for grouping instances
48586       ###### Related Nodes
48587       - TO model( instance-group Targets model, MANY2MANY)
48588       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
48589       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
48590       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
48591       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
48592       - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
48593       - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
48594       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
48595       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
48596       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
48597       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
48598       - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
48599
48600     required:
48601     - id
48602     - description
48603     - type
48604     properties:
48605       instance-group-role:
48606         type: string
48607         description: role of the instance group.
48608       model-invariant-id:
48609         type: string
48610         description: ASDC model id for this resource or service model.
48611       model-version-id:
48612         type: string
48613         description: ASDC model version uid for this resource model.
48614       id:
48615         type: string
48616         description: Instance Group ID, UUID assigned to this instance.
48617       description:
48618         type: string
48619         description: Descriptive text to help identify the usage of this instance-group
48620       type:
48621         type: string
48622         description: Only valid value today is lower case ha for high availability
48623       sub-type:
48624         type: string
48625         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
48626       resource-version:
48627         type: string
48628         description: Concurrency value
48629       relationship-list:
48630         type: array
48631         items:
48632           $ref: "#/definitions/relationship"
48633   instance-groups:
48634     description: |
48635       Collection of openstack route table references
48636     properties:
48637       instance-group:
48638         type: array
48639         items:
48640           $ref: "#/definitions/instance-group"
48641   inventory:
48642     properties:
48643       search:
48644         type: object
48645         $ref: "#/definitions/search"
48646       actions:
48647         type: object
48648         $ref: "#/definitions/actions"
48649       cloud-infrastructure:
48650         type: object
48651         $ref: "#/definitions/cloud-infrastructure"
48652       external-system:
48653         type: object
48654         $ref: "#/definitions/external-system"
48655       business:
48656         type: object
48657         $ref: "#/definitions/business"
48658       service-design-and-creation:
48659         type: object
48660         $ref: "#/definitions/service-design-and-creation"
48661       network:
48662         type: object
48663         $ref: "#/definitions/network"
48664       nodes:
48665         type: object
48666         $ref: "#/definitions/nodes"
48667   inventory-item:
48668     properties:
48669       inventory-item-type:
48670         type: string
48671       inventory-item-link:
48672         type: string
48673       inventory-item-data:
48674         type: array
48675         items:
48676           $ref: "#/definitions/inventory-item-data"
48677       tagged-inventory-item-list:
48678         type: array
48679         items:
48680           $ref: "#/definitions/tagged-inventory-item-list"
48681   inventory-item-data:
48682     properties:
48683       property-name:
48684         type: string
48685       property-value:
48686         type: string
48687   inventory-response-item:
48688     description: |
48689       Inventory item for response list
48690     properties:
48691       model-name:
48692         type: string
48693       extra-properties:
48694         type: object
48695         $ref: "#/definitions/extra-properties"
48696       inventory-response-items:
48697         type: object
48698         $ref: "#/definitions/inventory-response-items"
48699   inventory-response-items:
48700     description: |
48701       Container for inventory items in response list
48702     properties:
48703       inventory-response-item:
48704         type: array
48705         items:
48706           $ref: "#/definitions/inventory-response-item"
48707   ipsec-configuration:
48708     description: |
48709       IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
48710       ###### Related Nodes
48711       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
48712       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
48713
48714       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
48715     required:
48716     - ipsec-configuration-id
48717     properties:
48718       ipsec-configuration-id:
48719         type: string
48720         description: UUID of this configuration
48721       requested-vig-address-type:
48722         type: string
48723         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
48724       requested-encryption-strength:
48725         type: string
48726         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
48727       requested-dmz-type:
48728         type: string
48729         description: ATT can offer a shared DMZ or a DMZ specific to a customer
48730       shared-dmz-network-address:
48731         type: string
48732         description: Network address of shared DMZ
48733       requested-customer-name:
48734         type: string
48735         description: If the DMZ is a custom DMZ, this field will indicate the customer information
48736       ike-version:
48737         type: string
48738         description: can be 1 or 2
48739       ikev1-authentication:
48740         type: string
48741         description: Contains values like md5, sha1, sha256, sha384
48742       ikev1-encryption:
48743         type: string
48744         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
48745       ikev1-dh-group:
48746         type: string
48747         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
48748       ikev1-am-group-id:
48749         type: string
48750         description: Group name defined in VIG for clients using aggressive mode
48751       ikev1-am-password:
48752         type: string
48753         description: pre-shared key for the above group name
48754       ikev1-sa-lifetime:
48755         type: string
48756         description: Lifetime for IKEv1 SA
48757       ipsec-authentication:
48758         type: string
48759         description: md5, sha1, sha256, sha384
48760       ipsec-encryption:
48761         type: string
48762         description: 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
48763       ipsec-sa-lifetime:
48764         type: string
48765         description: Life time for IPSec SA
48766       ipsec-pfs:
48767         type: string
48768         description: enable PFS or not
48769       xauth-userid:
48770         type: string
48771         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
48772       xauth-user-password:
48773         type: string
48774         description: Encrypted using the Juniper $9$ algorithm
48775       dpd-interval:
48776         type: string
48777         description: The time between DPD probe
48778       dpd-frequency:
48779         type: string
48780         description: Maximum number of DPD before claiming the tunnel is down
48781       resource-version:
48782         type: string
48783         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48784       relationship-list:
48785         type: array
48786         items:
48787           $ref: "#/definitions/relationship"
48788       vig-servers:
48789         type: array
48790         items:
48791           $ref: "#/definitions/vig-server"
48792   ipsec-configurations:
48793     properties:
48794       ipsec-configuration:
48795         type: array
48796         items:
48797           $ref: "#/definitions/ipsec-configuration"
48798   key-data:
48799     properties:
48800       key-name:
48801         type: string
48802       key-value:
48803         type: string
48804   l-interface:
48805     description: |
48806       Logical interfaces, e.g., a vnic.
48807       ###### Related Nodes
48808       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
48809       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
48810       - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
48811       - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
48812       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
48813       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
48814       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
48815       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
48816       - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
48817       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
48818       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
48819       - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)
48820       - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)
48821       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
48822       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
48823       - FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
48824       - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)
48825       - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
48826
48827       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
48828       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
48829       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
48830     required:
48831     - interface-name
48832     - is-port-mirrored
48833     - in-maint
48834     - is-ip-unnumbered
48835     properties:
48836       interface-name:
48837         type: string
48838         description: Name given to the interface
48839       interface-role:
48840         type: string
48841         description: E.g., CUSTOMER, UPLINK, etc.
48842       v6-wan-link-ip:
48843         type: string
48844         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
48845       selflink:
48846         type: string
48847         description: URL to endpoint where AAI can get more details
48848       interface-id:
48849         type: string
48850         description: ID of interface
48851       macaddr:
48852         type: string
48853         description: MAC address for the interface
48854       network-name:
48855         type: string
48856         description: Name of the network
48857       management-option:
48858         type: string
48859         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
48860       interface-description:
48861         type: string
48862         description: Human friendly text regarding this interface.
48863       is-port-mirrored:
48864         type: boolean
48865         description: boolean indicatating whether or not port is a mirrored.
48866       resource-version:
48867         type: string
48868         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48869       in-maint:
48870         type: boolean
48871         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
48872       prov-status:
48873         type: string
48874         description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
48875       is-ip-unnumbered:
48876         type: boolean
48877         description: Flag indicating the interface uses the IP Unnumbered configuration.
48878       allowed-address-pairs:
48879         type: string
48880         description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
48881       vlans:
48882         type: array
48883         items:
48884           $ref: "#/definitions/vlan"
48885       sriov-vfs:
48886         type: array
48887         items:
48888           $ref: "#/definitions/sriov-vf"
48889       l-interfaces:
48890         type: array
48891         items:
48892           $ref: "#/definitions/l-interface"
48893       relationship-list:
48894         type: array
48895         items:
48896           $ref: "#/definitions/relationship"
48897       l3-interface-ipv4-address-list:
48898         type: array
48899         items:
48900           $ref: "#/definitions/l3-interface-ipv4-address-list"
48901       l3-interface-ipv6-address-list:
48902         type: array
48903         items:
48904           $ref: "#/definitions/l3-interface-ipv6-address-list"
48905   l-interfaces:
48906     description: |
48907       Collection of logical interfaces.
48908     properties:
48909       l-interface:
48910         type: array
48911         items:
48912           $ref: "#/definitions/l-interface"
48913   l3-interface-ipv4-address-list:
48914     description: |
48915       IPv4 Address Range
48916       ###### Related Nodes
48917       - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
48918       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
48919       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
48920       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
48921       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
48922       - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
48923
48924       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
48925     required:
48926     - l3-interface-ipv4-address
48927     properties:
48928       l3-interface-ipv4-address:
48929         type: string
48930         description: IP address
48931       l3-interface-ipv4-prefix-length:
48932         type: integer
48933         format: int64
48934         description: Prefix length, 32 for single address
48935       vlan-id-inner:
48936         type: integer
48937         format: int64
48938         description: Inner VLAN tag
48939       vlan-id-outer:
48940         type: integer
48941         format: int64
48942         description: Outer VLAN tag
48943       is-floating:
48944         type: boolean
48945         description: Indicator of fixed or floating address
48946       resource-version:
48947         type: string
48948         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48949       neutron-network-id:
48950         type: string
48951         description: Neutron network id of the interface that address belongs to
48952       neutron-subnet-id:
48953         type: string
48954         description: Neutron id of subnet that address belongs to
48955       relationship-list:
48956         type: array
48957         items:
48958           $ref: "#/definitions/relationship"
48959   l3-interface-ipv6-address-list:
48960     description: |
48961       IPv6 Address Range
48962       ###### Related Nodes
48963       - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
48964       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
48965       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
48966       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
48967       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
48968       - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
48969
48970       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
48971     required:
48972     - l3-interface-ipv6-address
48973     properties:
48974       l3-interface-ipv6-address:
48975         type: string
48976         description: IP address
48977       l3-interface-ipv6-prefix-length:
48978         type: integer
48979         format: int64
48980         description: Prefix length, 128 for single address
48981       vlan-id-inner:
48982         type: integer
48983         format: int64
48984         description: Inner VLAN tag
48985       vlan-id-outer:
48986         type: integer
48987         format: int64
48988         description: Outer VLAN tag
48989       is-floating:
48990         type: boolean
48991         description: Indicator of fixed or floating address
48992       resource-version:
48993         type: string
48994         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48995       neutron-network-id:
48996         type: string
48997         description: Neutron network id of the interface that address belongs to
48998       neutron-subnet-id:
48999         type: string
49000         description: Neutron id of subnet that address belongs to
49001       relationship-list:
49002         type: array
49003         items:
49004           $ref: "#/definitions/relationship"
49005   l3-network:
49006     description: |
49007       Generic network definition
49008       ###### Related Nodes
49009       - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
49010       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
49011       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
49012       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
49013       - TO model-ver( l3-network IsA model-ver, Many2One)
49014       - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
49015       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
49016       - FROM complex( complex Uses l3-network, MANY2MANY)
49017       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
49018       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
49019       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
49020       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
49021       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
49022       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
49023       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
49024       - FROM tenant( tenant Uses l3-network, MANY2MANY)
49025       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
49026
49027       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
49028     required:
49029     - network-id
49030     - network-name
49031     - is-bound-to-vpn
49032     - is-provider-network
49033     - is-shared-network
49034     - is-external-network
49035     properties:
49036       network-id:
49037         type: string
49038         description: Network ID, should be uuid. Unique across A&AI.
49039       network-name:
49040         type: string
49041         description: Name of the network, governed by some naming convention..
49042       network-type:
49043         type: string
49044         description: Type of the network - who defines these values?
49045       network-role:
49046         type: string
49047         description: Role the network plans - who defines these values?
49048       network-technology:
49049         type: string
49050         description: Network technology - who defines these values?
49051       neutron-network-id:
49052         type: string
49053         description: Neutron network id of this Interface
49054       is-bound-to-vpn:
49055         type: boolean
49056         description: Set to true if bound to VPN
49057       service-id:
49058         type: string
49059         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
49060       network-role-instance:
49061         type: integer
49062         format: int64
49063         description: network role instance
49064       resource-version:
49065         type: string
49066         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49067       orchestration-status:
49068         type: string
49069         description: Orchestration status of this VNF, mastered by MSO
49070       heat-stack-id:
49071         type: string
49072         description: Heat stack id corresponding to this instance, managed by MSO
49073       mso-catalog-key:
49074         type: string
49075         description: Corresponds to the SDN-C catalog id used to configure this VCE
49076       contrail-network-fqdn:
49077         type: string
49078         description: Contrail FQDN for the network
49079       model-invariant-id:
49080         type: string
49081         description: the ASDC model id for this resource or service model.
49082       model-version-id:
49083         type: string
49084         description: the ASDC model version for this resource or service model.
49085       persona-model-version:
49086         type: string
49087         description: the ASDC model version for this resource or service model.
49088       model-customization-id:
49089         type: string
49090         description: captures the id of all the configuration used to customize the resource for the service.
49091       widget-model-id:
49092         type: string
49093         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49094       widget-model-version:
49095         type: string
49096         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49097       physical-network-name:
49098         type: string
49099         description: Name associated with the physical network.
49100       is-provider-network:
49101         type: boolean
49102         description: boolean indicatating whether or not network is a provider network.
49103       is-shared-network:
49104         type: boolean
49105         description: boolean indicatating whether or not network is a shared network.
49106       is-external-network:
49107         type: boolean
49108         description: boolean indicatating whether or not network is an external network.
49109       selflink:
49110         type: string
49111         description: Path to the controller object.
49112       operational-status:
49113         type: string
49114         description: Indicator for whether the resource is considered operational.
49115       subnets:
49116         type: array
49117         items:
49118           $ref: "#/definitions/subnet"
49119       ctag-assignments:
49120         type: array
49121         items:
49122           $ref: "#/definitions/ctag-assignment"
49123       segmentation-assignments:
49124         type: array
49125         items:
49126           $ref: "#/definitions/segmentation-assignment"
49127       relationship-list:
49128         type: array
49129         items:
49130           $ref: "#/definitions/relationship"
49131         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
49132   l3-networks:
49133     properties:
49134       l3-network:
49135         type: array
49136         items:
49137           $ref: "#/definitions/l3-network"
49138   lag-interface:
49139     description: |
49140       Link aggregate interface
49141       ###### Related Nodes
49142       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
49143       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
49144       - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
49145       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
49146       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
49147       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
49148       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
49149       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
49150       - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)
49151
49152       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
49153       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
49154       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
49155     required:
49156     - interface-name
49157     - in-maint
49158     properties:
49159       interface-name:
49160         type: string
49161         description: Name that identifies the link aggregate interface
49162       interface-description:
49163         type: string
49164         description: Human friendly text regarding this interface.
49165       resource-version:
49166         type: string
49167         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49168       speed-value:
49169         type: string
49170         description: Captures the numeric part of the speed
49171       speed-units:
49172         type: string
49173         description: Captures the units corresponding to the speed
49174       interface-id:
49175         type: string
49176         description: ID of interface
49177       interface-role:
49178         type: string
49179         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49180       prov-status:
49181         type: string
49182         description: Trigger for operational monitoring of this resource by Service Assurance systems.
49183       in-maint:
49184         type: boolean
49185         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
49186       relationship-list:
49187         type: array
49188         items:
49189           $ref: "#/definitions/relationship"
49190       l-interfaces:
49191         type: array
49192         items:
49193           $ref: "#/definitions/l-interface"
49194   lag-interfaces:
49195     description: |
49196       Collection of link aggregate interfaces.
49197     properties:
49198       lag-interface:
49199         type: array
49200         items:
49201           $ref: "#/definitions/lag-interface"
49202   lag-link:
49203     description: |
49204       LAG links can connect lag-interfaces
49205       ###### Related Nodes
49206       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
49207       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
49208
49209       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
49210     required:
49211     - link-name
49212     properties:
49213       link-name:
49214         type: string
49215         description: Alphabetical concatenation of lag-interface names
49216       resource-version:
49217         type: string
49218         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49219       relationship-list:
49220         type: array
49221         items:
49222           $ref: "#/definitions/relationship"
49223   lag-links:
49224     description: |
49225       Collection of link aggregation connections
49226     properties:
49227       lag-link:
49228         type: array
49229         items:
49230           $ref: "#/definitions/lag-link"
49231   license:
49232     description: |
49233       Metadata for license group.
49234       ###### Related Nodes
49235       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
49236       - TO vce( license BelongsTo vce, MANY2ONE)(4)
49237
49238       -(4) IF this TO node is deleted, this LICENSE is DELETED also
49239     required:
49240     - group-uuid
49241     - resource-uuid
49242     properties:
49243       group-uuid:
49244         type: string
49245         description: Unique ID for the license group the resource belongs to, should be uuid.
49246       resource-uuid:
49247         type: string
49248         description: Unique ID of a license resource.
49249       resource-version:
49250         type: string
49251         description: Concurrency value
49252       relationship-list:
49253         type: array
49254         items:
49255           $ref: "#/definitions/relationship"
49256   licenses:
49257     description: |
49258       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
49259     properties:
49260       license:
49261         type: array
49262         items:
49263           $ref: "#/definitions/license"
49264   line-of-business:
49265     description: |
49266       describes a line-of-business
49267       ###### Related Nodes
49268       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
49269
49270     required:
49271     - line-of-business-name
49272     properties:
49273       line-of-business-name:
49274         type: string
49275         description: Name of the line-of-business (product)
49276       resource-version:
49277         type: string
49278         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49279       relationship-list:
49280         type: array
49281         items:
49282           $ref: "#/definitions/relationship"
49283   lines-of-business:
49284     description: |
49285       Collection of lines-of-business
49286     properties:
49287       line-of-business:
49288         type: array
49289         items:
49290           $ref: "#/definitions/line-of-business"
49291   logical-link:
49292     description: |
49293       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
49294       ###### Related Nodes
49295       - TO l-interface( logical-link Source l-interface, ONE2MANY)(4)
49296       - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)
49297       - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
49298       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
49299       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
49300       - TO logical-link( logical-link Uses logical-link, MANY2MANY)
49301       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
49302       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
49303       - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
49304       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
49305       - TO model-ver( logical-link IsA model-ver, Many2One)
49306       - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
49307       - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
49308       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
49309       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
49310       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
49311       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
49312       - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
49313
49314       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
49315       -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also
49316     required:
49317     - link-name
49318     - in-maint
49319     - link-type
49320     properties:
49321       link-name:
49322         type: string
49323         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
49324       in-maint:
49325         type: boolean
49326         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
49327       link-type:
49328         type: string
49329         description: Type of logical link, e.g., evc
49330       speed-value:
49331         type: string
49332         description: Captures the numeric part of the speed
49333       speed-units:
49334         type: string
49335         description: Captures the units corresponding to the speed
49336       ip-version:
49337         type: string
49338         description: v4, v6, or ds for dual stack
49339       routing-protocol:
49340         type: string
49341         description: For example, static or BGP
49342       resource-version:
49343         type: string
49344         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49345       model-invariant-id:
49346         type: string
49347         description: the ASDC model id for this resource or service model.
49348       model-version-id:
49349         type: string
49350         description: the ASDC model version for this resource or service model.
49351       persona-model-version:
49352         type: string
49353         description: the ASDC model version for this resource or service model.
49354       widget-model-id:
49355         type: string
49356         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49357       widget-model-version:
49358         type: string
49359         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49360       operational-status:
49361         type: string
49362         description: Indication of operational status of the logical link.
49363       prov-status:
49364         type: string
49365         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
49366       link-role:
49367         type: string
49368         description: Indication of the network use of the logical link.
49369       link-name2:
49370         type: string
49371         description: Alias or alternate name (CLCI or D1 name).
49372       link-id:
49373         type: string
49374         description: UUID of the logical-link, SDNC generates this.
49375       circuit-id:
49376         type: string
49377         description: Circuit id
49378       purpose:
49379         type: string
49380         description: Reason for this entity, role it is playing
49381       relationship-list:
49382         type: array
49383         items:
49384           $ref: "#/definitions/relationship"
49385   logical-links:
49386     description: |
49387       Collection of logical connections
49388     properties:
49389       logical-link:
49390         type: array
49391         items:
49392           $ref: "#/definitions/logical-link"
49393   metadata:
49394     description: |
49395       Collection of metadatum (key/value pairs)
49396     properties:
49397       metadatum:
49398         type: array
49399         items:
49400           $ref: "#/definitions/metadatum"
49401   metadatum:
49402     description: |
49403       Key/value pairs
49404       ###### Related Nodes
49405       - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
49406       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
49407       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
49408       - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
49409       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
49410
49411       -(4) IF this TO node is deleted, this METADATUM is DELETED also
49412     required:
49413     - metaname
49414     - metaval
49415     properties:
49416       metaname:
49417         type: string
49418       metaval:
49419         type: string
49420       resource-version:
49421         type: string
49422         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49423   model:
49424     description: |
49425       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
49426       ###### Related Nodes
49427       - TO model( model-ver BelongsTo model, MANY2ONE)(1)
49428       - FROM instance-group( instance-group Targets model, MANY2MANY)
49429       - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
49430       - FROM named-query( named-query AppliesTo model, ONE2MANY)
49431       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
49432
49433       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
49434       -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
49435
49436     required:
49437     - model-invariant-id
49438     - model-type
49439     properties:
49440       model-invariant-id:
49441         type: string
49442         description: Unique identifier corresponding to the main definition of a model in ASDC
49443       model-type:
49444         type: string
49445         description: Type of the model, e.g., service, resource, widget, etc.
49446       resource-version:
49447         type: string
49448         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49449       model-vers:
49450         type: array
49451         items:
49452           $ref: "#/definitions/model-ver"
49453       relationship-list:
49454         type: array
49455         items:
49456           $ref: "#/definitions/relationship"
49457   model-and-named-query-search:
49458     description: |
49459       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
49460     properties:
49461       query-parameters:
49462         type: object
49463         $ref: "#/definitions/query-parameters"
49464       instance-filters:
49465         type: object
49466         $ref: "#/definitions/instance-filters"
49467       secondary-filts:
49468         type: object
49469         $ref: "#/definitions/secondary-filts"
49470       top-node-type:
49471         type: string
49472       secondary-filter-cut-point:
49473         type: string
49474   model-constraint:
49475     description: |
49476       This is how we would capture constraints defining allowed sets of elements.
49477       ###### Related Nodes
49478       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
49479       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
49480
49481       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
49482       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
49483     required:
49484     - model-constraint-uuid
49485     - constrained-element-set-uuid-to-replace
49486     properties:
49487       model-constraint-uuid:
49488         type: string
49489       constrained-element-set-uuid-to-replace:
49490         type: string
49491       constrained-element-sets:
49492         type: array
49493         items:
49494           $ref: "#/definitions/constrained-element-set"
49495       resource-version:
49496         type: string
49497         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49498   model-constraints:
49499     properties:
49500       model-constraint:
49501         type: array
49502         items:
49503           $ref: "#/definitions/model-constraint"
49504   model-element:
49505     description: |
49506       Defines how other models combine to make up a higher-level model.
49507       ###### Related Nodes
49508       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
49509       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
49510       - TO model-ver( model-element IsA model-ver, MANY2ONE)
49511       - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
49512       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
49513       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
49514       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
49515
49516       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
49517       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
49518     required:
49519     - model-element-uuid
49520     - new-data-del-flag
49521     - cardinality
49522     properties:
49523       model-element-uuid:
49524         type: string
49525       new-data-del-flag:
49526         type: string
49527         description: Indicates whether this element was created as part of instantiation from this model
49528       cardinality:
49529         type: string
49530         description: How many of this type of element are required/allowed
49531       linkage-points:
49532         type: string
49533       resource-version:
49534         type: string
49535         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49536       model-elements:
49537         type: array
49538         items:
49539           $ref: "#/definitions/model-element"
49540         description: Defines how other models combine to make up a higher-level model
49541       model-constraints:
49542         type: array
49543         items:
49544           $ref: "#/definitions/model-constraint"
49545         description: Describes new constraints on this model element that are not part of that model's definition
49546       relationship-list:
49547         type: array
49548         items:
49549           $ref: "#/definitions/relationship"
49550   model-elements:
49551     properties:
49552       model-element:
49553         type: array
49554         items:
49555           $ref: "#/definitions/model-element"
49556   model-ver:
49557     description: |
49558       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
49559       ###### Related Nodes
49560       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
49561       - FROM model-element( model-element IsA model-ver, MANY2ONE)
49562       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
49563       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
49564       - FROM allotted-resource( allotted-resource IsA model-ver, Many2One)
49565       - FROM generic-vnf( generic-vnf IsA model-ver, Many2One)
49566       - FROM l3-network( l3-network IsA model-ver, Many2One)
49567       - FROM logical-link( logical-link IsA model-ver, Many2One)
49568       - FROM service-instance( service-instance IsA model-ver, Many2One)
49569       - FROM vf-module( vf-module IsA model-ver, Many2One)
49570
49571       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
49572       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
49573       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
49574
49575     required:
49576     - model-version-id
49577     - model-name
49578     - model-version
49579     properties:
49580       model-version-id:
49581         type: string
49582         description: Unique identifier corresponding to one version of a model in ASDC
49583       model-name:
49584         type: string
49585         description: Name of the model, which can change from version to version.
49586       model-version:
49587         type: string
49588         description: Version
49589       distribution-status:
49590         type: string
49591         description: Distribution Status
49592       model-description:
49593         type: string
49594         description: Description
49595       resource-version:
49596         type: string
49597         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49598       model-elements:
49599         type: array
49600         items:
49601           $ref: "#/definitions/model-element"
49602       metadata:
49603         type: array
49604         items:
49605           $ref: "#/definitions/metadatum"
49606       relationship-list:
49607         type: array
49608         items:
49609           $ref: "#/definitions/relationship"
49610   model-vers:
49611     properties:
49612       model-ver:
49613         type: array
49614         items:
49615           $ref: "#/definitions/model-ver"
49616   models:
49617     description: |
49618       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
49619     properties:
49620       model:
49621         type: array
49622         items:
49623           $ref: "#/definitions/model"
49624   multicast-configuration:
49625     description: |
49626       ###### Related Nodes
49627       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
49628
49629     required:
49630     - multicast-configuration-id
49631     - multicast-protocol
49632     - rp-type
49633     properties:
49634       multicast-configuration-id:
49635         type: string
49636         description: Unique id of multicast configuration.
49637       multicast-protocol:
49638         type: string
49639         description: protocol of multicast configuration
49640       rp-type:
49641         type: string
49642         description: rp type of multicast configuration
49643       resource-version:
49644         type: string
49645         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49646       relationship-list:
49647         type: array
49648         items:
49649           $ref: "#/definitions/relationship"
49650   multicast-configurations:
49651     description: |
49652       multicast configuration of generic-vnf ip-address
49653     properties:
49654       multicast-configuration:
49655         type: array
49656         items:
49657           $ref: "#/definitions/multicast-configuration"
49658   named-queries:
49659     properties:
49660       named-query:
49661         type: array
49662         items:
49663           $ref: "#/definitions/named-query"
49664   named-query:
49665     description: |
49666       TBD
49667       ###### Related Nodes
49668       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
49669       - TO model( named-query AppliesTo model, ONE2MANY)
49670       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
49671
49672       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
49673     required:
49674     - named-query-uuid
49675     - named-query-name
49676     - named-query-version
49677     properties:
49678       named-query-uuid:
49679         type: string
49680       named-query-name:
49681         type: string
49682       named-query-version:
49683         type: string
49684       required-input-param:
49685         type: string
49686       description:
49687         type: string
49688       resource-version:
49689         type: string
49690       named-query-elements:
49691         type: array
49692         items:
49693           $ref: "#/definitions/named-query-element"
49694       relationship-list:
49695         type: array
49696         items:
49697           $ref: "#/definitions/relationship"
49698   named-query-element:
49699     description: |
49700       TBD
49701       ###### Related Nodes
49702       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
49703       - TO model( named-query-element IsA model, MANY2ONE)
49704       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
49705       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
49706       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
49707       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
49708
49709       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
49710       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
49711     required:
49712     - named-query-element-uuid
49713     properties:
49714       named-query-element-uuid:
49715         type: string
49716       property-collect-list:
49717         type: string
49718       resource-version:
49719         type: string
49720       property-limit-desc:
49721         type: string
49722       do-not-output:
49723         type: string
49724       named-query-elements:
49725         type: array
49726         items:
49727           $ref: "#/definitions/named-query-element"
49728       related-lookups:
49729         type: array
49730         items:
49731           $ref: "#/definitions/related-lookup"
49732       property-constraints:
49733         type: array
49734         items:
49735           $ref: "#/definitions/property-constraint"
49736       relationship-list:
49737         type: array
49738         items:
49739           $ref: "#/definitions/relationship"
49740   named-query-elements:
49741     properties:
49742       named-query-element:
49743         type: array
49744         items:
49745           $ref: "#/definitions/named-query-element"
49746   network:
49747     description: |
49748       Namespace for network inventory resources.
49749     properties:
49750       logical-links:
49751         type: array
49752         items:
49753           $ref: "#/definitions/logical-link"
49754       site-pair-sets:
49755         type: array
49756         items:
49757           $ref: "#/definitions/site-pair-set"
49758       vpn-bindings:
49759         type: array
49760         items:
49761           $ref: "#/definitions/vpn-binding"
49762       vpls-pes:
49763         type: array
49764         items:
49765           $ref: "#/definitions/vpls-pe"
49766       multicast-configurations:
49767         type: array
49768         items:
49769           $ref: "#/definitions/multicast-configuration"
49770       vces:
49771         type: array
49772         items:
49773           $ref: "#/definitions/vce"
49774       vnfcs:
49775         type: array
49776         items:
49777           $ref: "#/definitions/vnfc"
49778       l3-networks:
49779         type: array
49780         items:
49781           $ref: "#/definitions/l3-network"
49782       network-policies:
49783         type: array
49784         items:
49785           $ref: "#/definitions/network-policy"
49786       generic-vnfs:
49787         type: array
49788         items:
49789           $ref: "#/definitions/generic-vnf"
49790       lag-links:
49791         type: array
49792         items:
49793           $ref: "#/definitions/lag-link"
49794       newvces:
49795         type: array
49796         items:
49797           $ref: "#/definitions/newvce"
49798       pnfs:
49799         type: array
49800         items:
49801           $ref: "#/definitions/pnf"
49802       physical-links:
49803         type: array
49804         items:
49805           $ref: "#/definitions/physical-link"
49806       ipsec-configurations:
49807         type: array
49808         items:
49809           $ref: "#/definitions/ipsec-configuration"
49810       route-table-references:
49811         type: array
49812         items:
49813           $ref: "#/definitions/route-table-reference"
49814       instance-groups:
49815         type: array
49816         items:
49817           $ref: "#/definitions/instance-group"
49818       zones:
49819         type: array
49820         items:
49821           $ref: "#/definitions/zone"
49822       configurations:
49823         type: array
49824         items:
49825           $ref: "#/definitions/configuration"
49826       forwarding-paths:
49827         type: array
49828         items:
49829           $ref: "#/definitions/forwarding-path"
49830   network-policies:
49831     properties:
49832       network-policy:
49833         type: array
49834         items:
49835           $ref: "#/definitions/network-policy"
49836   network-policy:
49837     description: |
49838       ###### Related Nodes
49839       - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
49840       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
49841
49842     required:
49843     - network-policy-id
49844     properties:
49845       network-policy-id:
49846         type: string
49847         description: UUID representing unique key to this instance
49848       network-policy-fqdn:
49849         type: string
49850         description: Contrail FQDN for the policy
49851       heat-stack-id:
49852         type: string
49853         description: ID for the openStack Heat instance
49854       resource-version:
49855         type: string
49856         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49857       relationship-list:
49858         type: array
49859         items:
49860           $ref: "#/definitions/relationship"
49861   network-profile:
49862     description: |
49863       Network profile populated by SDN-GP for SNMP
49864       ###### Related Nodes
49865       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
49866
49867     required:
49868     - nm-profile-name
49869     properties:
49870       nm-profile-name:
49871         type: string
49872         description: Unique name of network profile.
49873       community-string:
49874         type: string
49875         description: Encrypted SNMP community string
49876       resource-version:
49877         type: string
49878         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49879       relationship-list:
49880         type: array
49881         items:
49882           $ref: "#/definitions/relationship"
49883   network-profiles:
49884     description: |
49885       Collection of network profiles
49886     properties:
49887       network-profile:
49888         type: array
49889         items:
49890           $ref: "#/definitions/network-profile"
49891   newvce:
49892     description: |
49893       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
49894       ###### Related Nodes
49895       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
49896
49897       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
49898     required:
49899     - vnf-id2
49900     - vnf-name
49901     - vnf-type
49902     properties:
49903       vnf-id2:
49904         type: string
49905         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
49906       vnf-name:
49907         type: string
49908         description: Name of VNF.
49909       vnf-name2:
49910         type: string
49911         description: Alternate name of VNF.
49912       vnf-type:
49913         type: string
49914         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
49915       prov-status:
49916         type: string
49917         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
49918       operational-status:
49919         type: string
49920         description: Indicator for whether the resource is considered operational
49921       license-key:
49922         type: string
49923         description: OBSOLETE -  do not use
49924       ipv4-oam-address:
49925         type: string
49926         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
49927       equipment-role:
49928         type: string
49929         description: Client should send valid enumerated value.
49930       resource-version:
49931         type: string
49932         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49933       ipv4-loopback0-address:
49934         type: string
49935         description: v4 Loopback0 address
49936       orchestration-status:
49937         type: string
49938         description: Orchestration status of this VNF, mastered by MSO.
49939       heat-stack-id:
49940         type: string
49941         description: Heat stack id corresponding to this instance, managed by MSO
49942       mso-catalog-key:
49943         type: string
49944         description: Corresponds to the SDN-C catalog id used to configure this VCE
49945       relationship-list:
49946         type: array
49947         items:
49948           $ref: "#/definitions/relationship"
49949       l-interfaces:
49950         type: array
49951         items:
49952           $ref: "#/definitions/l-interface"
49953   newvces:
49954     description: |
49955       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
49956     properties:
49957       newvce:
49958         type: array
49959         items:
49960           $ref: "#/definitions/newvce"
49961   nodes:
49962     properties:
49963       inventory-item-data:
49964         type: array
49965         items:
49966           $ref: "#/definitions/inventory-item-data"
49967   notification-event:
49968     properties:
49969       cambria.partition:
49970         type: string
49971       notification-event-header:
49972         type: object
49973         $ref: "#/definitions/notification-event-header"
49974   notification-event-header:
49975     properties:
49976       id:
49977         type: string
49978       timestamp:
49979         type: string
49980       source-name:
49981         type: string
49982       domain:
49983         type: string
49984       sequence-number:
49985         type: string
49986       severity:
49987         type: string
49988       event-type:
49989         type: string
49990       version:
49991         type: string
49992       action:
49993         type: string
49994       entity-type:
49995         type: string
49996       top-entity-type:
49997         type: string
49998       entity-link:
49999         type: string
50000       status:
50001         type: string
50002   notify:
50003     required:
50004     - event-id
50005     properties:
50006       event-id:
50007         type: string
50008       node-type:
50009         type: string
50010       event-trigger:
50011         type: string
50012       key-data:
50013         type: array
50014         items:
50015           $ref: "#/definitions/key-data"
50016       selflink:
50017         type: string
50018   oam-network:
50019     description: |
50020       OAM network, to be deprecated shortly.  Do not use for new purposes.
50021       ###### Related Nodes
50022       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
50023       - TO complex( oam-network AppliesTo complex, MANY2MANY)
50024       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
50025
50026     required:
50027     - network-uuid
50028     - network-name
50029     - cvlan-tag
50030     properties:
50031       network-uuid:
50032         type: string
50033         description: UUID of the network. Unique across a cloud-region
50034       network-name:
50035         type: string
50036         description: Name of the network.
50037       cvlan-tag:
50038         type: integer
50039         format: int64
50040         description: cvlan-id
50041       ipv4-oam-gateway-address:
50042         type: string
50043         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50044       ipv4-oam-gateway-address-prefix-length:
50045         type: integer
50046         format: int32
50047         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50048       resource-version:
50049         type: string
50050         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50051       relationship-list:
50052         type: array
50053         items:
50054           $ref: "#/definitions/relationship"
50055   oam-networks:
50056     description: |
50057       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
50058     properties:
50059       oam-network:
50060         type: array
50061         items:
50062           $ref: "#/definitions/oam-network"
50063   operational-environment:
50064     description: |
50065       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
50066       ###### Related Nodes
50067       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
50068       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
50069
50070     required:
50071     - operational-environment-id
50072     - operational-environment-name
50073     - operational-environment-type
50074     - operational-environment-status
50075     - tenant-context
50076     - workload-context
50077     properties:
50078       operational-environment-id:
50079         type: string
50080         description: UUID of an operational environment
50081       operational-environment-name:
50082         type: string
50083         description: Operational Environment name
50084       operational-environment-type:
50085         type: string
50086         description: Operational Environment Type.
50087       operational-environment-status:
50088         type: string
50089         description: Status
50090       tenant-context:
50091         type: string
50092         description: Tenant Context.
50093       workload-context:
50094         type: string
50095         description: Workload Context.
50096       resource-version:
50097         type: string
50098         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50099       relationship-list:
50100         type: array
50101         items:
50102           $ref: "#/definitions/relationship"
50103   operational-environments:
50104     description: |
50105       a logical partition of the cloud which allows to have multiple environments in the production AIC.
50106     properties:
50107       operational-environment:
50108         type: array
50109         items:
50110           $ref: "#/definitions/operational-environment"
50111   overloaded-model:
50112     description: |
50113       Allows for legacy POST of old-style and new-style models
50114     required:
50115     - model-invariant-id
50116     - model-name-version-id
50117     - model-type
50118     - model-name
50119     - model-id
50120     - model-version
50121     properties:
50122       model-invariant-id:
50123         type: string
50124         description: Unique identifier corresponding to the main definition of a model in ASDC
50125       model-name-version-id:
50126         type: string
50127         description: Unique identifier corresponding to one version of a model in ASDC
50128       model-type:
50129         type: string
50130         description: Type of the model, e.g., service, resource, widget, etc.
50131       model-name:
50132         type: string
50133         description: Name of the model, which can change from version to version.
50134       model-id:
50135         type: string
50136         description: Invariant unique ID which does not change from version to version
50137       model-version:
50138         type: string
50139         description: Version
50140       model-description:
50141         type: string
50142         description: Description
50143       resource-version:
50144         type: string
50145         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50146       model-vers:
50147         type: object
50148         $ref: "#/definitions/model-vers"
50149       relationship-list:
50150         type: object
50151         $ref: "#/definitions/relationship-list"
50152   owning-entities:
50153     description: |
50154       Collection of owning-entities
50155     properties:
50156       owning-entity:
50157         type: array
50158         items:
50159           $ref: "#/definitions/owning-entity"
50160   owning-entity:
50161     description: |
50162       describes an owning-entity
50163       ###### Related Nodes
50164       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
50165
50166     required:
50167     - owning-entity-id
50168     - owning-entity-name
50169     properties:
50170       owning-entity-id:
50171         type: string
50172         description: UUID of an owning entity
50173       owning-entity-name:
50174         type: string
50175         description: Owning entity name
50176       resource-version:
50177         type: string
50178         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50179       relationship-list:
50180         type: array
50181         items:
50182           $ref: "#/definitions/relationship"
50183   p-interface:
50184     description: |
50185       Physical interface (e.g., nic)
50186       ###### Related Nodes
50187       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
50188       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
50189       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
50190       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
50191       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
50192       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
50193       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
50194       - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
50195       - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)
50196
50197       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
50198       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
50199       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
50200     required:
50201     - interface-name
50202     - in-maint
50203     properties:
50204       interface-name:
50205         type: string
50206         description: Name that identifies the physical interface
50207       selflink:
50208         type: string
50209         description: URL to endpoint where AAI can get more details.
50210       speed-value:
50211         type: string
50212         description: Captures the numeric part of the speed
50213       speed-units:
50214         type: string
50215         description: Captures the units corresponding to the speed
50216       port-description:
50217         type: string
50218         description: Nature of the services and connectivity on this port.
50219       equipment-identifier:
50220         type: string
50221         description: CLEI or other specification for p-interface hardware.
50222       interface-role:
50223         type: string
50224         description: Role specification for p-interface hardware.
50225       interface-type:
50226         type: string
50227         description: Indicates the physical properties of the interface.
50228       prov-status:
50229         type: string
50230         description: Trigger for operational monitoring of this resource by Service Assurance systems.
50231       mac-addresss:
50232         type: string
50233         description: MAC Address of the p-interface.
50234       resource-version:
50235         type: string
50236         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50237       in-maint:
50238         type: boolean
50239         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
50240       inv-status:
50241         type: string
50242         description: inventory status
50243       relationship-list:
50244         type: array
50245         items:
50246           $ref: "#/definitions/relationship"
50247       sriov-pfs:
50248         type: array
50249         items:
50250           $ref: "#/definitions/sriov-pf"
50251       l-interfaces:
50252         type: array
50253         items:
50254           $ref: "#/definitions/l-interface"
50255   p-interfaces:
50256     description: |
50257       Collection of physical interfaces.
50258     properties:
50259       p-interface:
50260         type: array
50261         items:
50262           $ref: "#/definitions/p-interface"
50263   physical-link:
50264     description: |
50265       Collection of physical connections, typically between p-interfaces
50266       ###### Related Nodes
50267       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
50268
50269       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
50270     required:
50271     - link-name
50272     properties:
50273       link-name:
50274         type: string
50275         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50276       speed-value:
50277         type: string
50278         description: Captures the numeric part of the speed
50279       speed-units:
50280         type: string
50281         description: Captures the units corresponding to the speed
50282       circuit-id:
50283         type: string
50284         description: Circuit it
50285       dual-mode:
50286         type: string
50287         description: Dual access mode (e.g., primary, secondary
50288       management-option:
50289         type: string
50290         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
50291       service-provider-name:
50292         type: string
50293         description: Name of the service Provider on this link.
50294       service-provider-bandwidth-up-value:
50295         type: integer
50296         format: int32
50297         description: Upstream Bandwidth value agreed with the service provider
50298       service-provider-bandwidth-up-units:
50299         type: string
50300         description: Units for the upstream BW value
50301       service-provider-bandwidth-down-value:
50302         type: integer
50303         format: int32
50304         description: Downstream Bandwidth value agreed with the service provider
50305       service-provider-bandwidth-down-units:
50306         type: string
50307         description: Units for downstream BW value
50308       resource-version:
50309         type: string
50310         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50311       relationship-list:
50312         type: array
50313         items:
50314           $ref: "#/definitions/relationship"
50315   physical-links:
50316     description: |
50317       Collection of physical connections, typically between p-interfaces
50318     properties:
50319       physical-link:
50320         type: array
50321         items:
50322           $ref: "#/definitions/physical-link"
50323   platform:
50324     description: |
50325       describes a platform
50326       ###### Related Nodes
50327       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
50328
50329     required:
50330     - platform-name
50331     properties:
50332       platform-name:
50333         type: string
50334         description: Name of the platform
50335       resource-version:
50336         type: string
50337         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50338       relationship-list:
50339         type: array
50340         items:
50341           $ref: "#/definitions/relationship"
50342   platforms:
50343     description: |
50344       Collection of platforms
50345     properties:
50346       platform:
50347         type: array
50348         items:
50349           $ref: "#/definitions/platform"
50350   pnf:
50351     description: |
50352       PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
50353       ###### Related Nodes
50354       - TO complex( pnf LocatedIn complex, MANY2ONE)
50355       - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
50356       - TO zone( pnf LocatedIn zone, MANY2ONE)
50357       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
50358       - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
50359       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
50360       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
50361       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
50362       - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
50363       - FROM configuration( configuration AppliesTo pnf, ONE2MANY)
50364
50365       -(1) IF this PNF node is deleted, this FROM node is DELETED also
50366     required:
50367     - pnf-name
50368     - in-maint
50369     properties:
50370       pnf-name:
50371         type: string
50372         description: unique name of Physical Network Function.
50373       pnf-name2:
50374         type: string
50375         description: name of Physical Network Function.
50376       selflink:
50377         type: string
50378         description: URL to endpoint where AAI can get more details.
50379       pnf-name2-source:
50380         type: string
50381         description: source of name2
50382       pnf-id:
50383         type: string
50384         description: id of pnf
50385       equip-type:
50386         type: string
50387         description: Equipment type.  Source of truth should define valid values.
50388       equip-vendor:
50389         type: string
50390         description: Equipment vendor.  Source of truth should define valid values.
50391       equip-model:
50392         type: string
50393         description: Equipment model.  Source of truth should define valid values.
50394       management-option:
50395         type: string
50396         description: identifier of managed by ATT or customer
50397       ipaddress-v4-oam:
50398         type: string
50399         description: ipv4-oam-address with new naming convention for IP addresses
50400       sw-version:
50401         type: string
50402         description: sw-version is the version of SW for the hosted application on the PNF.
50403       in-maint:
50404         type: boolean
50405         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
50406       frame-id:
50407         type: string
50408         description: ID of the physical frame (relay rack) where pnf is installed.
50409       serial-number:
50410         type: string
50411         description: Serial number of the device
50412       ipaddress-v4-loopback-0:
50413         type: string
50414         description: IPV4 Loopback 0 address
50415       ipaddress-v6-loopback-0:
50416         type: string
50417         description: IPV6 Loopback 0 address
50418       ipaddress-v4-aim:
50419         type: string
50420         description: IPV4 AIM address
50421       ipaddress-v6-aim:
50422         type: string
50423         description: IPV6 AIM address
50424       ipaddress-v6-oam:
50425         type: string
50426         description: IPV6 OAM address
50427       inv-status:
50428         type: string
50429         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50430       resource-version:
50431         type: string
50432         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50433       prov-status:
50434         type: string
50435         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
50436       nf-role:
50437         type: string
50438         description: Nf Role is the role performed by this instance in the network.
50439       relationship-list:
50440         type: array
50441         items:
50442           $ref: "#/definitions/relationship"
50443       p-interfaces:
50444         type: array
50445         items:
50446           $ref: "#/definitions/p-interface"
50447       lag-interfaces:
50448         type: array
50449         items:
50450           $ref: "#/definitions/lag-interface"
50451   pnfs:
50452     description: |
50453       Collection of Physical Network Functions.
50454     properties:
50455       pnf:
50456         type: array
50457         items:
50458           $ref: "#/definitions/pnf"
50459   port-group:
50460     description: |
50461       Used to capture the network interfaces of this VCE
50462       ###### Related Nodes
50463       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
50464       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
50465
50466       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
50467       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
50468     required:
50469     - interface-id
50470     - orchestration-status
50471     properties:
50472       interface-id:
50473         type: string
50474         description: Unique ID of the interface
50475       neutron-network-id:
50476         type: string
50477         description: Neutron network id of this Interface
50478       neutron-network-name:
50479         type: string
50480         description: Neutron network name of this Interface
50481       interface-role:
50482         type: string
50483         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50484       resource-version:
50485         type: string
50486         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50487       port-group-id:
50488         type: string
50489         description: Unique ID for port group in vmware
50490       port-group-name:
50491         type: string
50492         description: Likely to duplicate value of neutron network name
50493       switch-name:
50494         type: string
50495         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
50496       orchestration-status:
50497         type: string
50498         description: Orchestration status of this VNF, mastered by MSO
50499       heat-stack-id:
50500         type: string
50501         description: Heat stack id corresponding to this instance, managed by MSO
50502       mso-catalog-key:
50503         type: string
50504         description: Corresponds to the SDN-C catalog id used to configure this VCE
50505       cvlan-tags:
50506         type: array
50507         items:
50508           $ref: "#/definitions/cvlan-tag-entry"
50509       relationship-list:
50510         type: array
50511         items:
50512           $ref: "#/definitions/relationship"
50513   port-groups:
50514     properties:
50515       port-group:
50516         type: array
50517         items:
50518           $ref: "#/definitions/port-group"
50519   project:
50520     description: |
50521       describes the project
50522       ###### Related Nodes
50523       - TO service-instance( project Uses service-instance, ONE2MANY)
50524
50525     required:
50526     - project-name
50527     properties:
50528       project-name:
50529         type: string
50530         description: Name of the project deploying a service
50531       resource-version:
50532         type: string
50533         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50534       relationship-list:
50535         type: array
50536         items:
50537           $ref: "#/definitions/relationship"
50538   projects:
50539     description: |
50540       Collection of projects
50541     properties:
50542       project:
50543         type: array
50544         items:
50545           $ref: "#/definitions/project"
50546   properties:
50547     description: |
50548       Property holder for query properties or instance properties
50549     properties:
50550       property-name:
50551         type: string
50552       property-value:
50553         type: string
50554   property-constraint:
50555     description: |
50556       TBD
50557       ###### Related Nodes
50558       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
50559
50560       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
50561     required:
50562     - property-constraint-uuid
50563     - constraint-type
50564     - property-name
50565     - property-value
50566     properties:
50567       property-constraint-uuid:
50568         type: string
50569       constraint-type:
50570         type: string
50571       property-name:
50572         type: string
50573       property-value:
50574         type: string
50575       resource-version:
50576         type: string
50577   property-constraints:
50578     properties:
50579       property-constraint:
50580         type: array
50581         items:
50582           $ref: "#/definitions/property-constraint"
50583   pserver:
50584     description: |
50585       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
50586       ###### Related Nodes
50587       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
50588       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
50589       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
50590       - TO complex( pserver LocatedIn complex, MANY2ONE)
50591       - TO zone( pserver LocatedIn zone, MANY2ONE)
50592       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
50593       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
50594       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
50595       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
50596       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
50597
50598       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
50599       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
50600
50601     required:
50602     - hostname
50603     - in-maint
50604     properties:
50605       hostname:
50606         type: string
50607         description: Value from executing hostname on the compute node.
50608       ptnii-equip-name:
50609         type: string
50610         description: PTNII name
50611       number-of-cpus:
50612         type: integer
50613         format: int32
50614         description: Number of cpus
50615       disk-in-gigabytes:
50616         type: integer
50617         format: int32
50618         description: Disk size, in GBs
50619       ram-in-megabytes:
50620         type: integer
50621         format: int32
50622         description: RAM size, in MBs
50623       equip-type:
50624         type: string
50625         description: Equipment type.  Source of truth should define valid values.
50626       equip-vendor:
50627         type: string
50628         description: Equipment vendor.  Source of truth should define valid values.
50629       equip-model:
50630         type: string
50631         description: Equipment model.  Source of truth should define valid values.
50632       fqdn:
50633         type: string
50634         description: Fully-qualified domain name
50635       pserver-selflink:
50636         type: string
50637         description: URL to endpoint where AAI can get more details
50638       ipv4-oam-address:
50639         type: string
50640         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
50641       serial-number:
50642         type: string
50643         description: Serial number, may be queried
50644       ipaddress-v4-loopback-0:
50645         type: string
50646         description: IPV4 Loopback 0 address
50647       ipaddress-v6-loopback-0:
50648         type: string
50649         description: IPV6 Loopback 0 address
50650       ipaddress-v4-aim:
50651         type: string
50652         description: IPV4 AIM address
50653       ipaddress-v6-aim:
50654         type: string
50655         description: IPV6 AIM address
50656       ipaddress-v6-oam:
50657         type: string
50658         description: IPV6 OAM address
50659       inv-status:
50660         type: string
50661         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50662       pserver-id:
50663         type: string
50664         description: ID of Pserver
50665       internet-topology:
50666         type: string
50667         description: internet topology of Pserver
50668       in-maint:
50669         type: boolean
50670         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
50671       resource-version:
50672         type: string
50673         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50674       pserver-name2:
50675         type: string
50676         description: alternative pserver name
50677       purpose:
50678         type: string
50679         description: purpose of pserver
50680       prov-status:
50681         type: string
50682         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
50683       management-option:
50684         type: string
50685         description: Indicates who owns and or manages the device.
50686       host-profile:
50687         type: string
50688         description: The host profile that defines the configuration of the pserver.
50689       relationship-list:
50690         type: array
50691         items:
50692           $ref: "#/definitions/relationship"
50693       p-interfaces:
50694         type: array
50695         items:
50696           $ref: "#/definitions/p-interface"
50697       lag-interfaces:
50698         type: array
50699         items:
50700           $ref: "#/definitions/lag-interface"
50701   pservers:
50702     description: |
50703       Collection of compute hosts.
50704     properties:
50705       pserver:
50706         type: array
50707         items:
50708           $ref: "#/definitions/pserver"
50709   query-parameters:
50710     description: |
50711       QueryParameters for performing a named-query or model query
50712     properties:
50713       named-query:
50714         type: object
50715         $ref: "#/definitions/named-query"
50716       overloaded-model:
50717         type: object
50718         $ref: "#/definitions/overloaded-model"
50719   related-lookup:
50720     description: |
50721       TBD
50722       ###### Related Nodes
50723       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
50724
50725       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
50726     required:
50727     - related-lookup-uuid
50728     - source-node-type
50729     - source-node-property
50730     - target-node-type
50731     - target-node-property
50732     properties:
50733       related-lookup-uuid:
50734         type: string
50735       source-node-type:
50736         type: string
50737       source-node-property:
50738         type: string
50739       target-node-type:
50740         type: string
50741       target-node-property:
50742         type: string
50743       property-collect-list:
50744         type: string
50745       resource-version:
50746         type: string
50747       relationship-list:
50748         type: array
50749         items:
50750           $ref: "#/definitions/relationship"
50751   related-lookups:
50752     properties:
50753       related-lookup:
50754         type: array
50755         items:
50756           $ref: "#/definitions/related-lookup"
50757   related-to-property:
50758     properties:
50759       property-key:
50760         type: string
50761         description: Key part of a key/value pair
50762       property-value:
50763         type: string
50764         description: Value part of a key/value pair
50765   relationship:
50766     properties:
50767       related-to:
50768         type: string
50769         description: A keyword provided by A&AI to indicate type of node.
50770       relationship-label:
50771         type: string
50772         description: The edge label for this relationship.
50773       related-link:
50774         type: string
50775         description: URL to the object in A&AI.
50776       relationship-data:
50777         type: array
50778         items:
50779           $ref: "#/definitions/relationship-data"
50780   relationship-data:
50781     required:
50782     - relationship-key
50783     - relationship-value
50784     properties:
50785       relationship-key:
50786         type: string
50787         description: A keyword provided by A&AI to indicate an attribute.
50788       relationship-value:
50789         type: string
50790         description: Value of the attribute.
50791   relationship-list:
50792     properties:
50793       relationship:
50794         type: array
50795         items:
50796           $ref: "#/definitions/relationship"
50797   reserved-prop-names:
50798     description: |
50799       Internal map to define some reserved properties of a vertex
50800     properties:
50801       last-mod-source-of-truth:
50802         type: string
50803       aai-node-type:
50804         type: string
50805       aai-created-ts:
50806         type: integer
50807         format: int64
50808       aai-unique-key:
50809         type: string
50810       aai-last-mod-ts:
50811         type: integer
50812         format: int64
50813       source-of-truth:
50814         type: string
50815       aai-uri:
50816         type: string
50817   response-list:
50818     description: |
50819       Response container for the results of a named-query or model query
50820     properties:
50821       inventory-response-items:
50822         type: object
50823         $ref: "#/definitions/inventory-response-items"
50824   result-data:
50825     properties:
50826       resource-type:
50827         type: string
50828         description: The specific type of node in the A&AI graph
50829       resource-link:
50830         type: string
50831         description: The URL to the specific resource
50832   route-table-reference:
50833     description: |
50834       Openstack route table reference.
50835       ###### Related Nodes
50836       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
50837
50838     required:
50839     - route-table-reference-id
50840     - route-table-reference-fqdn
50841     properties:
50842       route-table-reference-id:
50843         type: string
50844         description: Route Table Reference id, UUID assigned to this instance.
50845       route-table-reference-fqdn:
50846         type: string
50847         description: FQDN entry in the route table.
50848       resource-version:
50849         type: string
50850         description: Concurrency value
50851       relationship-list:
50852         type: array
50853         items:
50854           $ref: "#/definitions/relationship"
50855   route-table-references:
50856     description: |
50857       Collection of openstack route table references
50858     properties:
50859       route-table-reference:
50860         type: array
50861         items:
50862           $ref: "#/definitions/route-table-reference"
50863   route-target:
50864     description: |
50865       Route target information
50866       ###### Related Nodes
50867       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
50868
50869       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
50870     required:
50871     - global-route-target
50872     - route-target-role
50873     properties:
50874       global-route-target:
50875         type: string
50876         description: Number used to identify an RT, globally unique in the network
50877       route-target-role:
50878         type: string
50879         description: Role assigned to this route target
50880       resource-version:
50881         type: string
50882         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50883       relationship-list:
50884         type: array
50885         items:
50886           $ref: "#/definitions/relationship"
50887   route-targets:
50888     description: |
50889       Collection of route target information
50890     properties:
50891       route-target:
50892         type: array
50893         items:
50894           $ref: "#/definitions/route-target"
50895   routing-instance:
50896     description: |
50897       ###### Related Nodes
50898       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
50899       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
50900
50901       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
50902       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
50903     required:
50904     - routing-instance-id
50905     properties:
50906       routing-instance-id:
50907         type: string
50908         description: Unique id of routing instance
50909       rpm-owner:
50910         type: string
50911         description: rpm owner
50912       resource-version:
50913         type: string
50914         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50915       site-pairs:
50916         type: array
50917         items:
50918           $ref: "#/definitions/site-pair"
50919       relationship-list:
50920         type: array
50921         items:
50922           $ref: "#/definitions/relationship"
50923   routing-instances:
50924     description: |
50925       set of probes related to generic-vnf routing instance
50926     properties:
50927       routing-instance:
50928         type: array
50929         items:
50930           $ref: "#/definitions/routing-instance"
50931   sdn-zone-response:
50932     properties:
50933       oam-networks:
50934         type: object
50935         $ref: "#/definitions/oam-networks"
50936       az-and-dvs-switches:
50937         type: array
50938         items:
50939           $ref: "#/definitions/az-and-dvs-switches"
50940   search:
50941     properties:
50942       edge-tag-query-result:
50943         type: object
50944         $ref: "#/definitions/edge-tag-query-result"
50945       edge-tag-query-request:
50946         type: object
50947         $ref: "#/definitions/edge-tag-query-request"
50948       search-results:
50949         type: object
50950         $ref: "#/definitions/search-results"
50951       sdn-zone-response:
50952         type: object
50953         $ref: "#/definitions/sdn-zone-response"
50954   search-results:
50955     properties:
50956       result-data:
50957         type: array
50958         items:
50959           $ref: "#/definitions/result-data"
50960   secondary-filt:
50961     description: |
50962       SecondaryFilt for performing a named-query or model query
50963   secondary-filter:
50964     properties:
50965       property-name:
50966         type: string
50967       filter-type:
50968         type: string
50969       property-value:
50970         type: string
50971   secondary-filts:
50972     description: |
50973       SecondaryFilts for performing a named-query or model query
50974     properties:
50975       secondary-filt:
50976         type: array
50977         items:
50978           $ref: "#/definitions/secondary-filt"
50979   segmentation-assignment:
50980     description: |
50981       Openstack segmentation assignment.
50982       ###### Related Nodes
50983       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
50984
50985       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
50986     required:
50987     - segmentation-id
50988     properties:
50989       segmentation-id:
50990         type: string
50991         description: Route Table Reference id, UUID assigned to this instance.
50992       resource-version:
50993         type: string
50994         description: Concurrency value
50995       relationship-list:
50996         type: array
50997         items:
50998           $ref: "#/definitions/relationship"
50999   segmentation-assignments:
51000     description: |
51001       Collection of openstack segmentation assignments
51002     properties:
51003       segmentation-assignment:
51004         type: array
51005         items:
51006           $ref: "#/definitions/segmentation-assignment"
51007   service:
51008     description: |
51009       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
51010     required:
51011     - service-id
51012     - service-description
51013     properties:
51014       service-id:
51015         type: string
51016         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51017       service-description:
51018         type: string
51019         description: Description of the service
51020       service-selflink:
51021         type: string
51022         description: URL to endpoint where AAI can get more details
51023       resource-version:
51024         type: string
51025         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51026       service-version:
51027         type: string
51028         description: service version
51029       relationship-list:
51030         type: array
51031         items:
51032           $ref: "#/definitions/relationship"
51033   service-capabilities:
51034     description: |
51035       Collection of service capabilities.
51036     properties:
51037       service-capability:
51038         type: array
51039         items:
51040           $ref: "#/definitions/service-capability"
51041   service-capability:
51042     description: |
51043       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
51044       ###### Related Nodes
51045       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
51046       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
51047
51048       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
51049
51050     required:
51051     - service-type
51052     - vnf-type
51053     properties:
51054       service-type:
51055         type: string
51056         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51057       vnf-type:
51058         type: string
51059         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
51060       resource-version:
51061         type: string
51062         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51063       relationship-list:
51064         type: array
51065         items:
51066           $ref: "#/definitions/relationship"
51067   service-design-and-creation:
51068     description: |
51069       Namespace for objects managed by ASDC
51070     properties:
51071       vnf-images:
51072         type: array
51073         items:
51074           $ref: "#/definitions/vnf-image"
51075       services:
51076         type: array
51077         items:
51078           $ref: "#/definitions/service"
51079       service-capabilities:
51080         type: array
51081         items:
51082           $ref: "#/definitions/service-capability"
51083       models:
51084         type: array
51085         items:
51086           $ref: "#/definitions/model"
51087       named-queries:
51088         type: array
51089         items:
51090           $ref: "#/definitions/named-query"
51091   service-instance:
51092     description: |
51093       Instance of a service
51094       ###### Related Nodes
51095       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
51096       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
51097       - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
51098       - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
51099       - TO configuration( service-instance Uses configuration, ONE2MANY)
51100       - TO connector( service-instance Uses connector, MANY2MANY)
51101       - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
51102       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
51103       - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
51104       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
51105       - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
51106       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
51107       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
51108       - TO zone( service-instance LocatedIn zone, MANY2ONE)
51109       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
51110       - TO vce( service-instance ComposedOf vce, ONE2MANY)
51111       - TO model-ver( service-instance IsA model-ver, Many2One)
51112       - FROM project( project Uses service-instance, ONE2MANY)
51113       - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
51114       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
51115       - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
51116       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
51117
51118       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
51119       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
51120       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
51121     required:
51122     - service-instance-id
51123     properties:
51124       service-instance-id:
51125         type: string
51126         description: Uniquely identifies this instance of a service
51127       service-instance-name:
51128         type: string
51129         description: This field will store a name assigned to the service-instance.
51130       service-type:
51131         type: string
51132         description: String capturing type of service.
51133       service-role:
51134         type: string
51135         description: String capturing the service role.
51136       environment-context:
51137         type: string
51138         description: This field will store the environment context assigned to the service-instance.
51139       workload-context:
51140         type: string
51141         description: This field will store the workload context assigned to the service-instance.
51142       created-at:
51143         type: string
51144         description: create time of Network Service.
51145       updated-at:
51146         type: string
51147         description: last update of Network Service.
51148       description:
51149         type: string
51150         description: short description for service-instance.
51151       model-invariant-id:
51152         type: string
51153         description: the ASDC model id for this resource or service model.
51154       model-version-id:
51155         type: string
51156         description: the ASDC model version for this resource or service model.
51157       persona-model-version:
51158         type: string
51159         description: the ASDC model version for this resource or service model.
51160       widget-model-id:
51161         type: string
51162         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51163       widget-model-version:
51164         type: string
51165         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51166       bandwidth-total:
51167         type: string
51168         description: Indicates the total bandwidth to be used for this service.
51169       bandwidth-up-wan1:
51170         type: string
51171         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
51172       bandwidth-down-wan1:
51173         type: string
51174         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
51175       bandwidth-up-wan2:
51176         type: string
51177         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
51178       bandwidth-down-wan2:
51179         type: string
51180         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
51181       vhn-portal-url:
51182         type: string
51183         description: URL customers will use to access the vHN Portal.
51184       service-instance-location-id:
51185         type: string
51186         description: An identifier that customers assign to the location where this service is being used.
51187       resource-version:
51188         type: string
51189         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51190       selflink:
51191         type: string
51192         description: Path to the controller object.
51193       orchestration-status:
51194         type: string
51195         description: Orchestration status of this service.
51196       relationship-list:
51197         type: array
51198         items:
51199           $ref: "#/definitions/relationship"
51200       metadata:
51201         type: array
51202         items:
51203           $ref: "#/definitions/metadatum"
51204       allotted-resources:
51205         type: array
51206         items:
51207           $ref: "#/definitions/allotted-resource"
51208   service-instances:
51209     description: |
51210       Collection of service instances
51211     properties:
51212       service-instance:
51213         type: array
51214         items:
51215           $ref: "#/definitions/service-instance"
51216   service-subscription:
51217     description: |
51218       Object that group service instances.
51219       ###### Related Nodes
51220       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
51221       - TO tenant( service-subscription Uses tenant, MANY2MANY)
51222       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
51223
51224       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
51225       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
51226     required:
51227     - service-type
51228     properties:
51229       service-type:
51230         type: string
51231         description: Value defined by orchestration to identify this service across ECOMP.
51232       temp-ub-sub-account-id:
51233         type: string
51234         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
51235       resource-version:
51236         type: string
51237         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51238       service-instances:
51239         type: array
51240         items:
51241           $ref: "#/definitions/service-instance"
51242       relationship-list:
51243         type: array
51244         items:
51245           $ref: "#/definitions/relationship"
51246   service-subscriptions:
51247     description: |
51248       Collection of objects that group service instances.
51249     properties:
51250       service-subscription:
51251         type: array
51252         items:
51253           $ref: "#/definitions/service-subscription"
51254   services:
51255     description: |
51256       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
51257     properties:
51258       service:
51259         type: array
51260         items:
51261           $ref: "#/definitions/service"
51262   site-pair:
51263     description: |
51264       ###### Related Nodes
51265       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
51266       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
51267
51268       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
51269       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
51270     required:
51271     - site-pair-id
51272     properties:
51273       site-pair-id:
51274         type: string
51275         description: unique identifier of probe
51276       source-ip:
51277         type: string
51278         description: Prefix address
51279       destination-ip:
51280         type: string
51281         description: Prefix address
51282       ip-version:
51283         type: string
51284         description: ip version, v4, v6
51285       destination-hostname:
51286         type: string
51287         description: Hostname of the destination equipment to which SLAs are measured against.
51288       destination-equip-type:
51289         type: string
51290         description: The type of destinatination equipment. Could be Router, UCPE, etc.
51291       resource-version:
51292         type: string
51293         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51294       classes-of-service:
51295         type: array
51296         items:
51297           $ref: "#/definitions/class-of-service"
51298       relationship-list:
51299         type: array
51300         items:
51301           $ref: "#/definitions/relationship"
51302   site-pair-set:
51303     description: |
51304       Set of instances for probes used to measure service level agreements
51305       ###### Related Nodes
51306       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
51307       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
51308
51309       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
51310     required:
51311     - site-pair-set-id
51312     properties:
51313       site-pair-set-id:
51314         type: string
51315         description: Unique id of site pair set.
51316       resource-version:
51317         type: string
51318         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51319       routing-instances:
51320         type: array
51321         items:
51322           $ref: "#/definitions/routing-instance"
51323       relationship-list:
51324         type: array
51325         items:
51326           $ref: "#/definitions/relationship"
51327   site-pair-sets:
51328     description: |
51329       Collection of sets of instances for probes related to generic-vnf
51330     properties:
51331       site-pair-set:
51332         type: array
51333         items:
51334           $ref: "#/definitions/site-pair-set"
51335   site-pairs:
51336     description: |
51337       probe within a set
51338     properties:
51339       site-pair:
51340         type: array
51341         items:
51342           $ref: "#/definitions/site-pair"
51343   snapshot:
51344     description: |
51345       Openstack snapshot
51346       ###### Related Nodes
51347       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
51348       - FROM vserver( vserver Uses snapshot, ONE2ONE)
51349
51350     required:
51351     - snapshot-id
51352     properties:
51353       snapshot-id:
51354         type: string
51355         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
51356       snapshot-name:
51357         type: string
51358         description: Snapshot name
51359       snapshot-architecture:
51360         type: string
51361         description: Operating system architecture
51362       snapshot-os-distro:
51363         type: string
51364         description: The common name of the operating system distribution in lowercase
51365       snapshot-os-version:
51366         type: string
51367         description: The operating system version as specified by the distributor.
51368       application:
51369         type: string
51370         description: The application that the image instantiates.
51371       application-vendor:
51372         type: string
51373         description: The vendor of the application.
51374       application-version:
51375         type: string
51376         description: The version of the application.
51377       snapshot-selflink:
51378         type: string
51379         description: URL to endpoint where AAI can get more details
51380       prev-snapshot-id:
51381         type: string
51382         description: This field contains the UUID of the previous snapshot (if any).
51383       resource-version:
51384         type: string
51385         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51386       relationship-list:
51387         type: array
51388         items:
51389           $ref: "#/definitions/relationship"
51390   snapshots:
51391     description: |
51392       Collection of openstack snapshots
51393     properties:
51394       snapshot:
51395         type: array
51396         items:
51397           $ref: "#/definitions/snapshot"
51398   sriov-pf:
51399     description: |
51400       SR-IOV Physical Function
51401       ###### Related Nodes
51402       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
51403       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
51404
51405       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
51406     required:
51407     - pf-pci-id
51408     properties:
51409       pf-pci-id:
51410         type: string
51411         description: Identifier for the sriov-pf
51412       resource-version:
51413         type: string
51414         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51415       relationship-list:
51416         type: array
51417         items:
51418           $ref: "#/definitions/relationship"
51419   sriov-pfs:
51420     description: |
51421       Collection of SR-IOV Physical Functions.
51422     properties:
51423       sriov-pf:
51424         type: array
51425         items:
51426           $ref: "#/definitions/sriov-pf"
51427   sriov-vf:
51428     description: |
51429       SR-IOV Virtual Function (not to be confused with virtual network function)
51430       ###### Related Nodes
51431       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
51432       - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
51433
51434       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
51435     required:
51436     - pci-id
51437     properties:
51438       pci-id:
51439         type: string
51440         description: PCI ID used to identify the sriov-vf
51441       vf-vlan-filter:
51442         type: string
51443         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
51444       vf-mac-filter:
51445         type: string
51446         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
51447       vf-vlan-strip:
51448         type: boolean
51449         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
51450       vf-vlan-anti-spoof-check:
51451         type: boolean
51452         description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
51453       vf-mac-anti-spoof-check:
51454         type: boolean
51455         description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
51456       vf-mirrors:
51457         type: string
51458         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
51459       vf-broadcast-allow:
51460         type: boolean
51461         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
51462       vf-unknown-multicast-allow:
51463         type: boolean
51464         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
51465       vf-unknown-unicast-allow:
51466         type: boolean
51467         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
51468       vf-insert-stag:
51469         type: boolean
51470         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
51471       vf-link-status:
51472         type: string
51473         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
51474       resource-version:
51475         type: string
51476         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51477       neutron-network-id:
51478         type: string
51479         description: Neutron network id of the interface
51480       relationship-list:
51481         type: array
51482         items:
51483           $ref: "#/definitions/relationship"
51484   sriov-vfs:
51485     description: |
51486       Collection of SR-IOV Virtual Functions.
51487     properties:
51488       sriov-vf:
51489         type: array
51490         items:
51491           $ref: "#/definitions/sriov-vf"
51492   start-node-filter:
51493     properties:
51494       property-name:
51495         type: string
51496       property-value:
51497         type: string
51498   subnet:
51499     description: |
51500       ###### Related Nodes
51501       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
51502       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
51503       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
51504       - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
51505       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
51506       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
51507
51508       -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
51509       -(4) IF this TO node is deleted, this SUBNET is DELETED also
51510       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
51511
51512     required:
51513     - subnet-id
51514     - dhcp-enabled
51515     properties:
51516       subnet-id:
51517         type: string
51518         description: Subnet ID, should be UUID.
51519       subnet-name:
51520         type: string
51521         description: Name associated with the subnet.
51522       neutron-subnet-id:
51523         type: string
51524         description: Neutron id of this subnet
51525       gateway-address:
51526         type: string
51527         description: gateway ip address
51528       network-start-address:
51529         type: string
51530         description: network start address
51531       cidr-mask:
51532         type: string
51533         description: cidr mask
51534       ip-version:
51535         type: string
51536         description: ip version
51537       orchestration-status:
51538         type: string
51539         description: Orchestration status of this VNF, mastered by MSO
51540       dhcp-enabled:
51541         type: boolean
51542         description: dhcp enabled
51543       dhcp-start:
51544         type: string
51545         description: the start address reserved for use by dhcp
51546       dhcp-end:
51547         type: string
51548         description: the last address reserved for use by dhcp
51549       subnet-role:
51550         type: string
51551         description: role of the subnet, referenced when assigning IPs
51552       ip-assignment-direction:
51553         type: string
51554         description: ip address assignment direction of the subnet
51555       resource-version:
51556         type: string
51557         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51558       subnet-sequence:
51559         type: integer
51560         format: int32
51561         description: sequence of the subnet
51562       host-routes:
51563         type: array
51564         items:
51565           $ref: "#/definitions/host-route"
51566       relationship-list:
51567         type: array
51568         items:
51569           $ref: "#/definitions/relationship"
51570   subnets:
51571     properties:
51572       subnet:
51573         type: array
51574         items:
51575           $ref: "#/definitions/subnet"
51576   tagged-inventory-item-list:
51577     properties:
51578       inventory-item:
51579         type: array
51580         items:
51581           $ref: "#/definitions/inventory-item"
51582   tenant:
51583     description: |
51584       Openstack tenant
51585       ###### Related Nodes
51586       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
51587       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
51588       - TO l3-network( tenant Uses l3-network, MANY2MANY)
51589       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
51590       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
51591       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
51592
51593       -TENANT cannot be deleted if related to VSERVER
51594
51595     required:
51596     - tenant-id
51597     - tenant-name
51598     properties:
51599       tenant-id:
51600         type: string
51601         description: Unique id relative to the cloud-region.
51602       tenant-name:
51603         type: string
51604         description: Readable name of tenant
51605       tenant-context:
51606         type: string
51607         description: This field will store the tenant context.
51608       resource-version:
51609         type: string
51610         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51611       vservers:
51612         type: array
51613         items:
51614           $ref: "#/definitions/vserver"
51615       relationship-list:
51616         type: array
51617         items:
51618           $ref: "#/definitions/relationship"
51619   tenants:
51620     description: |
51621       Collection of openstack tenants.
51622     properties:
51623       tenant:
51624         type: array
51625         items:
51626           $ref: "#/definitions/tenant"
51627   tunnel-xconnect:
51628     description: |
51629       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
51630       ###### Related Nodes
51631       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
51632
51633       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
51634     required:
51635     - id
51636     properties:
51637       id:
51638         type: string
51639         description: Allotted Resource id UUID assigned to this instance.
51640       bandwidth-up-wan1:
51641         type: string
51642         description: The WAN uplink bandwidth for WAN1
51643       bandwidth-down-wan1:
51644         type: string
51645         description: The WAN downlink bandwidth for WAN1
51646       bandwidth-up-wan2:
51647         type: string
51648         description: The WAN uplink bandwidth for WAN2
51649       bandwidth-down-wan2:
51650         type: string
51651         description: The WAN downlink bandwidth for WAN2
51652       resource-version:
51653         type: string
51654         description: Concurrency value
51655       relationship-list:
51656         type: array
51657         items:
51658           $ref: "#/definitions/relationship"
51659   tunnel-xconnects:
51660     description: |
51661       This object is used to store the specific tunnel cross connect aspects of an allotted resource
51662     properties:
51663       tunnel-xconnect:
51664         type: array
51665         items:
51666           $ref: "#/definitions/tunnel-xconnect"
51667   update:
51668     description: |
51669       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
51670     required:
51671     - update-node-type
51672     properties:
51673       update-node-type:
51674         type: string
51675       update-node-key:
51676         type: array
51677         items:
51678           $ref: "#/definitions/update-node-key"
51679       update-node-uri:
51680         type: string
51681       action:
51682         type: array
51683         items:
51684           $ref: "#/definitions/action"
51685   update-node-key:
51686     properties:
51687       key-name:
51688         type: string
51689       key-value:
51690         type: string
51691   vce:
51692     description: |
51693       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
51694       ###### Related Nodes
51695       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
51696       - TO complex( vce LocatedIn complex, MANY2MANY)
51697       - TO vserver( vce HostedOn vserver, ONE2MANY)
51698       - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
51699       - FROM license( license BelongsTo vce, MANY2ONE)(1)
51700       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
51701       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
51702
51703       -(1) IF this VCE node is deleted, this FROM node is DELETED also
51704     required:
51705     - vnf-id
51706     - vnf-name
51707     - vnf-type
51708     properties:
51709       vnf-id:
51710         type: string
51711         description: Unique id of VNF.  This is unique across the graph.
51712       vnf-name:
51713         type: string
51714         description: Name of VNF.
51715       vnf-name2:
51716         type: string
51717         description: Alternate name of VNF.
51718       vnf-type:
51719         type: string
51720         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
51721       service-id:
51722         type: string
51723         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
51724       regional-resource-zone:
51725         type: string
51726         description: Regional way of organizing pservers, source of truth should define values
51727       prov-status:
51728         type: string
51729         description: Trigger for operational monitoring of this resource by Service Assurance systems.
51730       operational-status:
51731         type: string
51732         description: Indicator for whether the resource is considered operational
51733       license-key:
51734         type: string
51735         description: OBSOLETE -  do not use
51736       equipment-role:
51737         type: string
51738         description: Network role being played by this VNF
51739       orchestration-status:
51740         type: string
51741         description: Orchestration status of this VNF, mastered by MSO
51742       heat-stack-id:
51743         type: string
51744         description: Heat stack id corresponding to this instance, managed by MSO
51745       mso-catalog-key:
51746         type: string
51747         description: Corresponds to the SDN-C catalog id used to configure this VCE
51748       vpe-id:
51749         type: string
51750         description: Unique ID of VPE connected to this VCE.
51751       v6-vce-wan-address:
51752         type: string
51753         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
51754       ipv4-oam-address:
51755         type: string
51756         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
51757       resource-version:
51758         type: string
51759         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51760       ipv4-loopback0-address:
51761         type: string
51762         description: Loopback0 address
51763       entitlement-resource-uuid:
51764         type: string
51765         description: OBSOLETE -  see child relationships
51766       port-groups:
51767         type: array
51768         items:
51769           $ref: "#/definitions/port-group"
51770       licenses:
51771         type: array
51772         items:
51773           $ref: "#/definitions/license"
51774       entitlements:
51775         type: array
51776         items:
51777           $ref: "#/definitions/entitlement"
51778       relationship-list:
51779         type: array
51780         items:
51781           $ref: "#/definitions/relationship"
51782   vces:
51783     description: |
51784       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
51785     properties:
51786       vce:
51787         type: array
51788         items:
51789           $ref: "#/definitions/vce"
51790   vf-module:
51791     description: |
51792       a deployment unit of VNFCs
51793       ###### Related Nodes
51794       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
51795       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
51796       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
51797       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
51798       - TO vserver( vf-module Uses vserver, ONE2MANY)
51799       - TO model-ver( vf-module IsA model-ver, Many2One)
51800
51801       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
51802       -VF-MODULE cannot be deleted if related to VNFC
51803
51804     required:
51805     - vf-module-id
51806     - is-base-vf-module
51807     properties:
51808       vf-module-id:
51809         type: string
51810         description: Unique ID of vf-module.
51811       vf-module-name:
51812         type: string
51813         description: Name of vf-module
51814       heat-stack-id:
51815         type: string
51816         description: Heat stack id corresponding to this instance.
51817       orchestration-status:
51818         type: string
51819         description: orchestration status of this vf-module, mastered by MSO
51820       is-base-vf-module:
51821         type: boolean
51822         description: used to indicate whether or not this object is base vf module
51823       resource-version:
51824         type: string
51825         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51826       model-invariant-id:
51827         type: string
51828         description: the ASDC model id for this resource or service model.
51829       model-version-id:
51830         type: string
51831         description: the ASDC model version for this resource or service model.
51832       persona-model-version:
51833         type: string
51834         description: the ASDC model version for this resource or service model.
51835       model-customization-id:
51836         type: string
51837         description: captures the id of all the configuration used to customize the resource for the service.
51838       widget-model-id:
51839         type: string
51840         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51841       widget-model-version:
51842         type: string
51843         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51844       contrail-service-instance-fqdn:
51845         type: string
51846         description: the Contrail unique ID for a service-instance
51847       module-index:
51848         type: integer
51849         format: int32
51850         description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
51851       selflink:
51852         type: string
51853         description: Path to the controller object.
51854       relationship-list:
51855         type: array
51856         items:
51857           $ref: "#/definitions/relationship"
51858   vf-modules:
51859     description: |
51860       Collection of vf-modules, a deployment unit of VNFCs
51861     properties:
51862       vf-module:
51863         type: array
51864         items:
51865           $ref: "#/definitions/vf-module"
51866   vig-server:
51867     description: |
51868       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
51869       ###### Related Nodes
51870       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
51871
51872       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
51873     required:
51874     - vig-address-type
51875     properties:
51876       vig-address-type:
51877         type: string
51878         description: indicates whether the VIG is for AVPN or INTERNET
51879       ipaddress-v4-vig:
51880         type: string
51881         description: v4 IP of the vig server
51882       ipaddress-v6-vig:
51883         type: string
51884         description: v6 IP of the vig server
51885       resource-version:
51886         type: string
51887         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51888       relationship-list:
51889         type: array
51890         items:
51891           $ref: "#/definitions/relationship"
51892   vig-servers:
51893     properties:
51894       vig-server:
51895         type: array
51896         items:
51897           $ref: "#/definitions/vig-server"
51898   vip-ipv4-address-list:
51899     description: |
51900       IPv4 Address Range
51901       ###### Related Nodes
51902       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
51903       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
51904       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
51905       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
51906
51907     required:
51908     - vip-ipv4-address
51909     properties:
51910       vip-ipv4-address:
51911         type: string
51912         description: IP address
51913       vip-ipv4-prefix-length:
51914         type: integer
51915         format: int64
51916         description: Prefix length, 32 for single address
51917       vlan-id-inner:
51918         type: integer
51919         format: int64
51920         description: Inner VLAN tag
51921       vlan-id-outer:
51922         type: integer
51923         format: int64
51924         description: Outer VLAN tag
51925       is-floating:
51926         type: boolean
51927         description: Indicator of fixed or floating address
51928       resource-version:
51929         type: string
51930         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51931       neutron-network-id:
51932         type: string
51933         description: Neutron network id of the interface that address belongs to
51934       neutron-subnet-id:
51935         type: string
51936         description: Neutron id of subnet that address belongs to
51937       relationship-list:
51938         type: array
51939         items:
51940           $ref: "#/definitions/relationship"
51941   vip-ipv6-address-list:
51942     description: |
51943       IPv6 Address Range
51944       ###### Related Nodes
51945       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
51946       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
51947       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
51948       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
51949
51950     required:
51951     - vip-ipv6-address
51952     properties:
51953       vip-ipv6-address:
51954         type: string
51955         description: IP address
51956       vip-ipv6-prefix-length:
51957         type: integer
51958         format: int64
51959         description: Prefix length, 128 for single address
51960       vlan-id-inner:
51961         type: integer
51962         format: int64
51963         description: Inner VLAN tag
51964       vlan-id-outer:
51965         type: integer
51966         format: int64
51967         description: Outer VLAN tag
51968       is-floating:
51969         type: boolean
51970         description: Indicator of fixed or floating address
51971       resource-version:
51972         type: string
51973         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51974       neutron-network-id:
51975         type: string
51976         description: Neutron network id of the interface that address belongs to
51977       neutron-subnet-id:
51978         type: string
51979         description: Neutron id of subnet that address belongs to
51980       relationship-list:
51981         type: array
51982         items:
51983           $ref: "#/definitions/relationship"
51984   virtual-data-center:
51985     description: |
51986       Virtual organization of cloud infrastructure elements in a data center context
51987       ###### Related Nodes
51988       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
51989       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
51990       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
51991
51992     required:
51993     - vdc-id
51994     - vdc-name
51995     properties:
51996       vdc-id:
51997         type: string
51998         description: Unique ID of the vdc
51999       vdc-name:
52000         type: string
52001         description: Name of the virtual data center
52002       resource-version:
52003         type: string
52004         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52005       relationship-list:
52006         type: array
52007         items:
52008           $ref: "#/definitions/relationship"
52009   virtual-data-centers:
52010     description: |
52011       Virtual organization of cloud infrastructure elements in a data center context
52012     properties:
52013       virtual-data-center:
52014         type: array
52015         items:
52016           $ref: "#/definitions/virtual-data-center"
52017   vlan:
52018     description: |
52019       Definition of vlan
52020       ###### Related Nodes
52021       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
52022       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
52023       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
52024       - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
52025       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
52026       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
52027       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
52028
52029       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
52030       -(2) IF this VLAN node is deleted, this TO node is DELETED also
52031       -(4) IF this TO node is deleted, this VLAN is DELETED also
52032     required:
52033     - vlan-interface
52034     - in-maint
52035     - is-ip-unnumbered
52036     properties:
52037       vlan-interface:
52038         type: string
52039         description: String that identifies the interface
52040       vlan-id-inner:
52041         type: integer
52042         format: int64
52043         description: Inner VLAN tag
52044       vlan-id-outer:
52045         type: integer
52046         format: int64
52047         description: Outer VLAN tag
52048       resource-version:
52049         type: string
52050         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52051       speed-value:
52052         type: string
52053         description: Captures the numeric part of the speed
52054       speed-units:
52055         type: string
52056         description: Captures the units corresponding to the speed
52057       vlan-description:
52058         type: string
52059         description: Used to describe (the service associated with) the vlan
52060       backdoor-connection:
52061         type: string
52062         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
52063       vpn-key:
52064         type: string
52065         description: This indicates the customers VPN ID associated with this vlan
52066       orchestration-status:
52067         type: string
52068         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
52069       in-maint:
52070         type: boolean
52071         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
52072       prov-status:
52073         type: string
52074         description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
52075       is-ip-unnumbered:
52076         type: boolean
52077         description: Flag indicating the interface uses the IP Unnumbered configuration.
52078       relationship-list:
52079         type: array
52080         items:
52081           $ref: "#/definitions/relationship"
52082       l3-interface-ipv4-address-list:
52083         type: array
52084         items:
52085           $ref: "#/definitions/l3-interface-ipv4-address-list"
52086       l3-interface-ipv6-address-list:
52087         type: array
52088         items:
52089           $ref: "#/definitions/l3-interface-ipv6-address-list"
52090   vlans:
52091     properties:
52092       vlan:
52093         type: array
52094         items:
52095           $ref: "#/definitions/vlan"
52096   vnf:
52097     description: |
52098       Abstract vnf class
52099     required:
52100     - vnf-id
52101     properties:
52102       vnf-id:
52103         type: string
52104         description: Unique id of VNF.  This is unique across the graph.
52105   vnf-image:
52106     description: |
52107       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
52108       ###### Related Nodes
52109       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
52110
52111       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
52112
52113     required:
52114     - vnf-image-uuid
52115     - application
52116     - application-vendor
52117     properties:
52118       vnf-image-uuid:
52119         type: string
52120         description: Unique ID of this asset
52121       application:
52122         type: string
52123         description: The application that the image instantiates.
52124       application-vendor:
52125         type: string
52126         description: The vendor of the application.
52127       application-version:
52128         type: string
52129         description: The version of the application.
52130       selflink:
52131         type: string
52132         description: URL to endpoint where AAI can get more details
52133       resource-version:
52134         type: string
52135         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52136       relationship-list:
52137         type: array
52138         items:
52139           $ref: "#/definitions/relationship"
52140   vnf-images:
52141     description: |
52142       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
52143     properties:
52144       vnf-image:
52145         type: array
52146         items:
52147           $ref: "#/definitions/vnf-image"
52148   vnfc:
52149     description: |
52150       ###### Related Nodes
52151       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
52152       - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
52153       - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
52154       - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
52155       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
52156       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
52157       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
52158       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
52159
52160       -(1) IF this VNFC node is deleted, this FROM node is DELETED also
52161       -(4) IF this TO node is deleted, this VNFC is DELETED also
52162     required:
52163     - vnfc-name
52164     - nfc-naming-code
52165     - nfc-function
52166     - in-maint
52167     - is-closed-loop-disabled
52168     properties:
52169       vnfc-name:
52170         type: string
52171         description: Unique ID of vnfc.
52172       nfc-naming-code:
52173         type: string
52174         description: Short code that is used in naming instances of the item being modeled
52175       nfc-function:
52176         type: string
52177         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
52178       prov-status:
52179         type: string
52180         description: prov status of this vnfc
52181       orchestration-status:
52182         type: string
52183         description: Orchestration status of this VNF, mastered by APP-C
52184       ipaddress-v4-oam-vip:
52185         type: string
52186         description: Oam V4 vip address of this vnfc
52187       in-maint:
52188         type: boolean
52189         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
52190       is-closed-loop-disabled:
52191         type: boolean
52192         description: used to indicate whether closed loop function is enabled on this node
52193       group-notation:
52194         type: string
52195         description: Group notation of VNFC
52196       model-invariant-id:
52197         type: string
52198         description: the ASDC model id for this resource or service model.
52199       model-version-id:
52200         type: string
52201         description: the ASDC model version for this resource or service model.
52202       resource-version:
52203         type: string
52204         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52205       relationship-list:
52206         type: array
52207         items:
52208           $ref: "#/definitions/relationship"
52209       l3-interface-ipv4-address-list:
52210         type: array
52211         items:
52212           $ref: "#/definitions/l3-interface-ipv4-address-list"
52213       l3-interface-ipv6-address-list:
52214         type: array
52215         items:
52216           $ref: "#/definitions/l3-interface-ipv6-address-list"
52217   vnfcs:
52218     description: |
52219       virtual network components associated with a vserver from application controller.
52220     properties:
52221       vnfc:
52222         type: array
52223         items:
52224           $ref: "#/definitions/vnfc"
52225   volume:
52226     description: |
52227       Ephemeral Block storage volume.
52228       ###### Related Nodes
52229       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
52230
52231       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
52232     required:
52233     - volume-id
52234     - volume-selflink
52235     properties:
52236       volume-id:
52237         type: string
52238         description: Unique ID of block storage volume relative to the vserver.
52239       volume-selflink:
52240         type: string
52241         description: URL to endpoint where AAI can get more details
52242       resource-version:
52243         type: string
52244         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52245       relationship-list:
52246         type: array
52247         items:
52248           $ref: "#/definitions/relationship"
52249   volume-group:
52250     description: |
52251       Persistent block-level storage.
52252       ###### Related Nodes
52253       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
52254       - TO complex( volume-group LocatedIn complex, MANY2ONE)
52255       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
52256       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
52257       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
52258
52259     required:
52260     - volume-group-id
52261     - volume-group-name
52262     - vnf-type
52263     properties:
52264       volume-group-id:
52265         type: string
52266         description: Unique ID of volume-group.
52267       volume-group-name:
52268         type: string
52269         description: Name of the volume group.
52270       heat-stack-id:
52271         type: string
52272         description: Heat stack id corresponding to this volume-group
52273       vnf-type:
52274         type: string
52275         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
52276       orchestration-status:
52277         type: string
52278         description: Orchestration status of this volume-group
52279       model-customization-id:
52280         type: string
52281         description: captures the id of all the configuration used to customize the resource for the service.
52282       vf-module-model-customization-id:
52283         type: string
52284         description: helps relate the volume group to the vf-module whose components will require the volume group
52285       resource-version:
52286         type: string
52287         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52288       relationship-list:
52289         type: array
52290         items:
52291           $ref: "#/definitions/relationship"
52292   volume-groups:
52293     description: |
52294       Collection of persistent block-level storage.
52295     properties:
52296       volume-group:
52297         type: array
52298         items:
52299           $ref: "#/definitions/volume-group"
52300   volumes:
52301     description: |
52302       Collection of ephemeral Block storage volumes.
52303     properties:
52304       volume:
52305         type: array
52306         items:
52307           $ref: "#/definitions/volume"
52308   vpls-pe:
52309     description: |
52310       VPLS Provider Edge routers.
52311       ###### Related Nodes
52312       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
52313       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
52314       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
52315       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
52316
52317       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
52318     required:
52319     - equipment-name
52320     properties:
52321       equipment-name:
52322         type: string
52323       prov-status:
52324         type: string
52325         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
52326       ipv4-oam-address:
52327         type: string
52328         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
52329       equipment-role:
52330         type: string
52331         description: Client should send valid enumerated value, e.g., VPLS-PE.
52332       vlan-id-outer:
52333         type: integer
52334         format: int64
52335         description: Temporary location for stag to get to VCE
52336       resource-version:
52337         type: string
52338         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52339       relationship-list:
52340         type: array
52341         items:
52342           $ref: "#/definitions/relationship"
52343       p-interfaces:
52344         type: array
52345         items:
52346           $ref: "#/definitions/p-interface"
52347       lag-interfaces:
52348         type: array
52349         items:
52350           $ref: "#/definitions/lag-interface"
52351   vpls-pes:
52352     description: |
52353       Collection of VPLS Provider Edge routers
52354     properties:
52355       vpls-pe:
52356         type: array
52357         items:
52358           $ref: "#/definitions/vpls-pe"
52359   vpn-binding:
52360     description: |
52361       VPN binding
52362       ###### Related Nodes
52363       - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
52364       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
52365       - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
52366       - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
52367
52368       -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
52369       -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
52370
52371     required:
52372     - vpn-id
52373     - vpn-name
52374     properties:
52375       vpn-id:
52376         type: string
52377         description: VPN ID, globally unique within A&AI
52378       vpn-name:
52379         type: string
52380         description: VPN Name
52381       vpn-platform:
52382         type: string
52383         description: the platform associated with the VPN example AVPN, Mobility
52384       vpn-type:
52385         type: string
52386         description: Type of the vpn, should be taken from enumerated/valid values
52387       vpn-region:
52388         type: string
52389         description: region of customer vpn
52390       customer-vpn-id:
52391         type: string
52392         description: id for this customer vpn
52393       route-distinguisher:
52394         type: string
52395         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
52396       resource-version:
52397         type: string
52398         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52399       route-targets:
52400         type: array
52401         items:
52402           $ref: "#/definitions/route-target"
52403       relationship-list:
52404         type: array
52405         items:
52406           $ref: "#/definitions/relationship"
52407         description: l3-networks relate to vpn-bindings
52408   vpn-bindings:
52409     properties:
52410       vpn-binding:
52411         type: array
52412         items:
52413           $ref: "#/definitions/vpn-binding"
52414   vserver:
52415     description: |
52416       Virtual Servers, aka virtual machine or VM.
52417       ###### Related Nodes
52418       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
52419       - TO flavor( vserver Uses flavor, MANY2ONE)
52420       - TO image( vserver Uses image, MANY2ONE)
52421       - TO pserver( vserver HostedOn pserver, MANY2ONE)
52422       - TO snapshot( vserver Uses snapshot, ONE2ONE)
52423       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
52424       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
52425       - FROM vce( vce HostedOn vserver, ONE2MANY)
52426       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
52427       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
52428       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
52429
52430       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
52431       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
52432     required:
52433     - vserver-id
52434     - vserver-name
52435     - vserver-selflink
52436     - in-maint
52437     - is-closed-loop-disabled
52438     properties:
52439       vserver-id:
52440         type: string
52441         description: Unique identifier for this vserver relative to its tenant
52442       vserver-name:
52443         type: string
52444         description: Name of vserver
52445       vserver-name2:
52446         type: string
52447         description: Alternative name of vserver
52448       prov-status:
52449         type: string
52450         description: Trigger for operational monitoring of this resource by Service Assurance systems.
52451       vserver-selflink:
52452         type: string
52453         description: URL to endpoint where AAI can get more details
52454       in-maint:
52455         type: boolean
52456         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
52457       is-closed-loop-disabled:
52458         type: boolean
52459         description: Used to indicate whether closed loop function is enabled on this node
52460       resource-version:
52461         type: string
52462         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52463       volumes:
52464         type: array
52465         items:
52466           $ref: "#/definitions/volume"
52467       relationship-list:
52468         type: array
52469         items:
52470           $ref: "#/definitions/relationship"
52471       l-interfaces:
52472         type: array
52473         items:
52474           $ref: "#/definitions/l-interface"
52475   vservers:
52476     description: |
52477       Collection of virtual Servers, aka virtual machines or VMs.
52478     properties:
52479       vserver:
52480         type: array
52481         items:
52482           $ref: "#/definitions/vserver"
52483   zone:
52484     description: |
52485       A zone is a grouping of assets in a location homing to the same connections into the CBB
52486       ###### Related Nodes
52487       - TO complex( zone LocatedIn complex, MANY2ONE)
52488       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
52489       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
52490       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
52491       - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
52492
52493     required:
52494     - zone-id
52495     - zone-name
52496     - design-type
52497     - zone-context
52498     properties:
52499       zone-id:
52500         type: string
52501         description: Code assigned by AIC to the zone
52502       zone-name:
52503         type: string
52504         description: English name associated with the zone
52505       design-type:
52506         type: string
52507         description: Design of zone [Medium/Large…]
52508       zone-context:
52509         type: string
52510         description: Context of zone [production/test]
52511       status:
52512         type: string
52513         description: Status of a zone.
52514       resource-version:
52515         type: string
52516         description: Concurrency value
52517       relationship-list:
52518         type: array
52519         items:
52520           $ref: "#/definitions/relationship"
52521   zones:
52522     description: |
52523       Collection of zones
52524     properties:
52525       zone:
52526         type: array
52527         items:
52528           $ref: "#/definitions/zone"
52529 patchDefinitions:
52530   action:
52531     properties:
52532       action-type:
52533         type: string
52534       action-data:
52535         type: array
52536         items:
52537           $ref: "#/patchDefinitions/action-data"
52538   action-data:
52539     properties:
52540       property-name:
52541         type: string
52542       property-value:
52543         type: string
52544   actions:
52545     description: |
52546       APIs that are more action related than REST (e.g., notify, update).
52547     properties:
52548       update:
52549         type: object
52550         $ref: "#/patchDefinitions/update"
52551       notify:
52552         type: object
52553         $ref: "#/patchDefinitions/notify"
52554   allotted-resource:
52555     description: |
52556       Represents a slice or partial piece of a resource that gets separately allotted
52557       ###### Related Nodes
52558       - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
52559       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
52560       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
52561       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
52562       - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
52563       - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
52564       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
52565       - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
52566       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
52567       - TO model-ver( allotted-resource IsA model-ver, Many2One)
52568       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
52569       - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
52570       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
52571       - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
52572
52573       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
52574       -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
52575       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
52576     required:
52577     - id
52578     properties:
52579       id:
52580         type: string
52581         description: Allotted Resource id UUID assigned to this instance.
52582       description:
52583         type: string
52584         description: The descriptive information assigned to this allotted resource instance
52585       selflink:
52586         type: string
52587         description: Link back to more information in the controller
52588       model-invariant-id:
52589         type: string
52590         description: the ASDC model id for this resource or service model.
52591       model-version-id:
52592         type: string
52593         description: the ASDC model version for this resource or service model.
52594       persona-model-version:
52595         type: string
52596         description: the ASDC model version for this resource or service model.
52597   allotted-resources:
52598     description: |
52599       This object is used to store slices of services being offered
52600     properties:
52601       allotted-resource:
52602         type: array
52603         items:
52604           $ref: "#/patchDefinitions/allotted-resource"
52605   availability-zone:
52606     description: |
52607       Availability zone, a collection of compute hosts/pservers
52608       ###### Related Nodes
52609       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
52610       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
52611       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
52612       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
52613       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
52614       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
52615       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
52616       - FROM vce( vce Uses availability-zone, MANY2MANY)
52617
52618       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
52619       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
52620
52621     required:
52622     - availability-zone-name
52623     - hypervisor-type
52624     properties:
52625       availability-zone-name:
52626         type: string
52627         description: Name of the availability zone.  Unique across a cloud region
52628       hypervisor-type:
52629         type: string
52630         description: Type of hypervisor.  Source of truth should define valid values.
52631       operational-status:
52632         type: string
52633         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
52634   availability-zones:
52635     description: |
52636       Collection of availability zones
52637     properties:
52638       availability-zone:
52639         type: array
52640         items:
52641           $ref: "#/patchDefinitions/availability-zone"
52642   az-and-dvs-switches:
52643     properties:
52644       dvs-switches:
52645         type: object
52646         $ref: "#/patchDefinitions/dvs-switches"
52647       availability-zone:
52648         type: object
52649         $ref: "#/patchDefinitions/availability-zone"
52650   business:
52651     description: |
52652       Namespace for business related constructs
52653     properties:
52654       connectors:
52655         type: array
52656         items:
52657           $ref: "#/patchDefinitions/connector"
52658       customers:
52659         type: array
52660         items:
52661           $ref: "#/patchDefinitions/customer"
52662       lines-of-business:
52663         type: array
52664         items:
52665           $ref: "#/patchDefinitions/line-of-business"
52666       owning-entities:
52667         type: array
52668         items:
52669           $ref: "#/patchDefinitions/owning-entity"
52670       platforms:
52671         type: array
52672         items:
52673           $ref: "#/patchDefinitions/platform"
52674       projects:
52675         type: array
52676         items:
52677           $ref: "#/patchDefinitions/project"
52678   class-of-service:
52679     description: |
52680       ###### Related Nodes
52681       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
52682
52683       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
52684     required:
52685     - cos
52686     properties:
52687       cos:
52688         type: string
52689         description: unique identifier of probe
52690       probe-id:
52691         type: string
52692         description: identifier of probe
52693       probe-type:
52694         type: string
52695         description: type of probe
52696   classes-of-service:
52697     description: |
52698       class-of-service of probe
52699     properties:
52700       class-of-service:
52701         type: array
52702         items:
52703           $ref: "#/patchDefinitions/class-of-service"
52704   cloud-infrastructure:
52705     description: |
52706       Namespace for cloud infrastructure.
52707     properties:
52708       complexes:
52709         type: array
52710         items:
52711           $ref: "#/patchDefinitions/complex"
52712       cloud-regions:
52713         type: array
52714         items:
52715           $ref: "#/patchDefinitions/cloud-region"
52716       network-profiles:
52717         type: array
52718         items:
52719           $ref: "#/patchDefinitions/network-profile"
52720       pservers:
52721         type: array
52722         items:
52723           $ref: "#/patchDefinitions/pserver"
52724       virtual-data-centers:
52725         type: array
52726         items:
52727           $ref: "#/patchDefinitions/virtual-data-center"
52728       operational-environments:
52729         type: array
52730         items:
52731           $ref: "#/patchDefinitions/operational-environment"
52732   cloud-region:
52733     description: |
52734       cloud-region designates an installation of a cloud cluster or region or instantiation.
52735       ###### Related Nodes
52736       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
52737       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
52738       - TO zone( cloud-region LocatedIn zone, MANY2ONE)
52739       - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
52740       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
52741       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
52742       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
52743       - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)
52744       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
52745       - FROM image( image BelongsTo cloud-region, MANY2ONE)
52746       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
52747       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
52748       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
52749       - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
52750       - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
52751       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
52752       - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
52753       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
52754
52755       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
52756       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
52757
52758     required:
52759     - cloud-owner
52760     - cloud-region-id
52761     - sriov-automation
52762     properties:
52763       cloud-owner:
52764         type: string
52765         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
52766       cloud-region-id:
52767         type: string
52768         description: Identifier used by the vendor for the region. Second part of composite key
52769       cloud-type:
52770         type: string
52771         description: Type of the cloud (e.g., openstack)
52772       owner-defined-type:
52773         type: string
52774         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
52775       cloud-region-version:
52776         type: string
52777         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
52778       identity-url:
52779         type: string
52780         description: URL of the keystone identity service
52781       cloud-zone:
52782         type: string
52783         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
52784       complex-name:
52785         type: string
52786         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
52787       sriov-automation:
52788         type: boolean
52789         description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
52790       cloud-extra-info:
52791         type: string
52792         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
52793       cloud-epa-caps:
52794         type: string
52795         description: MultiVIM will discover and expose EPA capabilities.
52796   cloud-regions:
52797     properties:
52798       cloud-region:
52799         type: array
52800         items:
52801           $ref: "#/patchDefinitions/cloud-region"
52802   complex:
52803     description: |
52804       Collection of physical locations that can house cloud-regions.
52805       ###### Related Nodes
52806       - TO l3-network( complex Uses l3-network, MANY2MANY)
52807       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
52808       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
52809       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
52810       - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
52811       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
52812       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
52813       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
52814       - FROM vce( vce LocatedIn complex, MANY2MANY)
52815       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
52816       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
52817       - FROM zone( zone LocatedIn complex, MANY2ONE)
52818
52819       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
52820       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
52821
52822     required:
52823     - physical-location-id
52824     - physical-location-type
52825     - street1
52826     - city
52827     - postal-code
52828     - country
52829     - region
52830     properties:
52831       physical-location-id:
52832         type: string
52833         description: Unique identifier for physical location, e.g., CLLI
52834       data-center-code:
52835         type: string
52836         description: Data center code which can be an alternate way to identify a complex
52837       complex-name:
52838         type: string
52839         description: Gamma complex name for LCP instance.
52840       identity-url:
52841         type: string
52842         description: URL of the keystone identity service
52843   complexes:
52844     description: |
52845       Collection of physical locations that can house cloud-regions.
52846     properties:
52847       complex:
52848         type: array
52849         items:
52850           $ref: "#/patchDefinitions/complex"
52851   configuration:
52852     description: |
52853       Port Mirror Configuration.
52854       ###### Related Nodes
52855       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
52856       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
52857       - TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
52858       - TO pnf( configuration AppliesTo pnf, ONE2MANY)
52859       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
52860       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
52861       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
52862       - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
52863       - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
52864       - FROM evc( evc BelongsTo configuration, ONE2ONE)(1)
52865       - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)
52866
52867       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
52868       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
52869       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
52870     required:
52871     - configuration-id
52872     - configuration-type
52873     - configuration-sub-type
52874     - orchestration-status
52875     - operational-status
52876     - configuration-selflink
52877     - model-customization-id
52878     properties:
52879       configuration-id:
52880         type: string
52881         description: UUID assigned to configuration.
52882       management-option:
52883         type: string
52884         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
52885       configuration-name:
52886         type: string
52887         description: Name of the configuration.
52888       configuration-type:
52889         type: string
52890         description: port-mirroring-configuration.
52891       configuration-sub-type:
52892         type: string
52893         description: vprobe, pprobe.
52894       model-invariant-id:
52895         type: string
52896         description: the ASDC model id for this resource or service model.
52897       model-version-id:
52898         type: string
52899         description: the ASDC model version for this resource or service model.
52900       orchestration-status:
52901         type: string
52902         description: Orchestration status of the configuration.
52903       operational-status:
52904         type: string
52905         description: Indicator for whether the resource is considered operational.
52906       configuration-selflink:
52907         type: string
52908         description: URL to endpoint where AAI can get more details from SDN-GC.
52909       model-customization-id:
52910         type: string
52911         description: id of  the configuration used to customize the resource
52912       tunnel-bandwidth:
52913         type: string
52914         description: DHV Site Effective Bandwidth
52915       vendor-allowed-max-bandwidth:
52916         type: string
52917         description: Velocloud Nominal Throughput - VNT
52918   configurations:
52919     description: |
52920       Collection of configurations
52921     properties:
52922       configuration:
52923         type: array
52924         items:
52925           $ref: "#/patchDefinitions/configuration"
52926   connector:
52927     description: |
52928       Collection of resource instances used to connect a variety of disparate inventory widgets
52929       ###### Related Nodes
52930       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
52931       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
52932       - FROM service-instance( service-instance Uses connector, MANY2MANY)
52933
52934       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
52935     required:
52936     - resource-instance-id
52937     properties:
52938       resource-instance-id:
52939         type: string
52940         description: Unique id of resource instance.
52941   connectors:
52942     description: |
52943       Collection of resource instances used to connect a variety of disparate inventory widgets
52944     properties:
52945       connector:
52946         type: array
52947         items:
52948           $ref: "#/patchDefinitions/connector"
52949   constrained-element-set:
52950     description: |
52951       This is how we would capture constraints defining allowed sets of elements.
52952       ###### Related Nodes
52953       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
52954       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
52955       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
52956
52957       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
52958       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
52959     required:
52960     - constrained-element-set-uuid
52961     - constraint-type
52962     - check-type
52963     properties:
52964       constrained-element-set-uuid:
52965         type: string
52966       constraint-type:
52967         type: string
52968       check-type:
52969         type: string
52970   constrained-element-sets:
52971     properties:
52972       constrained-element-set:
52973         type: array
52974         items:
52975           $ref: "#/patchDefinitions/constrained-element-set"
52976   ctag-assignment:
52977     description: |
52978       ###### Related Nodes
52979       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
52980       - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
52981
52982       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
52983     required:
52984     - vlan-id-inner
52985     properties:
52986       vlan-id-inner:
52987         type: integer
52988         format: int64
52989         description: id.
52990   ctag-assignments:
52991     properties:
52992       ctag-assignment:
52993         type: array
52994         items:
52995           $ref: "#/patchDefinitions/ctag-assignment"
52996   ctag-pool:
52997     description: |
52998       A collection of C tags (vlan tags) grouped for a specific purpose.
52999       ###### Related Nodes
53000       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
53001       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
53002       - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
53003       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
53004
53005       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
53006     required:
53007     - target-pe
53008     - availability-zone-name
53009     - ctag-pool-purpose
53010     properties:
53011       target-pe:
53012         type: string
53013         description: The Target provider edge router
53014       availability-zone-name:
53015         type: string
53016         description: Name of the availability zone
53017       ctag-pool-purpose:
53018         type: string
53019         description: Describes what the intended purpose of this pool is.
53020       ctag-values:
53021         type: string
53022         description: Comma separated list of ctags
53023   ctag-pools:
53024     properties:
53025       ctag-pool:
53026         type: array
53027         items:
53028           $ref: "#/patchDefinitions/ctag-pool"
53029   customer:
53030     description: |
53031       customer identifiers to provide linkage back to BSS information.
53032       ###### Related Nodes
53033       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
53034
53035       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
53036     required:
53037     - global-customer-id
53038     - subscriber-name
53039     - subscriber-type
53040     properties:
53041       global-customer-id:
53042         type: string
53043         description: Global customer id used across ECOMP to uniquely identify customer.
53044       subscriber-name:
53045         type: string
53046         description: Subscriber name, an alternate way to retrieve a customer.
53047       subscriber-type:
53048         type: string
53049         description: Subscriber type, a way to provide VID with only the INFRA customers.
53050   customers:
53051     description: |
53052       Collection of customer identifiers to provide linkage back to BSS information.
53053     properties:
53054       customer:
53055         type: array
53056         items:
53057           $ref: "#/patchDefinitions/customer"
53058   cvlan-tag-entry:
53059     required:
53060     - cvlan-tag
53061     properties:
53062       cvlan-tag:
53063         type: integer
53064         format: int64
53065         description: See mis-na-virtualization-platform.yang
53066   cvlan-tags:
53067     properties:
53068       cvlan-tag-entry:
53069         type: array
53070         items:
53071           $ref: "#/patchDefinitions/cvlan-tag-entry"
53072   dvs-switch:
53073     description: |
53074       Digital virtual switch metadata, used by SDN-C to configure VCEs.  A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
53075       ###### Related Nodes
53076       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
53077       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
53078
53079     required:
53080     - switch-name
53081     - vcenter-url
53082     properties:
53083       switch-name:
53084         type: string
53085         description: DVS switch name
53086       vcenter-url:
53087         type: string
53088         description: URL used to reach the vcenter
53089   dvs-switches:
53090     description: |
53091       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
53092     properties:
53093       dvs-switch:
53094         type: array
53095         items:
53096           $ref: "#/patchDefinitions/dvs-switch"
53097   edge-prop-names:
53098     description: |
53099       Internal map to define the properties of an edge and interpret the map EdgeRules
53100     properties:
53101       edgeLabel:
53102         type: string
53103       direction:
53104         type: string
53105       multiplicityRule:
53106         type: string
53107       contains-other-v:
53108         type: string
53109       delete-other-v:
53110         type: string
53111       SVC-INFRA:
53112         type: string
53113       prevent-delete:
53114         type: string
53115       aai-uuid:
53116         type: string
53117   edge-tag-query-request:
53118     properties:
53119       edge-tag:
53120         type: string
53121       result-detail:
53122         type: string
53123       start-node-type:
53124         type: string
53125       start-node-filter:
53126         type: array
53127         items:
53128           $ref: "#/patchDefinitions/start-node-filter"
53129       include-node-filter:
53130         type: array
53131         items:
53132           $ref: "#/patchDefinitions/include-node-filter"
53133       secondary-filter:
53134         type: array
53135         items:
53136           $ref: "#/patchDefinitions/secondary-filter"
53137   edge-tag-query-result:
53138     properties:
53139       tagged-inventory-item-list:
53140         type: array
53141         items:
53142           $ref: "#/patchDefinitions/tagged-inventory-item-list"
53143   element-choice-set:
53144     description: |
53145       This is how we would capture constraints defining allowed sets of elements.
53146       ###### Related Nodes
53147       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
53148       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
53149
53150       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
53151       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
53152     required:
53153     - element-choice-set-uuid
53154     - element-choice-set-name
53155     properties:
53156       element-choice-set-uuid:
53157         type: string
53158       element-choice-set-name:
53159         type: string
53160       cardinality:
53161         type: string
53162   element-choice-sets:
53163     properties:
53164       element-choice-set:
53165         type: array
53166         items:
53167           $ref: "#/patchDefinitions/element-choice-set"
53168   entitlement:
53169     description: |
53170       Metadata for entitlement group.
53171       ###### Related Nodes
53172       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
53173       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
53174
53175       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
53176     required:
53177     - group-uuid
53178     - resource-uuid
53179     properties:
53180       group-uuid:
53181         type: string
53182         description: Unique ID for the entitlement group the resource comes from, should be uuid.
53183       resource-uuid:
53184         type: string
53185         description: Unique ID of an entitlement resource.
53186   entitlements:
53187     description: |
53188       Entitlements, keyed by group-uuid and resource-uuid, related to license management
53189     properties:
53190       entitlement:
53191         type: array
53192         items:
53193           $ref: "#/patchDefinitions/entitlement"
53194   esr-ems:
53195     description: |
53196       Persist EMS address information used by EMS driver.
53197       ###### Related Nodes
53198       - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
53199
53200       -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
53201     required:
53202     - ems-id
53203     properties:
53204       ems-id:
53205         type: string
53206         description: Unique ID of EMS.
53207   esr-ems-list:
53208     properties:
53209       esr-ems:
53210         type: array
53211         items:
53212           $ref: "#/patchDefinitions/esr-ems"
53213   esr-system-info:
53214     description: |
53215       Persist common address information of external systems.
53216       ###### Related Nodes
53217       - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
53218       - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
53219       - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
53220       - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
53221
53222       -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
53223     required:
53224     - esr-system-info-id
53225     - user-name
53226     - password
53227     - system-type
53228     properties:
53229       esr-system-info-id:
53230         type: string
53231         description: Unique ID of esr system info.
53232       system-name:
53233         type: string
53234         description: name of external system.
53235       type:
53236         type: string
53237         description: type of external systems.
53238       vendor:
53239         type: string
53240         description: vendor of external systems.
53241       version:
53242         type: string
53243         description: version of external systems.
53244       service-url:
53245         type: string
53246         description: url used to access external systems.
53247       user-name:
53248         type: string
53249         description: username used to access external systems.
53250       password:
53251         type: string
53252         description: password used to access external systems.
53253       system-type:
53254         type: string
53255         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
53256       protocol:
53257         type: string
53258         description: protocol of third party SDNC, for example netconf/snmp.
53259       ssl-cacert:
53260         type: string
53261         description: ca file content if enabled ssl on auth-url.
53262       ssl-insecure:
53263         type: boolean
53264         description: Whether to verify VIM's certificate.
53265       ip-address:
53266         type: string
53267         description: service IP of ftp server.
53268       port:
53269         type: string
53270         description: service port of ftp server.
53271       cloud-domain:
53272         type: string
53273         description: domain info for authentication.
53274       default-tenant:
53275         type: string
53276         description: default tenant of VIM.
53277       passive:
53278         type: boolean
53279         description: ftp passive mode or not.
53280       remote-path:
53281         type: string
53282         description: resource or performance data file path.
53283       system-status:
53284         type: string
53285         description: the status of external system.
53286   esr-system-info-list:
53287     description: |
53288       Collection of persistent block-level external system auth info.
53289     properties:
53290       esr-system-info:
53291         type: array
53292         items:
53293           $ref: "#/patchDefinitions/esr-system-info"
53294   esr-thirdparty-sdnc:
53295     description: |
53296       Persist SDNC address information used by ONAP SDNC.
53297       ###### Related Nodes
53298       - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
53299       - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
53300
53301       -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
53302     required:
53303     - thirdparty-sdnc-id
53304     properties:
53305       thirdparty-sdnc-id:
53306         type: string
53307         description: Unique ID of SDNC.
53308       location:
53309         type: string
53310         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
53311       product-name:
53312         type: string
53313         description: password used to access SDNC server.
53314   esr-thirdparty-sdnc-list:
53315     properties:
53316       esr-thirdparty-sdnc:
53317         type: array
53318         items:
53319           $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
53320   esr-vnfm:
53321     description: |
53322       Persist VNFM address information used by VF-C.
53323       ###### Related Nodes
53324       - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
53325
53326       -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
53327     required:
53328     - vnfm-id
53329     properties:
53330       vnfm-id:
53331         type: string
53332         description: Unique ID of VNFM.
53333       vim-id:
53334         type: string
53335         description: indecate the VIM to deploy VNF.
53336       certificate-url:
53337         type: string
53338         description: certificate url of VNFM.
53339   esr-vnfm-list:
53340     properties:
53341       esr-vnfm:
53342         type: array
53343         items:
53344           $ref: "#/patchDefinitions/esr-vnfm"
53345   evc:
53346     description: |
53347       evc object is an optional child object of the Configuration object.
53348       ###### Related Nodes
53349       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
53350
53351       -(4) IF this TO node is deleted, this EVC is DELETED also
53352     required:
53353     - evc-id
53354     properties:
53355       evc-id:
53356         type: string
53357         description: Unique/key field for the evc object
53358       forwarding-path-topology:
53359         type: string
53360         description: Point-to-Point, Multi-Point
53361       cir-value:
53362         type: string
53363         description: Commited Information Rate
53364       cir-units:
53365         type: string
53366         description: CIR units
53367       connection-diversity-group-id:
53368         type: string
53369         description: Diversity Group ID
53370       service-hours:
53371         type: string
53372         description: formerly Performance Group
53373       esp-evc-circuit-id:
53374         type: string
53375         description: EVC Circuit ID of ESP EVC
53376       esp-evc-cir-value:
53377         type: string
53378         description: Committed Information Rate (For ESP)
53379       esp-evc-cir-units:
53380         type: string
53381         description: CIR units (For ESP)
53382       esp-itu-code:
53383         type: string
53384         description: Identifies ESP
53385       collector-pop-clli:
53386         type: string
53387         description: Collector POP CLLI (from the hostname of the access pnf)
53388       inter-connect-type-ingress:
53389         type: string
53390         description: Interconnect type on ingress side of EVC.
53391       tagmode-access-ingress:
53392         type: string
53393         description: tagode for collector side of EVC
53394       tagmode-access-egress:
53395         type: string
53396         description: tagMode for network side of EVC
53397   evcs:
53398     properties:
53399       evc:
53400         type: array
53401         items:
53402           $ref: "#/patchDefinitions/evc"
53403   external-system:
53404     description: |
53405       Namespace for external system.
53406     properties:
53407       esr-ems-list:
53408         type: object
53409         $ref: "#/patchDefinitions/esr-ems-list"
53410       esr-vnfm-list:
53411         type: object
53412         $ref: "#/patchDefinitions/esr-vnfm-list"
53413       esr-thirdparty-sdnc-list:
53414         type: object
53415         $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
53416   extra-properties:
53417     description: |
53418       Extra properties for inventory item for response list
53419     properties:
53420       extra-property:
53421         type: array
53422         items:
53423           $ref: "#/patchDefinitions/extra-property"
53424   extra-property:
53425     properties:
53426       property-name:
53427         type: string
53428       property-value:
53429         type: string
53430   flavor:
53431     description: |
53432       Openstack flavor.
53433       ###### Related Nodes
53434       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
53435       - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)
53436       - FROM vserver( vserver Uses flavor, MANY2ONE)
53437
53438       -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
53439
53440     required:
53441     - flavor-id
53442     - flavor-name
53443     - flavor-selflink
53444     properties:
53445       flavor-id:
53446         type: string
53447         description: Flavor id, expected to be unique across cloud-region.
53448       flavor-name:
53449         type: string
53450         description: Cloud Region Flavor name
53451       flavor-vcpus:
53452         type: integer
53453         format: int32
53454         description: Number of CPUs
53455       flavor-ram:
53456         type: integer
53457         format: int32
53458         description: Amount of memory
53459       flavor-disk:
53460         type: integer
53461         format: int32
53462         description: Disk space
53463       flavor-ephemeral:
53464         type: integer
53465         format: int32
53466         description: Amount of ephemeral disk space
53467       flavor-swap:
53468         type: string
53469         description: amount of swap space allocation
53470       flavor-is-public:
53471         type: boolean
53472         description: whether flavor is available to all users or private to the tenant it was created in.
53473       flavor-selflink:
53474         type: string
53475         description: URL to endpoint where AAI can get more details
53476       flavor-disabled:
53477         type: boolean
53478         description: Boolean as to whether this flavor is no longer enabled
53479       hpa-capabilities:
53480         type: array
53481         items:
53482           $ref: "#/patchDefinitions/hpa-capability"
53483         description: List of flavor specific HPA Capabilities
53484   flavors:
53485     description: |
53486       Collection of openstack flavors.
53487     properties:
53488       flavor:
53489         type: array
53490         items:
53491           $ref: "#/patchDefinitions/flavor"
53492   forwarder:
53493     description: |
53494       Entity describing a sequenced segment of forwarding path
53495       ###### Related Nodes
53496       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
53497       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
53498       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
53499       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
53500       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
53501
53502       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
53503       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
53504     required:
53505     - sequence
53506     properties:
53507       sequence:
53508         type: integer
53509         format: int32
53510         description: Unique ID of this segmentation
53511       forwarder-role:
53512         type: string
53513         description: ingress, intermediate, egress
53514   forwarder-evc:
53515     description: |
53516       forwarder object is an optional child object of the Configuration object.
53517       ###### Related Nodes
53518       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
53519
53520       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
53521     required:
53522     - forwarder-evc-id
53523     properties:
53524       forwarder-evc-id:
53525         type: string
53526         description: Key for forwarder-evc object
53527       circuit-id:
53528         type: string
53529         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
53530       ivlan:
53531         type: string
53532         description: Internal VLAN.
53533       svlan:
53534         type: string
53535         description: SVLAN value for ingress of egress forwarder.
53536       cvlan:
53537         type: string
53538         description: CVLAN value for ingress of egress forwarder.
53539   forwarder-evcs:
53540     properties:
53541       forwarder-evc:
53542         type: array
53543         items:
53544           $ref: "#/patchDefinitions/forwarder-evc"
53545   forwarders:
53546     properties:
53547       forwarder:
53548         type: array
53549         items:
53550           $ref: "#/patchDefinitions/forwarder"
53551   forwarding-path:
53552     description: |
53553       Entity that describes the sequenced forwarding path between interfaces of services or resources
53554       ###### Related Nodes
53555       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
53556       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
53557       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
53558
53559       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
53560       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
53561       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
53562     required:
53563     - forwarding-path-id
53564     - forwarding-path-name
53565     properties:
53566       forwarding-path-id:
53567         type: string
53568         description: Unique ID of this FP
53569       forwarding-path-name:
53570         type: string
53571         description: Name of the FP
53572   forwarding-paths:
53573     properties:
53574       forwarding-path:
53575         type: array
53576         items:
53577           $ref: "#/patchDefinitions/forwarding-path"
53578   generic-vnf:
53579     description: |
53580       General purpose VNF
53581       ###### Related Nodes
53582       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
53583       - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
53584       - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
53585       - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
53586       - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
53587       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
53588       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
53589       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
53590       - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
53591       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
53592       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
53593       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
53594       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
53595       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
53596       - TO model-ver( generic-vnf IsA model-ver, Many2One)
53597       - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
53598       - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
53599       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
53600       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
53601       - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
53602       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
53603       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
53604       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
53605       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
53606       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
53607       - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
53608       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
53609       - FROM platform( platform Uses generic-vnf, MANY2MANY)
53610
53611       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
53612       -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
53613     required:
53614     - vnf-id
53615     - vnf-name
53616     - vnf-type
53617     - in-maint
53618     - is-closed-loop-disabled
53619     properties:
53620       vnf-id:
53621         type: string
53622         description: Unique id of VNF.  This is unique across the graph.
53623       vnf-instance-id:
53624         type: string
53625         description: vnf instance id.
53626       vnf-name:
53627         type: string
53628         description: Name of VNF.
53629       vnf-name2:
53630         type: string
53631         description: Alternate name of VNF.
53632       vnf-type:
53633         type: string
53634         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
53635       service-id:
53636         type: string
53637         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
53638       regional-resource-zone:
53639         type: string
53640         description: Regional way of organizing pservers, source of truth should define values
53641       prov-status:
53642         type: string
53643         description: Trigger for operational monitoring of this resource by Service Assurance systems.
53644       operational-status:
53645         type: string
53646         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
53647       license-key:
53648         type: string
53649         description: OBSOLETE -  do not use
53650       equipment-role:
53651         type: string
53652         description: Client should send valid enumerated value
53653       orchestration-status:
53654         type: string
53655         description: Orchestration status of this VNF, used by MSO.
53656       vnf-package-name:
53657         type: string
53658       vnf-discriptor-name:
53659         type: string
53660         description: vnf discriptor name
53661       job-id:
53662         type: string
53663         description: job id corresponding to vnf
53664       heat-stack-id:
53665         type: string
53666         description: Heat stack id corresponding to this instance, managed by MSO
53667       mso-catalog-key:
53668         type: string
53669         description: Corresponds to the SDN-C catalog id used to configure this VCE
53670       management-option:
53671         type: string
53672         description: identifier of managed by ATT or customer
53673       ipv4-oam-address:
53674         type: string
53675         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
53676       ipv4-loopback0-address:
53677         type: string
53678         description: v4 Loopback0 address
53679       nm-lan-v6-address:
53680         type: string
53681         description: v6 Loopback address
53682       management-v6-address:
53683         type: string
53684         description: v6 management address
53685       vcpu:
53686         type: integer
53687         format: int64
53688         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
53689       vcpu-units:
53690         type: string
53691         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
53692       vmemory:
53693         type: integer
53694         format: int64
53695         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
53696       vmemory-units:
53697         type: string
53698         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
53699       vdisk:
53700         type: integer
53701         format: int64
53702         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
53703       vdisk-units:
53704         type: string
53705         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
53706       nshd:
53707         type: integer
53708         format: int64
53709         description: number of associated SHD in vnf.
53710       nvm:
53711         type: integer
53712         format: int64
53713         description: number of vms in vnf.
53714       nnet:
53715         type: integer
53716         format: int64
53717         description: number of network in vnf.
53718       in-maint:
53719         type: boolean
53720         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
53721       is-closed-loop-disabled:
53722         type: boolean
53723         description: used to indicate whether closed loop function is enabled on this node
53724   generic-vnfs:
53725     description: |
53726       Collection of VNFs
53727     properties:
53728       generic-vnf:
53729         type: array
53730         items:
53731           $ref: "#/patchDefinitions/generic-vnf"
53732   group-assignment:
53733     description: |
53734       Openstack group-assignment used to store exclusivity groups (EG).
53735       ###### Related Nodes
53736       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
53737       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
53738       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
53739
53740     required:
53741     - group-id
53742     - group-type
53743     - group-name
53744     properties:
53745       group-id:
53746         type: string
53747         description: Group id, expected to be unique across cloud-region.
53748       group-type:
53749         type: string
53750         description: Group type - the type of group this instance refers to
53751       group-name:
53752         type: string
53753         description: Group name - name assigned to the group
53754       group-description:
53755         type: string
53756         description: Group description - description of the group
53757   group-assignments:
53758     description: |
53759       Collection of openstack group assignments
53760     properties:
53761       group-assignment:
53762         type: array
53763         items:
53764           $ref: "#/patchDefinitions/group-assignment"
53765   host-route:
53766     description: |
53767       ###### Related Nodes
53768       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
53769
53770       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
53771     required:
53772     - host-route-id
53773     - route-prefix
53774     - next-hop
53775     properties:
53776       host-route-id:
53777         type: string
53778         description: host-route id
53779       route-prefix:
53780         type: string
53781         description: subnet prefix
53782       next-hop:
53783         type: string
53784         description: Could be ip-address, hostname, or service-instance
53785       next-hop-type:
53786         type: string
53787         description: Should be ip-address, hostname, or service-instance to match next-hop
53788   host-routes:
53789     properties:
53790       host-route:
53791         type: array
53792         items:
53793           $ref: "#/patchDefinitions/host-route"
53794   hpa-capabilities:
53795     description: |
53796       Collection of HPA Capabilities
53797     properties:
53798       hpa-capability:
53799         type: array
53800         items:
53801           $ref: "#/patchDefinitions/hpa-capability"
53802   hpa-capability:
53803     description: |
53804       Represents a HPA capability
53805       ###### Related Nodes
53806       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
53807       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
53808       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
53809
53810       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
53811     required:
53812     - hpa-capability-id
53813     - hpa-feature
53814     properties:
53815       hpa-capability-id:
53816         type: string
53817         description: UUID to uniquely identify a HPA capability
53818       hpa-feature:
53819         type: string
53820         description: Name of the HPACapability
53821       hpa-version:
53822         type: string
53823         description: HPA schema version
53824       architecture:
53825         type: string
53826         description: Hardware architecture
53827   hpa-feature-attributes:
53828     description: |
53829       HPA Capability Feature attributes
53830       ###### Related Nodes
53831       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
53832
53833       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
53834     required:
53835     - hpa-attribute-key
53836     properties:
53837       hpa-attribute-key:
53838         type: string
53839         description: name of the specific HPA attribute
53840       hpa-attribute-value:
53841         type: string
53842         description: JSON string specifying the value, unit and type of the specific HPA attribute
53843   image:
53844     description: |
53845       Openstack image.
53846       ###### Related Nodes
53847       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
53848       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
53849       - FROM vserver( vserver Uses image, MANY2ONE)
53850
53851       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
53852       -IMAGE cannot be deleted if related to VSERVER
53853
53854     required:
53855     - image-id
53856     - image-name
53857     - image-os-distro
53858     - image-os-version
53859     - image-selflink
53860     properties:
53861       image-id:
53862         type: string
53863         description: Image id, expected to be unique across cloud region
53864       image-name:
53865         type: string
53866         description: Image name
53867       image-architecture:
53868         type: string
53869         description: Operating system architecture.
53870       image-os-distro:
53871         type: string
53872         description: The common name of the operating system distribution in lowercase
53873       image-os-version:
53874         type: string
53875         description: The operating system version as specified by the distributor.
53876       application:
53877         type: string
53878         description: The application that the image instantiates.
53879       application-vendor:
53880         type: string
53881         description: The vendor of the application.
53882       application-version:
53883         type: string
53884         description: The version of the application.
53885       image-selflink:
53886         type: string
53887         description: URL to endpoint where AAI can get more details
53888   images:
53889     description: |
53890       Collectio of Openstack images.
53891     properties:
53892       image:
53893         type: array
53894         items:
53895           $ref: "#/patchDefinitions/image"
53896   include-node-filter:
53897     properties:
53898       include-node-type:
53899         type: string
53900   instance-filter:
53901     description: |
53902       InstanceFilter for performing a named-query or model query
53903   instance-filters:
53904     description: |
53905       InstanceFilters for performing a named-query or model query
53906     properties:
53907       instance-filter:
53908         type: array
53909         items:
53910           $ref: "#/patchDefinitions/instance-filter"
53911   instance-group:
53912     description: |
53913       General mechanism for grouping instances
53914       ###### Related Nodes
53915       - TO model( instance-group Targets model, MANY2MANY)
53916       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
53917       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
53918       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
53919       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
53920       - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
53921       - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
53922       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
53923       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
53924       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
53925       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
53926       - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
53927
53928     required:
53929     - id
53930     - description
53931     - type
53932     properties:
53933       instance-group-role:
53934         type: string
53935         description: role of the instance group.
53936       model-invariant-id:
53937         type: string
53938         description: ASDC model id for this resource or service model.
53939       model-version-id:
53940         type: string
53941         description: ASDC model version uid for this resource model.
53942       id:
53943         type: string
53944         description: Instance Group ID, UUID assigned to this instance.
53945       description:
53946         type: string
53947         description: Descriptive text to help identify the usage of this instance-group
53948       type:
53949         type: string
53950         description: Only valid value today is lower case ha for high availability
53951       sub-type:
53952         type: string
53953         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
53954   instance-groups:
53955     description: |
53956       Collection of openstack route table references
53957     properties:
53958       instance-group:
53959         type: array
53960         items:
53961           $ref: "#/patchDefinitions/instance-group"
53962   inventory:
53963     properties:
53964       search:
53965         type: object
53966         $ref: "#/patchDefinitions/search"
53967       actions:
53968         type: object
53969         $ref: "#/patchDefinitions/actions"
53970       cloud-infrastructure:
53971         type: object
53972         $ref: "#/patchDefinitions/cloud-infrastructure"
53973       external-system:
53974         type: object
53975         $ref: "#/patchDefinitions/external-system"
53976       business:
53977         type: object
53978         $ref: "#/patchDefinitions/business"
53979       service-design-and-creation:
53980         type: object
53981         $ref: "#/patchDefinitions/service-design-and-creation"
53982       network:
53983         type: object
53984         $ref: "#/patchDefinitions/network"
53985       nodes:
53986         type: object
53987         $ref: "#/patchDefinitions/nodes"
53988   inventory-item:
53989     properties:
53990       inventory-item-type:
53991         type: string
53992       inventory-item-link:
53993         type: string
53994       inventory-item-data:
53995         type: array
53996         items:
53997           $ref: "#/patchDefinitions/inventory-item-data"
53998       tagged-inventory-item-list:
53999         type: array
54000         items:
54001           $ref: "#/patchDefinitions/tagged-inventory-item-list"
54002   inventory-item-data:
54003     properties:
54004       property-name:
54005         type: string
54006       property-value:
54007         type: string
54008   inventory-response-item:
54009     description: |
54010       Inventory item for response list
54011     properties:
54012       model-name:
54013         type: string
54014       extra-properties:
54015         type: object
54016         $ref: "#/patchDefinitions/extra-properties"
54017       inventory-response-items:
54018         type: object
54019         $ref: "#/patchDefinitions/inventory-response-items"
54020   inventory-response-items:
54021     description: |
54022       Container for inventory items in response list
54023     properties:
54024       inventory-response-item:
54025         type: array
54026         items:
54027           $ref: "#/patchDefinitions/inventory-response-item"
54028   ipsec-configuration:
54029     description: |
54030       IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
54031       ###### Related Nodes
54032       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
54033       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
54034
54035       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
54036     required:
54037     - ipsec-configuration-id
54038     properties:
54039       ipsec-configuration-id:
54040         type: string
54041         description: UUID of this configuration
54042       requested-vig-address-type:
54043         type: string
54044         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
54045       requested-encryption-strength:
54046         type: string
54047         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
54048       requested-dmz-type:
54049         type: string
54050         description: ATT can offer a shared DMZ or a DMZ specific to a customer
54051       shared-dmz-network-address:
54052         type: string
54053         description: Network address of shared DMZ
54054       requested-customer-name:
54055         type: string
54056         description: If the DMZ is a custom DMZ, this field will indicate the customer information
54057       ike-version:
54058         type: string
54059         description: can be 1 or 2
54060       ikev1-authentication:
54061         type: string
54062         description: Contains values like md5, sha1, sha256, sha384
54063       ikev1-encryption:
54064         type: string
54065         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
54066       ikev1-dh-group:
54067         type: string
54068         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
54069       ikev1-am-group-id:
54070         type: string
54071         description: Group name defined in VIG for clients using aggressive mode
54072       ikev1-am-password:
54073         type: string
54074         description: pre-shared key for the above group name
54075       ikev1-sa-lifetime:
54076         type: string
54077         description: Lifetime for IKEv1 SA
54078       ipsec-authentication:
54079         type: string
54080         description: md5, sha1, sha256, sha384
54081       ipsec-encryption:
54082         type: string
54083         description: 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
54084       ipsec-sa-lifetime:
54085         type: string
54086         description: Life time for IPSec SA
54087       ipsec-pfs:
54088         type: string
54089         description: enable PFS or not
54090       xauth-userid:
54091         type: string
54092         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
54093       xauth-user-password:
54094         type: string
54095         description: Encrypted using the Juniper $9$ algorithm
54096       dpd-interval:
54097         type: string
54098         description: The time between DPD probe
54099       dpd-frequency:
54100         type: string
54101         description: Maximum number of DPD before claiming the tunnel is down
54102   ipsec-configurations:
54103     properties:
54104       ipsec-configuration:
54105         type: array
54106         items:
54107           $ref: "#/patchDefinitions/ipsec-configuration"
54108   key-data:
54109     properties:
54110       key-name:
54111         type: string
54112       key-value:
54113         type: string
54114   l-interface:
54115     description: |
54116       Logical interfaces, e.g., a vnic.
54117       ###### Related Nodes
54118       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
54119       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
54120       - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
54121       - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
54122       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
54123       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
54124       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
54125       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
54126       - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
54127       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
54128       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
54129       - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)
54130       - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)
54131       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
54132       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
54133       - FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
54134       - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)
54135       - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
54136
54137       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
54138       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
54139       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
54140     required:
54141     - interface-name
54142     - is-port-mirrored
54143     - in-maint
54144     - is-ip-unnumbered
54145     properties:
54146       interface-name:
54147         type: string
54148         description: Name given to the interface
54149       interface-role:
54150         type: string
54151         description: E.g., CUSTOMER, UPLINK, etc.
54152       v6-wan-link-ip:
54153         type: string
54154         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
54155       selflink:
54156         type: string
54157         description: URL to endpoint where AAI can get more details
54158       interface-id:
54159         type: string
54160         description: ID of interface
54161       macaddr:
54162         type: string
54163         description: MAC address for the interface
54164       network-name:
54165         type: string
54166         description: Name of the network
54167       management-option:
54168         type: string
54169         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
54170       interface-description:
54171         type: string
54172         description: Human friendly text regarding this interface.
54173       is-port-mirrored:
54174         type: boolean
54175         description: boolean indicatating whether or not port is a mirrored.
54176   l-interfaces:
54177     description: |
54178       Collection of logical interfaces.
54179     properties:
54180       l-interface:
54181         type: array
54182         items:
54183           $ref: "#/patchDefinitions/l-interface"
54184   l3-interface-ipv4-address-list:
54185     description: |
54186       IPv4 Address Range
54187       ###### Related Nodes
54188       - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
54189       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
54190       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
54191       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
54192       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
54193       - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
54194
54195       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
54196     required:
54197     - l3-interface-ipv4-address
54198     properties:
54199       l3-interface-ipv4-address:
54200         type: string
54201         description: IP address
54202       l3-interface-ipv4-prefix-length:
54203         type: integer
54204         format: int64
54205         description: Prefix length, 32 for single address
54206       vlan-id-inner:
54207         type: integer
54208         format: int64
54209         description: Inner VLAN tag
54210       vlan-id-outer:
54211         type: integer
54212         format: int64
54213         description: Outer VLAN tag
54214       is-floating:
54215         type: boolean
54216         description: Indicator of fixed or floating address
54217   l3-interface-ipv6-address-list:
54218     description: |
54219       IPv6 Address Range
54220       ###### Related Nodes
54221       - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
54222       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
54223       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
54224       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
54225       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
54226       - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
54227
54228       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
54229     required:
54230     - l3-interface-ipv6-address
54231     properties:
54232       l3-interface-ipv6-address:
54233         type: string
54234         description: IP address
54235       l3-interface-ipv6-prefix-length:
54236         type: integer
54237         format: int64
54238         description: Prefix length, 128 for single address
54239       vlan-id-inner:
54240         type: integer
54241         format: int64
54242         description: Inner VLAN tag
54243       vlan-id-outer:
54244         type: integer
54245         format: int64
54246         description: Outer VLAN tag
54247       is-floating:
54248         type: boolean
54249         description: Indicator of fixed or floating address
54250   l3-network:
54251     description: |
54252       Generic network definition
54253       ###### Related Nodes
54254       - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
54255       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
54256       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
54257       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
54258       - TO model-ver( l3-network IsA model-ver, Many2One)
54259       - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
54260       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
54261       - FROM complex( complex Uses l3-network, MANY2MANY)
54262       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
54263       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
54264       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
54265       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
54266       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
54267       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
54268       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
54269       - FROM tenant( tenant Uses l3-network, MANY2MANY)
54270       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
54271
54272       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
54273     required:
54274     - network-id
54275     - network-name
54276     - is-bound-to-vpn
54277     - is-provider-network
54278     - is-shared-network
54279     - is-external-network
54280     properties:
54281       network-id:
54282         type: string
54283         description: Network ID, should be uuid. Unique across A&AI.
54284       network-name:
54285         type: string
54286         description: Name of the network, governed by some naming convention..
54287       network-type:
54288         type: string
54289         description: Type of the network - who defines these values?
54290       network-role:
54291         type: string
54292         description: Role the network plans - who defines these values?
54293       network-technology:
54294         type: string
54295         description: Network technology - who defines these values?
54296       neutron-network-id:
54297         type: string
54298         description: Neutron network id of this Interface
54299       is-bound-to-vpn:
54300         type: boolean
54301         description: Set to true if bound to VPN
54302       service-id:
54303         type: string
54304         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
54305       network-role-instance:
54306         type: integer
54307         format: int64
54308         description: network role instance
54309   l3-networks:
54310     properties:
54311       l3-network:
54312         type: array
54313         items:
54314           $ref: "#/patchDefinitions/l3-network"
54315   lag-interface:
54316     description: |
54317       Link aggregate interface
54318       ###### Related Nodes
54319       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
54320       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
54321       - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
54322       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
54323       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
54324       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
54325       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
54326       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
54327       - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)
54328
54329       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
54330       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
54331       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
54332     required:
54333     - interface-name
54334     - in-maint
54335     properties:
54336       interface-name:
54337         type: string
54338         description: Name that identifies the link aggregate interface
54339       interface-description:
54340         type: string
54341         description: Human friendly text regarding this interface.
54342   lag-interfaces:
54343     description: |
54344       Collection of link aggregate interfaces.
54345     properties:
54346       lag-interface:
54347         type: array
54348         items:
54349           $ref: "#/patchDefinitions/lag-interface"
54350   lag-link:
54351     description: |
54352       LAG links can connect lag-interfaces
54353       ###### Related Nodes
54354       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
54355       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
54356
54357       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
54358     required:
54359     - link-name
54360     properties:
54361       link-name:
54362         type: string
54363         description: Alphabetical concatenation of lag-interface names
54364   lag-links:
54365     description: |
54366       Collection of link aggregation connections
54367     properties:
54368       lag-link:
54369         type: array
54370         items:
54371           $ref: "#/patchDefinitions/lag-link"
54372   license:
54373     description: |
54374       Metadata for license group.
54375       ###### Related Nodes
54376       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
54377       - TO vce( license BelongsTo vce, MANY2ONE)(4)
54378
54379       -(4) IF this TO node is deleted, this LICENSE is DELETED also
54380     required:
54381     - group-uuid
54382     - resource-uuid
54383     properties:
54384       group-uuid:
54385         type: string
54386         description: Unique ID for the license group the resource belongs to, should be uuid.
54387       resource-uuid:
54388         type: string
54389         description: Unique ID of a license resource.
54390   licenses:
54391     description: |
54392       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
54393     properties:
54394       license:
54395         type: array
54396         items:
54397           $ref: "#/patchDefinitions/license"
54398   line-of-business:
54399     description: |
54400       describes a line-of-business
54401       ###### Related Nodes
54402       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
54403
54404     required:
54405     - line-of-business-name
54406     properties:
54407       line-of-business-name:
54408         type: string
54409         description: Name of the line-of-business (product)
54410   lines-of-business:
54411     description: |
54412       Collection of lines-of-business
54413     properties:
54414       line-of-business:
54415         type: array
54416         items:
54417           $ref: "#/patchDefinitions/line-of-business"
54418   logical-link:
54419     description: |
54420       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
54421       ###### Related Nodes
54422       - TO l-interface( logical-link Source l-interface, ONE2MANY)(4)
54423       - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)
54424       - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
54425       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
54426       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
54427       - TO logical-link( logical-link Uses logical-link, MANY2MANY)
54428       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
54429       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
54430       - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
54431       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
54432       - TO model-ver( logical-link IsA model-ver, Many2One)
54433       - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
54434       - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
54435       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
54436       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
54437       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
54438       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
54439       - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
54440
54441       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
54442       -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also
54443     required:
54444     - link-name
54445     - in-maint
54446     - link-type
54447     properties:
54448       link-name:
54449         type: string
54450         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
54451       in-maint:
54452         type: boolean
54453         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
54454       link-type:
54455         type: string
54456         description: Type of logical link, e.g., evc
54457       speed-value:
54458         type: string
54459         description: Captures the numeric part of the speed
54460       speed-units:
54461         type: string
54462         description: Captures the units corresponding to the speed
54463       ip-version:
54464         type: string
54465         description: v4, v6, or ds for dual stack
54466       routing-protocol:
54467         type: string
54468         description: For example, static or BGP
54469   logical-links:
54470     description: |
54471       Collection of logical connections
54472     properties:
54473       logical-link:
54474         type: array
54475         items:
54476           $ref: "#/patchDefinitions/logical-link"
54477   metadata:
54478     description: |
54479       Collection of metadatum (key/value pairs)
54480     properties:
54481       metadatum:
54482         type: array
54483         items:
54484           $ref: "#/patchDefinitions/metadatum"
54485   metadatum:
54486     description: |
54487       Key/value pairs
54488       ###### Related Nodes
54489       - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
54490       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
54491       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
54492       - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
54493       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
54494
54495       -(4) IF this TO node is deleted, this METADATUM is DELETED also
54496     required:
54497     - metaname
54498     - metaval
54499     properties:
54500       metaname:
54501         type: string
54502       metaval:
54503         type: string
54504   model:
54505     description: |
54506       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
54507       ###### Related Nodes
54508       - TO model( model-ver BelongsTo model, MANY2ONE)(1)
54509       - FROM instance-group( instance-group Targets model, MANY2MANY)
54510       - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
54511       - FROM named-query( named-query AppliesTo model, ONE2MANY)
54512       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
54513
54514       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
54515       -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
54516
54517     required:
54518     - model-invariant-id
54519     - model-type
54520     properties:
54521       model-invariant-id:
54522         type: string
54523         description: Unique identifier corresponding to the main definition of a model in ASDC
54524       model-type:
54525         type: string
54526         description: Type of the model, e.g., service, resource, widget, etc.
54527   model-and-named-query-search:
54528     description: |
54529       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
54530     properties:
54531       query-parameters:
54532         type: object
54533         $ref: "#/patchDefinitions/query-parameters"
54534       instance-filters:
54535         type: object
54536         $ref: "#/patchDefinitions/instance-filters"
54537       secondary-filts:
54538         type: object
54539         $ref: "#/patchDefinitions/secondary-filts"
54540       top-node-type:
54541         type: string
54542       secondary-filter-cut-point:
54543         type: string
54544   model-constraint:
54545     description: |
54546       This is how we would capture constraints defining allowed sets of elements.
54547       ###### Related Nodes
54548       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
54549       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
54550
54551       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
54552       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
54553     required:
54554     - model-constraint-uuid
54555     - constrained-element-set-uuid-to-replace
54556     properties:
54557       model-constraint-uuid:
54558         type: string
54559       constrained-element-set-uuid-to-replace:
54560         type: string
54561       constrained-element-sets:
54562         type: array
54563         items:
54564           $ref: "#/patchDefinitions/constrained-element-set"
54565   model-constraints:
54566     properties:
54567       model-constraint:
54568         type: array
54569         items:
54570           $ref: "#/patchDefinitions/model-constraint"
54571   model-element:
54572     description: |
54573       Defines how other models combine to make up a higher-level model.
54574       ###### Related Nodes
54575       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
54576       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
54577       - TO model-ver( model-element IsA model-ver, MANY2ONE)
54578       - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
54579       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
54580       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
54581       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
54582
54583       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
54584       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
54585     required:
54586     - model-element-uuid
54587     - new-data-del-flag
54588     - cardinality
54589     properties:
54590       model-element-uuid:
54591         type: string
54592       new-data-del-flag:
54593         type: string
54594         description: Indicates whether this element was created as part of instantiation from this model
54595       cardinality:
54596         type: string
54597         description: How many of this type of element are required/allowed
54598       linkage-points:
54599         type: string
54600   model-elements:
54601     properties:
54602       model-element:
54603         type: array
54604         items:
54605           $ref: "#/patchDefinitions/model-element"
54606   model-ver:
54607     description: |
54608       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
54609       ###### Related Nodes
54610       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
54611       - FROM model-element( model-element IsA model-ver, MANY2ONE)
54612       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
54613       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
54614       - FROM allotted-resource( allotted-resource IsA model-ver, Many2One)
54615       - FROM generic-vnf( generic-vnf IsA model-ver, Many2One)
54616       - FROM l3-network( l3-network IsA model-ver, Many2One)
54617       - FROM logical-link( logical-link IsA model-ver, Many2One)
54618       - FROM service-instance( service-instance IsA model-ver, Many2One)
54619       - FROM vf-module( vf-module IsA model-ver, Many2One)
54620
54621       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
54622       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
54623       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
54624
54625     required:
54626     - model-version-id
54627     - model-name
54628     - model-version
54629     properties:
54630       model-version-id:
54631         type: string
54632         description: Unique identifier corresponding to one version of a model in ASDC
54633       model-name:
54634         type: string
54635         description: Name of the model, which can change from version to version.
54636       model-version:
54637         type: string
54638         description: Version
54639       distribution-status:
54640         type: string
54641         description: Distribution Status
54642       model-description:
54643         type: string
54644         description: Description
54645   model-vers:
54646     properties:
54647       model-ver:
54648         type: array
54649         items:
54650           $ref: "#/patchDefinitions/model-ver"
54651   models:
54652     description: |
54653       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
54654     properties:
54655       model:
54656         type: array
54657         items:
54658           $ref: "#/patchDefinitions/model"
54659   multicast-configuration:
54660     description: |
54661       ###### Related Nodes
54662       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
54663
54664     required:
54665     - multicast-configuration-id
54666     - multicast-protocol
54667     - rp-type
54668     properties:
54669       multicast-configuration-id:
54670         type: string
54671         description: Unique id of multicast configuration.
54672       multicast-protocol:
54673         type: string
54674         description: protocol of multicast configuration
54675       rp-type:
54676         type: string
54677         description: rp type of multicast configuration
54678   multicast-configurations:
54679     description: |
54680       multicast configuration of generic-vnf ip-address
54681     properties:
54682       multicast-configuration:
54683         type: array
54684         items:
54685           $ref: "#/patchDefinitions/multicast-configuration"
54686   named-queries:
54687     properties:
54688       named-query:
54689         type: array
54690         items:
54691           $ref: "#/patchDefinitions/named-query"
54692   named-query:
54693     description: |
54694       TBD
54695       ###### Related Nodes
54696       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
54697       - TO model( named-query AppliesTo model, ONE2MANY)
54698       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
54699
54700       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
54701     required:
54702     - named-query-uuid
54703     - named-query-name
54704     - named-query-version
54705     properties:
54706       named-query-uuid:
54707         type: string
54708       named-query-name:
54709         type: string
54710       named-query-version:
54711         type: string
54712       required-input-param:
54713         type: string
54714       description:
54715         type: string
54716   named-query-element:
54717     description: |
54718       TBD
54719       ###### Related Nodes
54720       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
54721       - TO model( named-query-element IsA model, MANY2ONE)
54722       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
54723       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
54724       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
54725       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
54726
54727       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
54728       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
54729     required:
54730     - named-query-element-uuid
54731     properties:
54732       named-query-element-uuid:
54733         type: string
54734       property-collect-list:
54735         type: string
54736   named-query-elements:
54737     properties:
54738       named-query-element:
54739         type: array
54740         items:
54741           $ref: "#/patchDefinitions/named-query-element"
54742   network:
54743     description: |
54744       Namespace for network inventory resources.
54745     properties:
54746       logical-links:
54747         type: array
54748         items:
54749           $ref: "#/patchDefinitions/logical-link"
54750       site-pair-sets:
54751         type: array
54752         items:
54753           $ref: "#/patchDefinitions/site-pair-set"
54754       vpn-bindings:
54755         type: array
54756         items:
54757           $ref: "#/patchDefinitions/vpn-binding"
54758       vpls-pes:
54759         type: array
54760         items:
54761           $ref: "#/patchDefinitions/vpls-pe"
54762       multicast-configurations:
54763         type: array
54764         items:
54765           $ref: "#/patchDefinitions/multicast-configuration"
54766       vces:
54767         type: array
54768         items:
54769           $ref: "#/patchDefinitions/vce"
54770       vnfcs:
54771         type: array
54772         items:
54773           $ref: "#/patchDefinitions/vnfc"
54774       l3-networks:
54775         type: array
54776         items:
54777           $ref: "#/patchDefinitions/l3-network"
54778       network-policies:
54779         type: array
54780         items:
54781           $ref: "#/patchDefinitions/network-policy"
54782       generic-vnfs:
54783         type: array
54784         items:
54785           $ref: "#/patchDefinitions/generic-vnf"
54786       lag-links:
54787         type: array
54788         items:
54789           $ref: "#/patchDefinitions/lag-link"
54790       newvces:
54791         type: array
54792         items:
54793           $ref: "#/patchDefinitions/newvce"
54794       pnfs:
54795         type: array
54796         items:
54797           $ref: "#/patchDefinitions/pnf"
54798       physical-links:
54799         type: array
54800         items:
54801           $ref: "#/patchDefinitions/physical-link"
54802       ipsec-configurations:
54803         type: array
54804         items:
54805           $ref: "#/patchDefinitions/ipsec-configuration"
54806       route-table-references:
54807         type: array
54808         items:
54809           $ref: "#/patchDefinitions/route-table-reference"
54810       instance-groups:
54811         type: array
54812         items:
54813           $ref: "#/patchDefinitions/instance-group"
54814       zones:
54815         type: array
54816         items:
54817           $ref: "#/patchDefinitions/zone"
54818       configurations:
54819         type: array
54820         items:
54821           $ref: "#/patchDefinitions/configuration"
54822       forwarding-paths:
54823         type: array
54824         items:
54825           $ref: "#/patchDefinitions/forwarding-path"
54826   network-policies:
54827     properties:
54828       network-policy:
54829         type: array
54830         items:
54831           $ref: "#/patchDefinitions/network-policy"
54832   network-policy:
54833     description: |
54834       ###### Related Nodes
54835       - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
54836       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
54837
54838     required:
54839     - network-policy-id
54840     properties:
54841       network-policy-id:
54842         type: string
54843         description: UUID representing unique key to this instance
54844       network-policy-fqdn:
54845         type: string
54846         description: Contrail FQDN for the policy
54847       heat-stack-id:
54848         type: string
54849         description: ID for the openStack Heat instance
54850   network-profile:
54851     description: |
54852       Network profile populated by SDN-GP for SNMP
54853       ###### Related Nodes
54854       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
54855
54856     required:
54857     - nm-profile-name
54858     properties:
54859       nm-profile-name:
54860         type: string
54861         description: Unique name of network profile.
54862       community-string:
54863         type: string
54864         description: Encrypted SNMP community string
54865   network-profiles:
54866     description: |
54867       Collection of network profiles
54868     properties:
54869       network-profile:
54870         type: array
54871         items:
54872           $ref: "#/patchDefinitions/network-profile"
54873   newvce:
54874     description: |
54875       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
54876       ###### Related Nodes
54877       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
54878
54879       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
54880     required:
54881     - vnf-id2
54882     - vnf-name
54883     - vnf-type
54884     properties:
54885       vnf-id2:
54886         type: string
54887         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
54888       vnf-name:
54889         type: string
54890         description: Name of VNF.
54891       vnf-name2:
54892         type: string
54893         description: Alternate name of VNF.
54894       vnf-type:
54895         type: string
54896         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
54897       prov-status:
54898         type: string
54899         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
54900       operational-status:
54901         type: string
54902         description: Indicator for whether the resource is considered operational
54903       license-key:
54904         type: string
54905         description: OBSOLETE -  do not use
54906       ipv4-oam-address:
54907         type: string
54908         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
54909       equipment-role:
54910         type: string
54911         description: Client should send valid enumerated value.
54912   newvces:
54913     description: |
54914       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
54915     properties:
54916       newvce:
54917         type: array
54918         items:
54919           $ref: "#/patchDefinitions/newvce"
54920   nodes:
54921     properties:
54922       inventory-item-data:
54923         type: array
54924         items:
54925           $ref: "#/patchDefinitions/inventory-item-data"
54926   notification-event:
54927     properties:
54928       cambria.partition:
54929         type: string
54930       notification-event-header:
54931         type: object
54932         $ref: "#/patchDefinitions/notification-event-header"
54933   notification-event-header:
54934     properties:
54935       id:
54936         type: string
54937       timestamp:
54938         type: string
54939       source-name:
54940         type: string
54941       domain:
54942         type: string
54943       sequence-number:
54944         type: string
54945       severity:
54946         type: string
54947       event-type:
54948         type: string
54949       version:
54950         type: string
54951       action:
54952         type: string
54953       entity-type:
54954         type: string
54955       top-entity-type:
54956         type: string
54957       entity-link:
54958         type: string
54959       status:
54960         type: string
54961   notify:
54962     required:
54963     - event-id
54964     properties:
54965       event-id:
54966         type: string
54967       node-type:
54968         type: string
54969       event-trigger:
54970         type: string
54971       key-data:
54972         type: array
54973         items:
54974           $ref: "#/patchDefinitions/key-data"
54975       selflink:
54976         type: string
54977   oam-network:
54978     description: |
54979       OAM network, to be deprecated shortly.  Do not use for new purposes.
54980       ###### Related Nodes
54981       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
54982       - TO complex( oam-network AppliesTo complex, MANY2MANY)
54983       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
54984
54985     required:
54986     - network-uuid
54987     - network-name
54988     - cvlan-tag
54989     properties:
54990       network-uuid:
54991         type: string
54992         description: UUID of the network. Unique across a cloud-region
54993       network-name:
54994         type: string
54995         description: Name of the network.
54996       cvlan-tag:
54997         type: integer
54998         format: int64
54999         description: cvlan-id
55000       ipv4-oam-gateway-address:
55001         type: string
55002         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55003       ipv4-oam-gateway-address-prefix-length:
55004         type: integer
55005         format: int32
55006         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55007   oam-networks:
55008     description: |
55009       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
55010     properties:
55011       oam-network:
55012         type: array
55013         items:
55014           $ref: "#/patchDefinitions/oam-network"
55015   operational-environment:
55016     description: |
55017       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
55018       ###### Related Nodes
55019       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
55020       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
55021
55022     required:
55023     - operational-environment-id
55024     - operational-environment-name
55025     - operational-environment-type
55026     - operational-environment-status
55027     - tenant-context
55028     - workload-context
55029     properties:
55030       operational-environment-id:
55031         type: string
55032         description: UUID of an operational environment
55033       operational-environment-name:
55034         type: string
55035         description: Operational Environment name
55036       operational-environment-type:
55037         type: string
55038         description: Operational Environment Type.
55039       operational-environment-status:
55040         type: string
55041         description: Status
55042       tenant-context:
55043         type: string
55044         description: Tenant Context.
55045       workload-context:
55046         type: string
55047         description: Workload Context.
55048   operational-environments:
55049     description: |
55050       a logical partition of the cloud which allows to have multiple environments in the production AIC.
55051     properties:
55052       operational-environment:
55053         type: array
55054         items:
55055           $ref: "#/patchDefinitions/operational-environment"
55056   overloaded-model:
55057     description: |
55058       Allows for legacy POST of old-style and new-style models
55059     required:
55060     - model-invariant-id
55061     - model-name-version-id
55062     - model-type
55063     - model-name
55064     - model-id
55065     - model-version
55066     properties:
55067       model-invariant-id:
55068         type: string
55069         description: Unique identifier corresponding to the main definition of a model in ASDC
55070       model-name-version-id:
55071         type: string
55072         description: Unique identifier corresponding to one version of a model in ASDC
55073       model-type:
55074         type: string
55075         description: Type of the model, e.g., service, resource, widget, etc.
55076       model-name:
55077         type: string
55078         description: Name of the model, which can change from version to version.
55079       model-id:
55080         type: string
55081         description: Invariant unique ID which does not change from version to version
55082       model-version:
55083         type: string
55084         description: Version
55085       model-description:
55086         type: string
55087         description: Description
55088   owning-entities:
55089     description: |
55090       Collection of owning-entities
55091     properties:
55092       owning-entity:
55093         type: array
55094         items:
55095           $ref: "#/patchDefinitions/owning-entity"
55096   owning-entity:
55097     description: |
55098       describes an owning-entity
55099       ###### Related Nodes
55100       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
55101
55102     required:
55103     - owning-entity-id
55104     - owning-entity-name
55105     properties:
55106       owning-entity-id:
55107         type: string
55108         description: UUID of an owning entity
55109       owning-entity-name:
55110         type: string
55111         description: Owning entity name
55112   p-interface:
55113     description: |
55114       Physical interface (e.g., nic)
55115       ###### Related Nodes
55116       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
55117       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
55118       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
55119       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
55120       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
55121       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
55122       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
55123       - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
55124       - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)
55125
55126       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
55127       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
55128       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
55129     required:
55130     - interface-name
55131     - in-maint
55132     properties:
55133       interface-name:
55134         type: string
55135         description: Name that identifies the physical interface
55136       selflink:
55137         type: string
55138         description: URL to endpoint where AAI can get more details.
55139       speed-value:
55140         type: string
55141         description: Captures the numeric part of the speed
55142       speed-units:
55143         type: string
55144         description: Captures the units corresponding to the speed
55145       port-description:
55146         type: string
55147         description: Nature of the services and connectivity on this port.
55148       equipment-identifier:
55149         type: string
55150         description: CLEI or other specification for p-interface hardware.
55151       interface-role:
55152         type: string
55153         description: Role specification for p-interface hardware.
55154       interface-type:
55155         type: string
55156         description: Indicates the physical properties of the interface.
55157       prov-status:
55158         type: string
55159         description: Trigger for operational monitoring of this resource by Service Assurance systems.
55160       mac-addresss:
55161         type: string
55162         description: MAC Address of the p-interface.
55163   p-interfaces:
55164     description: |
55165       Collection of physical interfaces.
55166     properties:
55167       p-interface:
55168         type: array
55169         items:
55170           $ref: "#/patchDefinitions/p-interface"
55171   physical-link:
55172     description: |
55173       Collection of physical connections, typically between p-interfaces
55174       ###### Related Nodes
55175       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
55176
55177       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
55178     required:
55179     - link-name
55180     properties:
55181       link-name:
55182         type: string
55183         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
55184       speed-value:
55185         type: string
55186         description: Captures the numeric part of the speed
55187       speed-units:
55188         type: string
55189         description: Captures the units corresponding to the speed
55190       circuit-id:
55191         type: string
55192         description: Circuit it
55193       dual-mode:
55194         type: string
55195         description: Dual access mode (e.g., primary, secondary
55196       management-option:
55197         type: string
55198         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
55199       service-provider-name:
55200         type: string
55201         description: Name of the service Provider on this link.
55202       service-provider-bandwidth-up-value:
55203         type: integer
55204         format: int32
55205         description: Upstream Bandwidth value agreed with the service provider
55206       service-provider-bandwidth-up-units:
55207         type: string
55208         description: Units for the upstream BW value
55209       service-provider-bandwidth-down-value:
55210         type: integer
55211         format: int32
55212         description: Downstream Bandwidth value agreed with the service provider
55213       service-provider-bandwidth-down-units:
55214         type: string
55215         description: Units for downstream BW value
55216   physical-links:
55217     description: |
55218       Collection of physical connections, typically between p-interfaces
55219     properties:
55220       physical-link:
55221         type: array
55222         items:
55223           $ref: "#/patchDefinitions/physical-link"
55224   platform:
55225     description: |
55226       describes a platform
55227       ###### Related Nodes
55228       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
55229
55230     required:
55231     - platform-name
55232     properties:
55233       platform-name:
55234         type: string
55235         description: Name of the platform
55236   platforms:
55237     description: |
55238       Collection of platforms
55239     properties:
55240       platform:
55241         type: array
55242         items:
55243           $ref: "#/patchDefinitions/platform"
55244   pnf:
55245     description: |
55246       PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
55247       ###### Related Nodes
55248       - TO complex( pnf LocatedIn complex, MANY2ONE)
55249       - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
55250       - TO zone( pnf LocatedIn zone, MANY2ONE)
55251       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
55252       - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
55253       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
55254       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
55255       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
55256       - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
55257       - FROM configuration( configuration AppliesTo pnf, ONE2MANY)
55258
55259       -(1) IF this PNF node is deleted, this FROM node is DELETED also
55260     required:
55261     - pnf-name
55262     - in-maint
55263     properties:
55264       pnf-name:
55265         type: string
55266         description: unique name of Physical Network Function.
55267       pnf-name2:
55268         type: string
55269         description: name of Physical Network Function.
55270       selflink:
55271         type: string
55272         description: URL to endpoint where AAI can get more details.
55273       pnf-name2-source:
55274         type: string
55275         description: source of name2
55276       pnf-id:
55277         type: string
55278         description: id of pnf
55279       equip-type:
55280         type: string
55281         description: Equipment type.  Source of truth should define valid values.
55282       equip-vendor:
55283         type: string
55284         description: Equipment vendor.  Source of truth should define valid values.
55285       equip-model:
55286         type: string
55287         description: Equipment model.  Source of truth should define valid values.
55288       management-option:
55289         type: string
55290         description: identifier of managed by ATT or customer
55291       ipaddress-v4-oam:
55292         type: string
55293         description: ipv4-oam-address with new naming convention for IP addresses
55294       sw-version:
55295         type: string
55296         description: sw-version is the version of SW for the hosted application on the PNF.
55297       in-maint:
55298         type: boolean
55299         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
55300       frame-id:
55301         type: string
55302         description: ID of the physical frame (relay rack) where pnf is installed.
55303       serial-number:
55304         type: string
55305         description: Serial number of the device
55306       ipaddress-v4-loopback-0:
55307         type: string
55308         description: IPV4 Loopback 0 address
55309       ipaddress-v6-loopback-0:
55310         type: string
55311         description: IPV6 Loopback 0 address
55312       ipaddress-v4-aim:
55313         type: string
55314         description: IPV4 AIM address
55315       ipaddress-v6-aim:
55316         type: string
55317         description: IPV6 AIM address
55318       ipaddress-v6-oam:
55319         type: string
55320         description: IPV6 OAM address
55321       inv-status:
55322         type: string
55323         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
55324   pnfs:
55325     description: |
55326       Collection of Physical Network Functions.
55327     properties:
55328       pnf:
55329         type: array
55330         items:
55331           $ref: "#/patchDefinitions/pnf"
55332   port-group:
55333     description: |
55334       Used to capture the network interfaces of this VCE
55335       ###### Related Nodes
55336       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
55337       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
55338
55339       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
55340       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
55341     required:
55342     - interface-id
55343     - orchestration-status
55344     properties:
55345       interface-id:
55346         type: string
55347         description: Unique ID of the interface
55348       neutron-network-id:
55349         type: string
55350         description: Neutron network id of this Interface
55351       neutron-network-name:
55352         type: string
55353         description: Neutron network name of this Interface
55354       interface-role:
55355         type: string
55356         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
55357   port-groups:
55358     properties:
55359       port-group:
55360         type: array
55361         items:
55362           $ref: "#/patchDefinitions/port-group"
55363   project:
55364     description: |
55365       describes the project
55366       ###### Related Nodes
55367       - TO service-instance( project Uses service-instance, ONE2MANY)
55368
55369     required:
55370     - project-name
55371     properties:
55372       project-name:
55373         type: string
55374         description: Name of the project deploying a service
55375   projects:
55376     description: |
55377       Collection of projects
55378     properties:
55379       project:
55380         type: array
55381         items:
55382           $ref: "#/patchDefinitions/project"
55383   properties:
55384     description: |
55385       Property holder for query properties or instance properties
55386     properties:
55387       property-name:
55388         type: string
55389       property-value:
55390         type: string
55391   property-constraint:
55392     description: |
55393       TBD
55394       ###### Related Nodes
55395       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
55396
55397       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
55398     required:
55399     - property-constraint-uuid
55400     - constraint-type
55401     - property-name
55402     - property-value
55403     properties:
55404       property-constraint-uuid:
55405         type: string
55406       constraint-type:
55407         type: string
55408       property-name:
55409         type: string
55410       property-value:
55411         type: string
55412   property-constraints:
55413     properties:
55414       property-constraint:
55415         type: array
55416         items:
55417           $ref: "#/patchDefinitions/property-constraint"
55418   pserver:
55419     description: |
55420       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
55421       ###### Related Nodes
55422       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
55423       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
55424       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
55425       - TO complex( pserver LocatedIn complex, MANY2ONE)
55426       - TO zone( pserver LocatedIn zone, MANY2ONE)
55427       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
55428       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
55429       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
55430       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
55431       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
55432
55433       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
55434       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
55435
55436     required:
55437     - hostname
55438     - in-maint
55439     properties:
55440       hostname:
55441         type: string
55442         description: Value from executing hostname on the compute node.
55443       ptnii-equip-name:
55444         type: string
55445         description: PTNII name
55446       number-of-cpus:
55447         type: integer
55448         format: int32
55449         description: Number of cpus
55450       disk-in-gigabytes:
55451         type: integer
55452         format: int32
55453         description: Disk size, in GBs
55454       ram-in-megabytes:
55455         type: integer
55456         format: int32
55457         description: RAM size, in MBs
55458       equip-type:
55459         type: string
55460         description: Equipment type.  Source of truth should define valid values.
55461       equip-vendor:
55462         type: string
55463         description: Equipment vendor.  Source of truth should define valid values.
55464       equip-model:
55465         type: string
55466         description: Equipment model.  Source of truth should define valid values.
55467       fqdn:
55468         type: string
55469         description: Fully-qualified domain name
55470       pserver-selflink:
55471         type: string
55472         description: URL to endpoint where AAI can get more details
55473       ipv4-oam-address:
55474         type: string
55475         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
55476       serial-number:
55477         type: string
55478         description: Serial number, may be queried
55479       ipaddress-v4-loopback-0:
55480         type: string
55481         description: IPV4 Loopback 0 address
55482       ipaddress-v6-loopback-0:
55483         type: string
55484         description: IPV6 Loopback 0 address
55485       ipaddress-v4-aim:
55486         type: string
55487         description: IPV4 AIM address
55488       ipaddress-v6-aim:
55489         type: string
55490         description: IPV6 AIM address
55491       ipaddress-v6-oam:
55492         type: string
55493         description: IPV6 OAM address
55494       inv-status:
55495         type: string
55496         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
55497       pserver-id:
55498         type: string
55499         description: ID of Pserver
55500       internet-topology:
55501         type: string
55502         description: internet topology of Pserver
55503       in-maint:
55504         type: boolean
55505         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
55506   pservers:
55507     description: |
55508       Collection of compute hosts.
55509     properties:
55510       pserver:
55511         type: array
55512         items:
55513           $ref: "#/patchDefinitions/pserver"
55514   query-parameters:
55515     description: |
55516       QueryParameters for performing a named-query or model query
55517     properties:
55518       named-query:
55519         type: object
55520         $ref: "#/patchDefinitions/named-query"
55521       overloaded-model:
55522         type: object
55523         $ref: "#/patchDefinitions/overloaded-model"
55524   related-lookup:
55525     description: |
55526       TBD
55527       ###### Related Nodes
55528       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
55529
55530       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
55531     required:
55532     - related-lookup-uuid
55533     - source-node-type
55534     - source-node-property
55535     - target-node-type
55536     - target-node-property
55537     properties:
55538       related-lookup-uuid:
55539         type: string
55540       source-node-type:
55541         type: string
55542       source-node-property:
55543         type: string
55544       target-node-type:
55545         type: string
55546       target-node-property:
55547         type: string
55548       property-collect-list:
55549         type: string
55550   related-lookups:
55551     properties:
55552       related-lookup:
55553         type: array
55554         items:
55555           $ref: "#/patchDefinitions/related-lookup"
55556   related-to-property:
55557     properties:
55558       property-key:
55559         type: string
55560         description: Key part of a key/value pair
55561       property-value:
55562         type: string
55563         description: Value part of a key/value pair
55564   relationship:
55565     properties:
55566       related-to:
55567         type: string
55568         description: A keyword provided by A&AI to indicate type of node.
55569       relationship-label:
55570         type: string
55571         description: The edge label for this relationship.
55572       related-link:
55573         type: string
55574         description: URL to the object in A&AI.
55575       relationship-data:
55576         type: array
55577         items:
55578           $ref: "#/patchDefinitions/relationship-data"
55579       related-to-property:
55580         type: array
55581         items:
55582           $ref: "#/patchDefinitions/related-to-property"
55583   relationship-data:
55584     required:
55585     - relationship-key
55586     - relationship-value
55587     properties:
55588       relationship-key:
55589         type: string
55590         description: A keyword provided by A&AI to indicate an attribute.
55591       relationship-value:
55592         type: string
55593         description: Value of the attribute.
55594   reserved-prop-names:
55595     description: |
55596       Internal map to define some reserved properties of a vertex
55597     properties:
55598       last-mod-source-of-truth:
55599         type: string
55600       aai-node-type:
55601         type: string
55602       aai-created-ts:
55603         type: integer
55604         format: int64
55605       aai-unique-key:
55606         type: string
55607       aai-last-mod-ts:
55608         type: integer
55609         format: int64
55610       source-of-truth:
55611         type: string
55612       aai-uri:
55613         type: string
55614   response-list:
55615     description: |
55616       Response container for the results of a named-query or model query
55617     properties:
55618       inventory-response-items:
55619         type: object
55620         $ref: "#/patchDefinitions/inventory-response-items"
55621   result-data:
55622     properties:
55623       resource-type:
55624         type: string
55625         description: The specific type of node in the A&AI graph
55626       resource-link:
55627         type: string
55628         description: The URL to the specific resource
55629   route-table-reference:
55630     description: |
55631       Openstack route table reference.
55632       ###### Related Nodes
55633       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
55634
55635     required:
55636     - route-table-reference-id
55637     - route-table-reference-fqdn
55638     properties:
55639       route-table-reference-id:
55640         type: string
55641         description: Route Table Reference id, UUID assigned to this instance.
55642       route-table-reference-fqdn:
55643         type: string
55644         description: FQDN entry in the route table.
55645   route-table-references:
55646     description: |
55647       Collection of openstack route table references
55648     properties:
55649       route-table-reference:
55650         type: array
55651         items:
55652           $ref: "#/patchDefinitions/route-table-reference"
55653   route-target:
55654     description: |
55655       Route target information
55656       ###### Related Nodes
55657       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
55658
55659       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
55660     required:
55661     - global-route-target
55662     - route-target-role
55663     properties:
55664       global-route-target:
55665         type: string
55666         description: Number used to identify an RT, globally unique in the network
55667       route-target-role:
55668         type: string
55669         description: Role assigned to this route target
55670   route-targets:
55671     description: |
55672       Collection of route target information
55673     properties:
55674       route-target:
55675         type: array
55676         items:
55677           $ref: "#/patchDefinitions/route-target"
55678   routing-instance:
55679     description: |
55680       ###### Related Nodes
55681       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
55682       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
55683
55684       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
55685       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
55686     required:
55687     - routing-instance-id
55688     properties:
55689       routing-instance-id:
55690         type: string
55691         description: Unique id of routing instance
55692       rpm-owner:
55693         type: string
55694         description: rpm owner
55695   routing-instances:
55696     description: |
55697       set of probes related to generic-vnf routing instance
55698     properties:
55699       routing-instance:
55700         type: array
55701         items:
55702           $ref: "#/patchDefinitions/routing-instance"
55703   sdn-zone-response:
55704     properties:
55705       oam-networks:
55706         type: object
55707         $ref: "#/patchDefinitions/oam-networks"
55708       az-and-dvs-switches:
55709         type: array
55710         items:
55711           $ref: "#/patchDefinitions/az-and-dvs-switches"
55712   search:
55713     properties:
55714       edge-tag-query-result:
55715         type: object
55716         $ref: "#/patchDefinitions/edge-tag-query-result"
55717       edge-tag-query-request:
55718         type: object
55719         $ref: "#/patchDefinitions/edge-tag-query-request"
55720       search-results:
55721         type: object
55722         $ref: "#/patchDefinitions/search-results"
55723       sdn-zone-response:
55724         type: object
55725         $ref: "#/patchDefinitions/sdn-zone-response"
55726   search-results:
55727     properties:
55728       result-data:
55729         type: array
55730         items:
55731           $ref: "#/patchDefinitions/result-data"
55732   secondary-filt:
55733     description: |
55734       SecondaryFilt for performing a named-query or model query
55735   secondary-filter:
55736     properties:
55737       property-name:
55738         type: string
55739       filter-type:
55740         type: string
55741       property-value:
55742         type: string
55743   secondary-filts:
55744     description: |
55745       SecondaryFilts for performing a named-query or model query
55746     properties:
55747       secondary-filt:
55748         type: array
55749         items:
55750           $ref: "#/patchDefinitions/secondary-filt"
55751   segmentation-assignment:
55752     description: |
55753       Openstack segmentation assignment.
55754       ###### Related Nodes
55755       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
55756
55757       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
55758     required:
55759     - segmentation-id
55760     properties:
55761       segmentation-id:
55762         type: string
55763         description: Route Table Reference id, UUID assigned to this instance.
55764   segmentation-assignments:
55765     description: |
55766       Collection of openstack segmentation assignments
55767     properties:
55768       segmentation-assignment:
55769         type: array
55770         items:
55771           $ref: "#/patchDefinitions/segmentation-assignment"
55772   service:
55773     description: |
55774       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
55775     required:
55776     - service-id
55777     - service-description
55778     properties:
55779       service-id:
55780         type: string
55781         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
55782       service-description:
55783         type: string
55784         description: Description of the service
55785       service-selflink:
55786         type: string
55787         description: URL to endpoint where AAI can get more details
55788   service-capabilities:
55789     description: |
55790       Collection of service capabilities.
55791     properties:
55792       service-capability:
55793         type: array
55794         items:
55795           $ref: "#/patchDefinitions/service-capability"
55796   service-capability:
55797     description: |
55798       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
55799       ###### Related Nodes
55800       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
55801       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
55802
55803       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
55804
55805     required:
55806     - service-type
55807     - vnf-type
55808     properties:
55809       service-type:
55810         type: string
55811         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
55812       vnf-type:
55813         type: string
55814         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
55815   service-design-and-creation:
55816     description: |
55817       Namespace for objects managed by ASDC
55818     properties:
55819       vnf-images:
55820         type: array
55821         items:
55822           $ref: "#/patchDefinitions/vnf-image"
55823       services:
55824         type: array
55825         items:
55826           $ref: "#/patchDefinitions/service"
55827       service-capabilities:
55828         type: array
55829         items:
55830           $ref: "#/patchDefinitions/service-capability"
55831       models:
55832         type: array
55833         items:
55834           $ref: "#/patchDefinitions/model"
55835       named-queries:
55836         type: array
55837         items:
55838           $ref: "#/patchDefinitions/named-query"
55839   service-instance:
55840     description: |
55841       Instance of a service
55842       ###### Related Nodes
55843       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
55844       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
55845       - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
55846       - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
55847       - TO configuration( service-instance Uses configuration, ONE2MANY)
55848       - TO connector( service-instance Uses connector, MANY2MANY)
55849       - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
55850       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
55851       - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
55852       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
55853       - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
55854       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
55855       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
55856       - TO zone( service-instance LocatedIn zone, MANY2ONE)
55857       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
55858       - TO vce( service-instance ComposedOf vce, ONE2MANY)
55859       - TO model-ver( service-instance IsA model-ver, Many2One)
55860       - FROM project( project Uses service-instance, ONE2MANY)
55861       - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
55862       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
55863       - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
55864       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
55865
55866       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
55867       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
55868       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
55869     required:
55870     - service-instance-id
55871     properties:
55872       service-instance-id:
55873         type: string
55874         description: Uniquely identifies this instance of a service
55875       service-instance-name:
55876         type: string
55877         description: This field will store a name assigned to the service-instance.
55878       service-type:
55879         type: string
55880         description: String capturing type of service.
55881       service-role:
55882         type: string
55883         description: String capturing the service role.
55884       environment-context:
55885         type: string
55886         description: This field will store the environment context assigned to the service-instance.
55887       workload-context:
55888         type: string
55889         description: This field will store the workload context assigned to the service-instance.
55890       created-at:
55891         type: string
55892         description: create time of Network Service.
55893       updated-at:
55894         type: string
55895         description: last update of Network Service.
55896       description:
55897         type: string
55898         description: short description for service-instance.
55899       model-invariant-id:
55900         type: string
55901         description: the ASDC model id for this resource or service model.
55902       model-version-id:
55903         type: string
55904         description: the ASDC model version for this resource or service model.
55905       persona-model-version:
55906         type: string
55907         description: the ASDC model version for this resource or service model.
55908       widget-model-id:
55909         type: string
55910         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55911       widget-model-version:
55912         type: string
55913         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55914       bandwidth-total:
55915         type: string
55916         description: Indicates the total bandwidth to be used for this service.
55917       bandwidth-up-wan1:
55918         type: string
55919         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
55920       bandwidth-down-wan1:
55921         type: string
55922         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
55923       bandwidth-up-wan2:
55924         type: string
55925         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
55926       bandwidth-down-wan2:
55927         type: string
55928         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
55929       vhn-portal-url:
55930         type: string
55931         description: URL customers will use to access the vHN Portal.
55932       service-instance-location-id:
55933         type: string
55934         description: An identifier that customers assign to the location where this service is being used.
55935   service-instances:
55936     description: |
55937       Collection of service instances
55938     properties:
55939       service-instance:
55940         type: array
55941         items:
55942           $ref: "#/patchDefinitions/service-instance"
55943   service-subscription:
55944     description: |
55945       Object that group service instances.
55946       ###### Related Nodes
55947       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
55948       - TO tenant( service-subscription Uses tenant, MANY2MANY)
55949       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
55950
55951       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
55952       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
55953     required:
55954     - service-type
55955     properties:
55956       service-type:
55957         type: string
55958         description: Value defined by orchestration to identify this service across ECOMP.
55959       temp-ub-sub-account-id:
55960         type: string
55961         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
55962   service-subscriptions:
55963     description: |
55964       Collection of objects that group service instances.
55965     properties:
55966       service-subscription:
55967         type: array
55968         items:
55969           $ref: "#/patchDefinitions/service-subscription"
55970   services:
55971     description: |
55972       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
55973     properties:
55974       service:
55975         type: array
55976         items:
55977           $ref: "#/patchDefinitions/service"
55978   site-pair:
55979     description: |
55980       ###### Related Nodes
55981       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
55982       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
55983
55984       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
55985       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
55986     required:
55987     - site-pair-id
55988     properties:
55989       site-pair-id:
55990         type: string
55991         description: unique identifier of probe
55992       source-ip:
55993         type: string
55994         description: Prefix address
55995       destination-ip:
55996         type: string
55997         description: Prefix address
55998       ip-version:
55999         type: string
56000         description: ip version, v4, v6
56001       destination-hostname:
56002         type: string
56003         description: Hostname of the destination equipment to which SLAs are measured against.
56004       destination-equip-type:
56005         type: string
56006         description: The type of destinatination equipment. Could be Router, UCPE, etc.
56007   site-pair-set:
56008     description: |
56009       Set of instances for probes used to measure service level agreements
56010       ###### Related Nodes
56011       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
56012       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
56013
56014       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
56015     required:
56016     - site-pair-set-id
56017     properties:
56018       site-pair-set-id:
56019         type: string
56020         description: Unique id of site pair set.
56021   site-pair-sets:
56022     description: |
56023       Collection of sets of instances for probes related to generic-vnf
56024     properties:
56025       site-pair-set:
56026         type: array
56027         items:
56028           $ref: "#/patchDefinitions/site-pair-set"
56029   site-pairs:
56030     description: |
56031       probe within a set
56032     properties:
56033       site-pair:
56034         type: array
56035         items:
56036           $ref: "#/patchDefinitions/site-pair"
56037   snapshot:
56038     description: |
56039       Openstack snapshot
56040       ###### Related Nodes
56041       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
56042       - FROM vserver( vserver Uses snapshot, ONE2ONE)
56043
56044     required:
56045     - snapshot-id
56046     properties:
56047       snapshot-id:
56048         type: string
56049         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
56050       snapshot-name:
56051         type: string
56052         description: Snapshot name
56053       snapshot-architecture:
56054         type: string
56055         description: Operating system architecture
56056       snapshot-os-distro:
56057         type: string
56058         description: The common name of the operating system distribution in lowercase
56059       snapshot-os-version:
56060         type: string
56061         description: The operating system version as specified by the distributor.
56062       application:
56063         type: string
56064         description: The application that the image instantiates.
56065       application-vendor:
56066         type: string
56067         description: The vendor of the application.
56068       application-version:
56069         type: string
56070         description: The version of the application.
56071       snapshot-selflink:
56072         type: string
56073         description: URL to endpoint where AAI can get more details
56074       prev-snapshot-id:
56075         type: string
56076         description: This field contains the UUID of the previous snapshot (if any).
56077   snapshots:
56078     description: |
56079       Collection of openstack snapshots
56080     properties:
56081       snapshot:
56082         type: array
56083         items:
56084           $ref: "#/patchDefinitions/snapshot"
56085   sriov-pf:
56086     description: |
56087       SR-IOV Physical Function
56088       ###### Related Nodes
56089       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
56090       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
56091
56092       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
56093     required:
56094     - pf-pci-id
56095     properties:
56096       pf-pci-id:
56097         type: string
56098         description: Identifier for the sriov-pf
56099   sriov-pfs:
56100     description: |
56101       Collection of SR-IOV Physical Functions.
56102     properties:
56103       sriov-pf:
56104         type: array
56105         items:
56106           $ref: "#/patchDefinitions/sriov-pf"
56107   sriov-vf:
56108     description: |
56109       SR-IOV Virtual Function (not to be confused with virtual network function)
56110       ###### Related Nodes
56111       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
56112       - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
56113
56114       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
56115     required:
56116     - pci-id
56117     properties:
56118       pci-id:
56119         type: string
56120         description: PCI ID used to identify the sriov-vf
56121       vf-vlan-filter:
56122         type: string
56123         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
56124       vf-mac-filter:
56125         type: string
56126         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
56127       vf-vlan-strip:
56128         type: boolean
56129         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
56130       vf-vlan-anti-spoof-check:
56131         type: boolean
56132         description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
56133       vf-mac-anti-spoof-check:
56134         type: boolean
56135         description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
56136       vf-mirrors:
56137         type: string
56138         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
56139       vf-broadcast-allow:
56140         type: boolean
56141         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
56142       vf-unknown-multicast-allow:
56143         type: boolean
56144         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
56145       vf-unknown-unicast-allow:
56146         type: boolean
56147         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
56148       vf-insert-stag:
56149         type: boolean
56150         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
56151       vf-link-status:
56152         type: string
56153         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
56154   sriov-vfs:
56155     description: |
56156       Collection of SR-IOV Virtual Functions.
56157     properties:
56158       sriov-vf:
56159         type: array
56160         items:
56161           $ref: "#/patchDefinitions/sriov-vf"
56162   start-node-filter:
56163     properties:
56164       property-name:
56165         type: string
56166       property-value:
56167         type: string
56168   subnet:
56169     description: |
56170       ###### Related Nodes
56171       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
56172       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
56173       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
56174       - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
56175       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
56176       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
56177
56178       -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
56179       -(4) IF this TO node is deleted, this SUBNET is DELETED also
56180       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
56181
56182     required:
56183     - subnet-id
56184     - dhcp-enabled
56185     properties:
56186       subnet-id:
56187         type: string
56188         description: Subnet ID, should be UUID.
56189       subnet-name:
56190         type: string
56191         description: Name associated with the subnet.
56192       neutron-subnet-id:
56193         type: string
56194         description: Neutron id of this subnet
56195       gateway-address:
56196         type: string
56197         description: gateway ip address
56198       network-start-address:
56199         type: string
56200         description: network start address
56201       cidr-mask:
56202         type: string
56203         description: cidr mask
56204       ip-version:
56205         type: string
56206         description: ip version
56207       orchestration-status:
56208         type: string
56209         description: Orchestration status of this VNF, mastered by MSO
56210       dhcp-enabled:
56211         type: boolean
56212         description: dhcp enabled
56213       dhcp-start:
56214         type: string
56215         description: the start address reserved for use by dhcp
56216       dhcp-end:
56217         type: string
56218         description: the last address reserved for use by dhcp
56219       subnet-role:
56220         type: string
56221         description: role of the subnet, referenced when assigning IPs
56222       ip-assignment-direction:
56223         type: string
56224         description: ip address assignment direction of the subnet
56225   subnets:
56226     properties:
56227       subnet:
56228         type: array
56229         items:
56230           $ref: "#/patchDefinitions/subnet"
56231   tagged-inventory-item-list:
56232     properties:
56233       inventory-item:
56234         type: array
56235         items:
56236           $ref: "#/patchDefinitions/inventory-item"
56237   tenant:
56238     description: |
56239       Openstack tenant
56240       ###### Related Nodes
56241       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
56242       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
56243       - TO l3-network( tenant Uses l3-network, MANY2MANY)
56244       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
56245       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
56246       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
56247
56248       -TENANT cannot be deleted if related to VSERVER
56249
56250     required:
56251     - tenant-id
56252     - tenant-name
56253     properties:
56254       tenant-id:
56255         type: string
56256         description: Unique id relative to the cloud-region.
56257       tenant-name:
56258         type: string
56259         description: Readable name of tenant
56260       tenant-context:
56261         type: string
56262         description: This field will store the tenant context.
56263   tenants:
56264     description: |
56265       Collection of openstack tenants.
56266     properties:
56267       tenant:
56268         type: array
56269         items:
56270           $ref: "#/patchDefinitions/tenant"
56271   tunnel-xconnect:
56272     description: |
56273       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
56274       ###### Related Nodes
56275       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
56276
56277       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
56278     required:
56279     - id
56280     properties:
56281       id:
56282         type: string
56283         description: Allotted Resource id UUID assigned to this instance.
56284       bandwidth-up-wan1:
56285         type: string
56286         description: The WAN uplink bandwidth for WAN1
56287       bandwidth-down-wan1:
56288         type: string
56289         description: The WAN downlink bandwidth for WAN1
56290       bandwidth-up-wan2:
56291         type: string
56292         description: The WAN uplink bandwidth for WAN2
56293       bandwidth-down-wan2:
56294         type: string
56295         description: The WAN downlink bandwidth for WAN2
56296   tunnel-xconnects:
56297     description: |
56298       This object is used to store the specific tunnel cross connect aspects of an allotted resource
56299     properties:
56300       tunnel-xconnect:
56301         type: array
56302         items:
56303           $ref: "#/patchDefinitions/tunnel-xconnect"
56304   update:
56305     description: |
56306       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
56307     required:
56308     - update-node-type
56309     properties:
56310       update-node-type:
56311         type: string
56312       update-node-key:
56313         type: array
56314         items:
56315           $ref: "#/patchDefinitions/update-node-key"
56316       update-node-uri:
56317         type: string
56318       action:
56319         type: array
56320         items:
56321           $ref: "#/patchDefinitions/action"
56322   update-node-key:
56323     properties:
56324       key-name:
56325         type: string
56326       key-value:
56327         type: string
56328   vce:
56329     description: |
56330       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
56331       ###### Related Nodes
56332       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
56333       - TO complex( vce LocatedIn complex, MANY2MANY)
56334       - TO vserver( vce HostedOn vserver, ONE2MANY)
56335       - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
56336       - FROM license( license BelongsTo vce, MANY2ONE)(1)
56337       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
56338       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
56339
56340       -(1) IF this VCE node is deleted, this FROM node is DELETED also
56341     required:
56342     - vnf-id
56343     - vnf-name
56344     - vnf-type
56345     properties:
56346       vnf-id:
56347         type: string
56348         description: Unique id of VNF.  This is unique across the graph.
56349       vnf-name:
56350         type: string
56351         description: Name of VNF.
56352       vnf-name2:
56353         type: string
56354         description: Alternate name of VNF.
56355       vnf-type:
56356         type: string
56357         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
56358       service-id:
56359         type: string
56360         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
56361       regional-resource-zone:
56362         type: string
56363         description: Regional way of organizing pservers, source of truth should define values
56364       prov-status:
56365         type: string
56366         description: Trigger for operational monitoring of this resource by Service Assurance systems.
56367       operational-status:
56368         type: string
56369         description: Indicator for whether the resource is considered operational
56370       license-key:
56371         type: string
56372         description: OBSOLETE -  do not use
56373       equipment-role:
56374         type: string
56375         description: Network role being played by this VNF
56376       orchestration-status:
56377         type: string
56378         description: Orchestration status of this VNF, mastered by MSO
56379       heat-stack-id:
56380         type: string
56381         description: Heat stack id corresponding to this instance, managed by MSO
56382       mso-catalog-key:
56383         type: string
56384         description: Corresponds to the SDN-C catalog id used to configure this VCE
56385       vpe-id:
56386         type: string
56387         description: Unique ID of VPE connected to this VCE.
56388       v6-vce-wan-address:
56389         type: string
56390         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
56391       ipv4-oam-address:
56392         type: string
56393         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
56394   vces:
56395     description: |
56396       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
56397     properties:
56398       vce:
56399         type: array
56400         items:
56401           $ref: "#/patchDefinitions/vce"
56402   vf-module:
56403     description: |
56404       a deployment unit of VNFCs
56405       ###### Related Nodes
56406       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
56407       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
56408       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
56409       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
56410       - TO vserver( vf-module Uses vserver, ONE2MANY)
56411       - TO model-ver( vf-module IsA model-ver, Many2One)
56412
56413       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
56414       -VF-MODULE cannot be deleted if related to VNFC
56415
56416     required:
56417     - vf-module-id
56418     - is-base-vf-module
56419     properties:
56420       vf-module-id:
56421         type: string
56422         description: Unique ID of vf-module.
56423       vf-module-name:
56424         type: string
56425         description: Name of vf-module
56426       heat-stack-id:
56427         type: string
56428         description: Heat stack id corresponding to this instance.
56429       orchestration-status:
56430         type: string
56431         description: orchestration status of this vf-module, mastered by MSO
56432       is-base-vf-module:
56433         type: boolean
56434         description: used to indicate whether or not this object is base vf module
56435   vf-modules:
56436     description: |
56437       Collection of vf-modules, a deployment unit of VNFCs
56438     properties:
56439       vf-module:
56440         type: array
56441         items:
56442           $ref: "#/patchDefinitions/vf-module"
56443   vig-server:
56444     description: |
56445       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
56446       ###### Related Nodes
56447       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
56448
56449       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
56450     required:
56451     - vig-address-type
56452     properties:
56453       vig-address-type:
56454         type: string
56455         description: indicates whether the VIG is for AVPN or INTERNET
56456       ipaddress-v4-vig:
56457         type: string
56458         description: v4 IP of the vig server
56459       ipaddress-v6-vig:
56460         type: string
56461         description: v6 IP of the vig server
56462   vig-servers:
56463     properties:
56464       vig-server:
56465         type: array
56466         items:
56467           $ref: "#/patchDefinitions/vig-server"
56468   vip-ipv4-address-list:
56469     description: |
56470       IPv4 Address Range
56471       ###### Related Nodes
56472       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
56473       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
56474       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
56475       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
56476
56477     required:
56478     - vip-ipv4-address
56479     properties:
56480       vip-ipv4-address:
56481         type: string
56482         description: IP address
56483       vip-ipv4-prefix-length:
56484         type: integer
56485         format: int64
56486         description: Prefix length, 32 for single address
56487       vlan-id-inner:
56488         type: integer
56489         format: int64
56490         description: Inner VLAN tag
56491       vlan-id-outer:
56492         type: integer
56493         format: int64
56494         description: Outer VLAN tag
56495       is-floating:
56496         type: boolean
56497         description: Indicator of fixed or floating address
56498   vip-ipv6-address-list:
56499     description: |
56500       IPv6 Address Range
56501       ###### Related Nodes
56502       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
56503       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
56504       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
56505       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
56506
56507     required:
56508     - vip-ipv6-address
56509     properties:
56510       vip-ipv6-address:
56511         type: string
56512         description: IP address
56513       vip-ipv6-prefix-length:
56514         type: integer
56515         format: int64
56516         description: Prefix length, 128 for single address
56517       vlan-id-inner:
56518         type: integer
56519         format: int64
56520         description: Inner VLAN tag
56521       vlan-id-outer:
56522         type: integer
56523         format: int64
56524         description: Outer VLAN tag
56525       is-floating:
56526         type: boolean
56527         description: Indicator of fixed or floating address
56528   virtual-data-center:
56529     description: |
56530       Virtual organization of cloud infrastructure elements in a data center context
56531       ###### Related Nodes
56532       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
56533       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
56534       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
56535
56536     required:
56537     - vdc-id
56538     - vdc-name
56539     properties:
56540       vdc-id:
56541         type: string
56542         description: Unique ID of the vdc
56543       vdc-name:
56544         type: string
56545         description: Name of the virtual data center
56546   virtual-data-centers:
56547     description: |
56548       Virtual organization of cloud infrastructure elements in a data center context
56549     properties:
56550       virtual-data-center:
56551         type: array
56552         items:
56553           $ref: "#/patchDefinitions/virtual-data-center"
56554   vlan:
56555     description: |
56556       Definition of vlan
56557       ###### Related Nodes
56558       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
56559       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
56560       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
56561       - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
56562       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
56563       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
56564       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
56565
56566       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
56567       -(2) IF this VLAN node is deleted, this TO node is DELETED also
56568       -(4) IF this TO node is deleted, this VLAN is DELETED also
56569     required:
56570     - vlan-interface
56571     - in-maint
56572     - is-ip-unnumbered
56573     properties:
56574       vlan-interface:
56575         type: string
56576         description: String that identifies the interface
56577       vlan-id-inner:
56578         type: integer
56579         format: int64
56580         description: Inner VLAN tag
56581       vlan-id-outer:
56582         type: integer
56583         format: int64
56584         description: Outer VLAN tag
56585   vlans:
56586     properties:
56587       vlan:
56588         type: array
56589         items:
56590           $ref: "#/patchDefinitions/vlan"
56591   vnf:
56592     description: |
56593       Abstract vnf class
56594     required:
56595     - vnf-id
56596     properties:
56597       vnf-id:
56598         type: string
56599         description: Unique id of VNF.  This is unique across the graph.
56600   vnf-image:
56601     description: |
56602       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
56603       ###### Related Nodes
56604       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
56605
56606       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
56607
56608     required:
56609     - vnf-image-uuid
56610     - application
56611     - application-vendor
56612     properties:
56613       vnf-image-uuid:
56614         type: string
56615         description: Unique ID of this asset
56616       application:
56617         type: string
56618         description: The application that the image instantiates.
56619       application-vendor:
56620         type: string
56621         description: The vendor of the application.
56622       application-version:
56623         type: string
56624         description: The version of the application.
56625       selflink:
56626         type: string
56627         description: URL to endpoint where AAI can get more details
56628   vnf-images:
56629     description: |
56630       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
56631     properties:
56632       vnf-image:
56633         type: array
56634         items:
56635           $ref: "#/patchDefinitions/vnf-image"
56636   vnfc:
56637     description: |
56638       ###### Related Nodes
56639       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
56640       - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
56641       - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
56642       - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
56643       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
56644       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
56645       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
56646       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
56647
56648       -(1) IF this VNFC node is deleted, this FROM node is DELETED also
56649       -(4) IF this TO node is deleted, this VNFC is DELETED also
56650     required:
56651     - vnfc-name
56652     - nfc-naming-code
56653     - nfc-function
56654     - in-maint
56655     - is-closed-loop-disabled
56656     properties:
56657       vnfc-name:
56658         type: string
56659         description: Unique ID of vnfc.
56660       nfc-naming-code:
56661         type: string
56662         description: Short code that is used in naming instances of the item being modeled
56663       nfc-function:
56664         type: string
56665         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
56666       prov-status:
56667         type: string
56668         description: prov status of this vnfc
56669       orchestration-status:
56670         type: string
56671         description: Orchestration status of this VNF, mastered by APP-C
56672       ipaddress-v4-oam-vip:
56673         type: string
56674         description: Oam V4 vip address of this vnfc
56675       in-maint:
56676         type: boolean
56677         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
56678       is-closed-loop-disabled:
56679         type: boolean
56680         description: used to indicate whether closed loop function is enabled on this node
56681       group-notation:
56682         type: string
56683         description: Group notation of VNFC
56684       model-invariant-id:
56685         type: string
56686         description: the ASDC model id for this resource or service model.
56687       model-version-id:
56688         type: string
56689         description: the ASDC model version for this resource or service model.
56690   vnfcs:
56691     description: |
56692       virtual network components associated with a vserver from application controller.
56693     properties:
56694       vnfc:
56695         type: array
56696         items:
56697           $ref: "#/patchDefinitions/vnfc"
56698   volume:
56699     description: |
56700       Ephemeral Block storage volume.
56701       ###### Related Nodes
56702       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
56703
56704       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
56705     required:
56706     - volume-id
56707     - volume-selflink
56708     properties:
56709       volume-id:
56710         type: string
56711         description: Unique ID of block storage volume relative to the vserver.
56712       volume-selflink:
56713         type: string
56714         description: URL to endpoint where AAI can get more details
56715   volume-group:
56716     description: |
56717       Persistent block-level storage.
56718       ###### Related Nodes
56719       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
56720       - TO complex( volume-group LocatedIn complex, MANY2ONE)
56721       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
56722       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
56723       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
56724
56725     required:
56726     - volume-group-id
56727     - volume-group-name
56728     - vnf-type
56729     properties:
56730       volume-group-id:
56731         type: string
56732         description: Unique ID of volume-group.
56733       volume-group-name:
56734         type: string
56735         description: Name of the volume group.
56736       heat-stack-id:
56737         type: string
56738         description: Heat stack id corresponding to this volume-group
56739       vnf-type:
56740         type: string
56741         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
56742       orchestration-status:
56743         type: string
56744         description: Orchestration status of this volume-group
56745       model-customization-id:
56746         type: string
56747         description: captures the id of all the configuration used to customize the resource for the service.
56748       vf-module-model-customization-id:
56749         type: string
56750         description: helps relate the volume group to the vf-module whose components will require the volume group
56751   volume-groups:
56752     description: |
56753       Collection of persistent block-level storage.
56754     properties:
56755       volume-group:
56756         type: array
56757         items:
56758           $ref: "#/patchDefinitions/volume-group"
56759   volumes:
56760     description: |
56761       Collection of ephemeral Block storage volumes.
56762     properties:
56763       volume:
56764         type: array
56765         items:
56766           $ref: "#/patchDefinitions/volume"
56767   vpls-pe:
56768     description: |
56769       VPLS Provider Edge routers.
56770       ###### Related Nodes
56771       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
56772       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
56773       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
56774       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
56775
56776       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
56777     required:
56778     - equipment-name
56779     properties:
56780       equipment-name:
56781         type: string
56782       prov-status:
56783         type: string
56784         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
56785       ipv4-oam-address:
56786         type: string
56787         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
56788       equipment-role:
56789         type: string
56790         description: Client should send valid enumerated value, e.g., VPLS-PE.
56791       vlan-id-outer:
56792         type: integer
56793         format: int64
56794         description: Temporary location for stag to get to VCE
56795   vpls-pes:
56796     description: |
56797       Collection of VPLS Provider Edge routers
56798     properties:
56799       vpls-pe:
56800         type: array
56801         items:
56802           $ref: "#/patchDefinitions/vpls-pe"
56803   vpn-binding:
56804     description: |
56805       VPN binding
56806       ###### Related Nodes
56807       - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
56808       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
56809       - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
56810       - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
56811
56812       -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
56813       -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
56814
56815     required:
56816     - vpn-id
56817     - vpn-name
56818     properties:
56819       vpn-id:
56820         type: string
56821         description: VPN ID, globally unique within A&AI
56822       vpn-name:
56823         type: string
56824         description: VPN Name
56825       vpn-platform:
56826         type: string
56827         description: the platform associated with the VPN example AVPN, Mobility
56828       vpn-type:
56829         type: string
56830         description: Type of the vpn, should be taken from enumerated/valid values
56831       vpn-region:
56832         type: string
56833         description: region of customer vpn
56834       customer-vpn-id:
56835         type: string
56836         description: id for this customer vpn
56837       route-distinguisher:
56838         type: string
56839         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
56840   vpn-bindings:
56841     properties:
56842       vpn-binding:
56843         type: array
56844         items:
56845           $ref: "#/patchDefinitions/vpn-binding"
56846   vserver:
56847     description: |
56848       Virtual Servers, aka virtual machine or VM.
56849       ###### Related Nodes
56850       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
56851       - TO flavor( vserver Uses flavor, MANY2ONE)
56852       - TO image( vserver Uses image, MANY2ONE)
56853       - TO pserver( vserver HostedOn pserver, MANY2ONE)
56854       - TO snapshot( vserver Uses snapshot, ONE2ONE)
56855       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
56856       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
56857       - FROM vce( vce HostedOn vserver, ONE2MANY)
56858       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
56859       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
56860       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
56861
56862       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
56863       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
56864     required:
56865     - vserver-id
56866     - vserver-name
56867     - vserver-selflink
56868     - in-maint
56869     - is-closed-loop-disabled
56870     properties:
56871       vserver-id:
56872         type: string
56873         description: Unique identifier for this vserver relative to its tenant
56874       vserver-name:
56875         type: string
56876         description: Name of vserver
56877       vserver-name2:
56878         type: string
56879         description: Alternative name of vserver
56880       prov-status:
56881         type: string
56882         description: Trigger for operational monitoring of this resource by Service Assurance systems.
56883       vserver-selflink:
56884         type: string
56885         description: URL to endpoint where AAI can get more details
56886       in-maint:
56887         type: boolean
56888         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
56889       is-closed-loop-disabled:
56890         type: boolean
56891         description: Used to indicate whether closed loop function is enabled on this node
56892   vservers:
56893     description: |
56894       Collection of virtual Servers, aka virtual machines or VMs.
56895     properties:
56896       vserver:
56897         type: array
56898         items:
56899           $ref: "#/patchDefinitions/vserver"
56900   zone:
56901     description: |
56902       A zone is a grouping of assets in a location homing to the same connections into the CBB
56903       ###### Related Nodes
56904       - TO complex( zone LocatedIn complex, MANY2ONE)
56905       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
56906       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
56907       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
56908       - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
56909
56910     required:
56911     - zone-id
56912     - zone-name
56913     - design-type
56914     - zone-context
56915     properties:
56916       zone-id:
56917         type: string
56918         description: Code assigned by AIC to the zone
56919       zone-name:
56920         type: string
56921         description: English name associated with the zone
56922       design-type:
56923         type: string
56924         description: Design of zone [Medium/Large…]
56925       zone-context:
56926         type: string
56927         description: Context of zone [production/test]
56928       status:
56929         type: string
56930         description: Status of a zone.
56931   zones:
56932     description: |
56933       Collection of zones
56934     properties:
56935       zone:
56936         type: array
56937         items:
56938           $ref: "#/patchDefinitions/zone"
56939 getDefinitions:
56940   action:
56941     properties:
56942       action-type:
56943         type: string
56944       action-data:
56945         type: array
56946         items:
56947           $ref: "#/getDefinitions/action-data"
56948   action-data:
56949     properties:
56950       property-name:
56951         type: string
56952       property-value:
56953         type: string
56954   actions:
56955     description: |
56956       APIs that are more action related than REST (e.g., notify, update).
56957     properties:
56958       update:
56959         type: object
56960         $ref: "#/getDefinitions/update"
56961       notify:
56962         type: object
56963         $ref: "#/getDefinitions/notify"
56964   allotted-resource:
56965     description: |
56966       Represents a slice or partial piece of a resource that gets separately allotted
56967       ###### Related Nodes
56968       - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
56969       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
56970       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
56971       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
56972       - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
56973       - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
56974       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
56975       - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
56976       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
56977       - TO model-ver( allotted-resource IsA model-ver, Many2One)
56978       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
56979       - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
56980       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
56981       - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
56982
56983       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
56984       -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
56985       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
56986     required:
56987     - id
56988     properties:
56989       id:
56990         type: string
56991         description: Allotted Resource id UUID assigned to this instance.
56992       description:
56993         type: string
56994         description: The descriptive information assigned to this allotted resource instance
56995       selflink:
56996         type: string
56997         description: Link back to more information in the controller
56998       model-invariant-id:
56999         type: string
57000         description: the ASDC model id for this resource or service model.
57001       model-version-id:
57002         type: string
57003         description: the ASDC model version for this resource or service model.
57004       persona-model-version:
57005         type: string
57006         description: the ASDC model version for this resource or service model.
57007       resource-version:
57008         type: string
57009         description: Concurrency value
57010       orchestration-status:
57011         type: string
57012         description: Orchestration status
57013       operational-status:
57014         type: string
57015         description: Indicator for whether the resource is considered operational
57016       type:
57017         type: string
57018         description: Generic description of the type of allotted resource.
57019       role:
57020         type: string
57021         description: role in the network that this resource will be providing.
57022       tunnel-xconnects:
57023         type: array
57024         items:
57025           $ref: "#/getDefinitions/tunnel-xconnect"
57026       relationship-list:
57027         type: array
57028         items:
57029           $ref: "#/getDefinitions/relationship"
57030   allotted-resources:
57031     description: |
57032       This object is used to store slices of services being offered
57033     properties:
57034       allotted-resource:
57035         type: array
57036         items:
57037           $ref: "#/getDefinitions/allotted-resource"
57038   availability-zone:
57039     description: |
57040       Availability zone, a collection of compute hosts/pservers
57041       ###### Related Nodes
57042       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
57043       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
57044       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
57045       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
57046       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
57047       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
57048       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
57049       - FROM vce( vce Uses availability-zone, MANY2MANY)
57050
57051       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
57052       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
57053
57054     required:
57055     - availability-zone-name
57056     - hypervisor-type
57057     properties:
57058       availability-zone-name:
57059         type: string
57060         description: Name of the availability zone.  Unique across a cloud region
57061       hypervisor-type:
57062         type: string
57063         description: Type of hypervisor.  Source of truth should define valid values.
57064       operational-status:
57065         type: string
57066         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
57067       resource-version:
57068         type: string
57069         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57070       relationship-list:
57071         type: array
57072         items:
57073           $ref: "#/getDefinitions/relationship"
57074   availability-zones:
57075     description: |
57076       Collection of availability zones
57077     properties:
57078       availability-zone:
57079         type: array
57080         items:
57081           $ref: "#/getDefinitions/availability-zone"
57082   az-and-dvs-switches:
57083     properties:
57084       dvs-switches:
57085         type: object
57086         $ref: "#/getDefinitions/dvs-switches"
57087       availability-zone:
57088         type: object
57089         $ref: "#/getDefinitions/availability-zone"
57090   business:
57091     description: |
57092       Namespace for business related constructs
57093     properties:
57094       connectors:
57095         type: array
57096         items:
57097           $ref: "#/getDefinitions/connector"
57098       customers:
57099         type: array
57100         items:
57101           $ref: "#/getDefinitions/customer"
57102       lines-of-business:
57103         type: array
57104         items:
57105           $ref: "#/getDefinitions/line-of-business"
57106       owning-entities:
57107         type: array
57108         items:
57109           $ref: "#/getDefinitions/owning-entity"
57110       platforms:
57111         type: array
57112         items:
57113           $ref: "#/getDefinitions/platform"
57114       projects:
57115         type: array
57116         items:
57117           $ref: "#/getDefinitions/project"
57118   class-of-service:
57119     description: |
57120       ###### Related Nodes
57121       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
57122
57123       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
57124     required:
57125     - cos
57126     properties:
57127       cos:
57128         type: string
57129         description: unique identifier of probe
57130       probe-id:
57131         type: string
57132         description: identifier of probe
57133       probe-type:
57134         type: string
57135         description: type of probe
57136       resource-version:
57137         type: string
57138         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57139       relationship-list:
57140         type: array
57141         items:
57142           $ref: "#/getDefinitions/relationship"
57143   classes-of-service:
57144     description: |
57145       class-of-service of probe
57146     properties:
57147       class-of-service:
57148         type: array
57149         items:
57150           $ref: "#/getDefinitions/class-of-service"
57151   cloud-infrastructure:
57152     description: |
57153       Namespace for cloud infrastructure.
57154     properties:
57155       complexes:
57156         type: array
57157         items:
57158           $ref: "#/getDefinitions/complex"
57159       cloud-regions:
57160         type: array
57161         items:
57162           $ref: "#/getDefinitions/cloud-region"
57163       network-profiles:
57164         type: array
57165         items:
57166           $ref: "#/getDefinitions/network-profile"
57167       pservers:
57168         type: array
57169         items:
57170           $ref: "#/getDefinitions/pserver"
57171       virtual-data-centers:
57172         type: array
57173         items:
57174           $ref: "#/getDefinitions/virtual-data-center"
57175       operational-environments:
57176         type: array
57177         items:
57178           $ref: "#/getDefinitions/operational-environment"
57179   cloud-region:
57180     description: |
57181       cloud-region designates an installation of a cloud cluster or region or instantiation.
57182       ###### Related Nodes
57183       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
57184       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
57185       - TO zone( cloud-region LocatedIn zone, MANY2ONE)
57186       - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
57187       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
57188       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
57189       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
57190       - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)
57191       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
57192       - FROM image( image BelongsTo cloud-region, MANY2ONE)
57193       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
57194       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
57195       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
57196       - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
57197       - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
57198       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
57199       - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
57200       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
57201
57202       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
57203       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
57204
57205     required:
57206     - cloud-owner
57207     - cloud-region-id
57208     - sriov-automation
57209     properties:
57210       cloud-owner:
57211         type: string
57212         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
57213       cloud-region-id:
57214         type: string
57215         description: Identifier used by the vendor for the region. Second part of composite key
57216       cloud-type:
57217         type: string
57218         description: Type of the cloud (e.g., openstack)
57219       owner-defined-type:
57220         type: string
57221         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
57222       cloud-region-version:
57223         type: string
57224         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
57225       identity-url:
57226         type: string
57227         description: URL of the keystone identity service
57228       cloud-zone:
57229         type: string
57230         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
57231       complex-name:
57232         type: string
57233         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
57234       sriov-automation:
57235         type: boolean
57236         description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
57237       cloud-extra-info:
57238         type: string
57239         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
57240       cloud-epa-caps:
57241         type: string
57242         description: MultiVIM will discover and expose EPA capabilities.
57243       resource-version:
57244         type: string
57245         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57246       volume-groups:
57247         type: array
57248         items:
57249           $ref: "#/getDefinitions/volume-group"
57250       tenants:
57251         type: array
57252         items:
57253           $ref: "#/getDefinitions/tenant"
57254       flavors:
57255         type: array
57256         items:
57257           $ref: "#/getDefinitions/flavor"
57258       group-assignments:
57259         type: array
57260         items:
57261           $ref: "#/getDefinitions/group-assignment"
57262       snapshots:
57263         type: array
57264         items:
57265           $ref: "#/getDefinitions/snapshot"
57266       images:
57267         type: array
57268         items:
57269           $ref: "#/getDefinitions/image"
57270       dvs-switches:
57271         type: array
57272         items:
57273           $ref: "#/getDefinitions/dvs-switch"
57274       oam-networks:
57275         type: array
57276         items:
57277           $ref: "#/getDefinitions/oam-network"
57278       availability-zones:
57279         type: array
57280         items:
57281           $ref: "#/getDefinitions/availability-zone"
57282       relationship-list:
57283         type: array
57284         items:
57285           $ref: "#/getDefinitions/relationship"
57286       vip-ipv4-address-list:
57287         type: array
57288         items:
57289           $ref: "#/getDefinitions/vip-ipv4-address-list"
57290       vip-ipv6-address-list:
57291         type: array
57292         items:
57293           $ref: "#/getDefinitions/vip-ipv6-address-list"
57294       hpa-capabilities:
57295         type: array
57296         items:
57297           $ref: "#/getDefinitions/hpa-capability"
57298         description: List of cloud-region specific HPA Capabilities
57299   cloud-regions:
57300     properties:
57301       cloud-region:
57302         type: array
57303         items:
57304           $ref: "#/getDefinitions/cloud-region"
57305   complex:
57306     description: |
57307       Collection of physical locations that can house cloud-regions.
57308       ###### Related Nodes
57309       - TO l3-network( complex Uses l3-network, MANY2MANY)
57310       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
57311       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
57312       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
57313       - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
57314       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
57315       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
57316       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
57317       - FROM vce( vce LocatedIn complex, MANY2MANY)
57318       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
57319       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
57320       - FROM zone( zone LocatedIn complex, MANY2ONE)
57321
57322       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
57323       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
57324
57325     required:
57326     - physical-location-id
57327     - physical-location-type
57328     - street1
57329     - city
57330     - postal-code
57331     - country
57332     - region
57333     properties:
57334       physical-location-id:
57335         type: string
57336         description: Unique identifier for physical location, e.g., CLLI
57337       data-center-code:
57338         type: string
57339         description: Data center code which can be an alternate way to identify a complex
57340       complex-name:
57341         type: string
57342         description: Gamma complex name for LCP instance.
57343       identity-url:
57344         type: string
57345         description: URL of the keystone identity service
57346       resource-version:
57347         type: string
57348         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57349       physical-location-type:
57350         type: string
57351         description: Type, e.g., central office, data center.
57352       street1:
57353         type: string
57354       street2:
57355         type: string
57356       city:
57357         type: string
57358       state:
57359         type: string
57360       postal-code:
57361         type: string
57362       country:
57363         type: string
57364       region:
57365         type: string
57366       latitude:
57367         type: string
57368       longitude:
57369         type: string
57370       elevation:
57371         type: string
57372       lata:
57373         type: string
57374       ctag-pools:
57375         type: array
57376         items:
57377           $ref: "#/getDefinitions/ctag-pool"
57378       relationship-list:
57379         type: array
57380         items:
57381           $ref: "#/getDefinitions/relationship"
57382   complexes:
57383     description: |
57384       Collection of physical locations that can house cloud-regions.
57385     properties:
57386       complex:
57387         type: array
57388         items:
57389           $ref: "#/getDefinitions/complex"
57390   configuration:
57391     description: |
57392       Port Mirror Configuration.
57393       ###### Related Nodes
57394       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
57395       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
57396       - TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
57397       - TO pnf( configuration AppliesTo pnf, ONE2MANY)
57398       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
57399       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
57400       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
57401       - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
57402       - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
57403       - FROM evc( evc BelongsTo configuration, ONE2ONE)(1)
57404       - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)
57405
57406       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
57407       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
57408       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
57409     required:
57410     - configuration-id
57411     - configuration-type
57412     - configuration-sub-type
57413     - orchestration-status
57414     - operational-status
57415     - configuration-selflink
57416     - model-customization-id
57417     properties:
57418       configuration-id:
57419         type: string
57420         description: UUID assigned to configuration.
57421       management-option:
57422         type: string
57423         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
57424       configuration-name:
57425         type: string
57426         description: Name of the configuration.
57427       configuration-type:
57428         type: string
57429         description: port-mirroring-configuration.
57430       configuration-sub-type:
57431         type: string
57432         description: vprobe, pprobe.
57433       model-invariant-id:
57434         type: string
57435         description: the ASDC model id for this resource or service model.
57436       model-version-id:
57437         type: string
57438         description: the ASDC model version for this resource or service model.
57439       orchestration-status:
57440         type: string
57441         description: Orchestration status of the configuration.
57442       operational-status:
57443         type: string
57444         description: Indicator for whether the resource is considered operational.
57445       configuration-selflink:
57446         type: string
57447         description: URL to endpoint where AAI can get more details from SDN-GC.
57448       model-customization-id:
57449         type: string
57450         description: id of  the configuration used to customize the resource
57451       tunnel-bandwidth:
57452         type: string
57453         description: DHV Site Effective Bandwidth
57454       vendor-allowed-max-bandwidth:
57455         type: string
57456         description: Velocloud Nominal Throughput - VNT
57457       resource-version:
57458         type: string
57459         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57460       relationship-list:
57461         type: array
57462         items:
57463           $ref: "#/getDefinitions/relationship"
57464       metadata:
57465         type: array
57466         items:
57467           $ref: "#/getDefinitions/metadatum"
57468       forwarder-evcs:
57469         type: array
57470         items:
57471           $ref: "#/getDefinitions/forwarder-evc"
57472       evcs:
57473         type: array
57474         items:
57475           $ref: "#/getDefinitions/evc"
57476   configurations:
57477     description: |
57478       Collection of configurations
57479     properties:
57480       configuration:
57481         type: array
57482         items:
57483           $ref: "#/getDefinitions/configuration"
57484   connector:
57485     description: |
57486       Collection of resource instances used to connect a variety of disparate inventory widgets
57487       ###### Related Nodes
57488       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
57489       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
57490       - FROM service-instance( service-instance Uses connector, MANY2MANY)
57491
57492       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
57493     required:
57494     - resource-instance-id
57495     properties:
57496       resource-instance-id:
57497         type: string
57498         description: Unique id of resource instance.
57499       resource-version:
57500         type: string
57501         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57502       model-invariant-id:
57503         type: string
57504         description: the ASDC model id for this resource or service model.
57505       model-version-id:
57506         type: string
57507         description: the ASDC model version for this resource or service model.
57508       persona-model-version:
57509         type: string
57510         description: the ASDC model version for this resource or service model.
57511       widget-model-id:
57512         type: string
57513         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
57514       widget-model-version:
57515         type: string
57516         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
57517       relationship-list:
57518         type: array
57519         items:
57520           $ref: "#/getDefinitions/relationship"
57521       metadata:
57522         type: array
57523         items:
57524           $ref: "#/getDefinitions/metadatum"
57525   connectors:
57526     description: |
57527       Collection of resource instances used to connect a variety of disparate inventory widgets
57528     properties:
57529       connector:
57530         type: array
57531         items:
57532           $ref: "#/getDefinitions/connector"
57533   constrained-element-set:
57534     description: |
57535       This is how we would capture constraints defining allowed sets of elements.
57536       ###### Related Nodes
57537       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
57538       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
57539       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
57540
57541       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
57542       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
57543     required:
57544     - constrained-element-set-uuid
57545     - constraint-type
57546     - check-type
57547     properties:
57548       constrained-element-set-uuid:
57549         type: string
57550       constraint-type:
57551         type: string
57552       check-type:
57553         type: string
57554       resource-version:
57555         type: string
57556       element-choice-sets:
57557         type: array
57558         items:
57559           $ref: "#/getDefinitions/element-choice-set"
57560       relationship-list:
57561         type: array
57562         items:
57563           $ref: "#/getDefinitions/relationship"
57564   constrained-element-sets:
57565     properties:
57566       constrained-element-set:
57567         type: array
57568         items:
57569           $ref: "#/getDefinitions/constrained-element-set"
57570   ctag-assignment:
57571     description: |
57572       ###### Related Nodes
57573       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
57574       - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
57575
57576       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
57577     required:
57578     - vlan-id-inner
57579     properties:
57580       vlan-id-inner:
57581         type: integer
57582         format: int64
57583         description: id.
57584       resource-version:
57585         type: string
57586         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57587       relationship-list:
57588         type: array
57589         items:
57590           $ref: "#/getDefinitions/relationship"
57591   ctag-assignments:
57592     properties:
57593       ctag-assignment:
57594         type: array
57595         items:
57596           $ref: "#/getDefinitions/ctag-assignment"
57597   ctag-pool:
57598     description: |
57599       A collection of C tags (vlan tags) grouped for a specific purpose.
57600       ###### Related Nodes
57601       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
57602       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
57603       - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
57604       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
57605
57606       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
57607     required:
57608     - target-pe
57609     - availability-zone-name
57610     - ctag-pool-purpose
57611     properties:
57612       target-pe:
57613         type: string
57614         description: The Target provider edge router
57615       availability-zone-name:
57616         type: string
57617         description: Name of the availability zone
57618       ctag-pool-purpose:
57619         type: string
57620         description: Describes what the intended purpose of this pool is.
57621       ctag-values:
57622         type: string
57623         description: Comma separated list of ctags
57624       resource-version:
57625         type: string
57626         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57627       relationship-list:
57628         type: array
57629         items:
57630           $ref: "#/getDefinitions/relationship"
57631   ctag-pools:
57632     properties:
57633       ctag-pool:
57634         type: array
57635         items:
57636           $ref: "#/getDefinitions/ctag-pool"
57637   customer:
57638     description: |
57639       customer identifiers to provide linkage back to BSS information.
57640       ###### Related Nodes
57641       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
57642
57643       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
57644     required:
57645     - global-customer-id
57646     - subscriber-name
57647     - subscriber-type
57648     properties:
57649       global-customer-id:
57650         type: string
57651         description: Global customer id used across ECOMP to uniquely identify customer.
57652       subscriber-name:
57653         type: string
57654         description: Subscriber name, an alternate way to retrieve a customer.
57655       subscriber-type:
57656         type: string
57657         description: Subscriber type, a way to provide VID with only the INFRA customers.
57658       resource-version:
57659         type: string
57660         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57661       service-subscriptions:
57662         type: array
57663         items:
57664           $ref: "#/getDefinitions/service-subscription"
57665       relationship-list:
57666         type: array
57667         items:
57668           $ref: "#/getDefinitions/relationship"
57669   customers:
57670     description: |
57671       Collection of customer identifiers to provide linkage back to BSS information.
57672     properties:
57673       customer:
57674         type: array
57675         items:
57676           $ref: "#/getDefinitions/customer"
57677   cvlan-tag-entry:
57678     required:
57679     - cvlan-tag
57680     properties:
57681       cvlan-tag:
57682         type: integer
57683         format: int64
57684         description: See mis-na-virtualization-platform.yang
57685       resource-version:
57686         type: string
57687         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57688       relationship-list:
57689         type: array
57690         items:
57691           $ref: "#/getDefinitions/relationship"
57692   cvlan-tags:
57693     properties:
57694       cvlan-tag-entry:
57695         type: array
57696         items:
57697           $ref: "#/getDefinitions/cvlan-tag-entry"
57698   dvs-switch:
57699     description: |
57700       Digital virtual switch metadata, used by SDN-C to configure VCEs.  A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
57701       ###### Related Nodes
57702       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
57703       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
57704
57705     required:
57706     - switch-name
57707     - vcenter-url
57708     properties:
57709       switch-name:
57710         type: string
57711         description: DVS switch name
57712       vcenter-url:
57713         type: string
57714         description: URL used to reach the vcenter
57715       resource-version:
57716         type: string
57717         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57718       relationship-list:
57719         type: array
57720         items:
57721           $ref: "#/getDefinitions/relationship"
57722   dvs-switches:
57723     description: |
57724       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
57725     properties:
57726       dvs-switch:
57727         type: array
57728         items:
57729           $ref: "#/getDefinitions/dvs-switch"
57730   edge-prop-names:
57731     description: |
57732       Internal map to define the properties of an edge and interpret the map EdgeRules
57733     properties:
57734       edgeLabel:
57735         type: string
57736       direction:
57737         type: string
57738       multiplicityRule:
57739         type: string
57740       contains-other-v:
57741         type: string
57742       delete-other-v:
57743         type: string
57744       SVC-INFRA:
57745         type: string
57746       prevent-delete:
57747         type: string
57748       aai-uuid:
57749         type: string
57750   edge-tag-query-request:
57751     properties:
57752       edge-tag:
57753         type: string
57754       result-detail:
57755         type: string
57756       start-node-type:
57757         type: string
57758       start-node-filter:
57759         type: array
57760         items:
57761           $ref: "#/getDefinitions/start-node-filter"
57762       include-node-filter:
57763         type: array
57764         items:
57765           $ref: "#/getDefinitions/include-node-filter"
57766       secondary-filter:
57767         type: array
57768         items:
57769           $ref: "#/getDefinitions/secondary-filter"
57770   edge-tag-query-result:
57771     properties:
57772       tagged-inventory-item-list:
57773         type: array
57774         items:
57775           $ref: "#/getDefinitions/tagged-inventory-item-list"
57776   element-choice-set:
57777     description: |
57778       This is how we would capture constraints defining allowed sets of elements.
57779       ###### Related Nodes
57780       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
57781       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
57782
57783       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
57784       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
57785     required:
57786     - element-choice-set-uuid
57787     - element-choice-set-name
57788     properties:
57789       element-choice-set-uuid:
57790         type: string
57791       element-choice-set-name:
57792         type: string
57793       cardinality:
57794         type: string
57795       resource-version:
57796         type: string
57797       model-elements:
57798         type: array
57799         items:
57800           $ref: "#/getDefinitions/model-element"
57801       relationship-list:
57802         type: array
57803         items:
57804           $ref: "#/getDefinitions/relationship"
57805   element-choice-sets:
57806     properties:
57807       element-choice-set:
57808         type: array
57809         items:
57810           $ref: "#/getDefinitions/element-choice-set"
57811   entitlement:
57812     description: |
57813       Metadata for entitlement group.
57814       ###### Related Nodes
57815       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
57816       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
57817
57818       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
57819     required:
57820     - group-uuid
57821     - resource-uuid
57822     properties:
57823       group-uuid:
57824         type: string
57825         description: Unique ID for the entitlement group the resource comes from, should be uuid.
57826       resource-uuid:
57827         type: string
57828         description: Unique ID of an entitlement resource.
57829       resource-version:
57830         type: string
57831         description: Concurrency value
57832       relationship-list:
57833         type: array
57834         items:
57835           $ref: "#/getDefinitions/relationship"
57836   entitlements:
57837     description: |
57838       Entitlements, keyed by group-uuid and resource-uuid, related to license management
57839     properties:
57840       entitlement:
57841         type: array
57842         items:
57843           $ref: "#/getDefinitions/entitlement"
57844   esr-ems:
57845     description: |
57846       Persist EMS address information used by EMS driver.
57847       ###### Related Nodes
57848       - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
57849
57850       -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
57851     required:
57852     - ems-id
57853     properties:
57854       ems-id:
57855         type: string
57856         description: Unique ID of EMS.
57857       resource-version:
57858         type: string
57859         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57860       esr-system-info-list:
57861         type: object
57862         $ref: "#/getDefinitions/esr-system-info-list"
57863       relationship-list:
57864         type: object
57865         $ref: "#/getDefinitions/relationship-list"
57866   esr-ems-list:
57867     properties:
57868       esr-ems:
57869         type: array
57870         items:
57871           $ref: "#/getDefinitions/esr-ems"
57872   esr-system-info:
57873     description: |
57874       Persist common address information of external systems.
57875       ###### Related Nodes
57876       - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
57877       - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
57878       - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
57879       - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
57880
57881       -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
57882     required:
57883     - esr-system-info-id
57884     - user-name
57885     - password
57886     - system-type
57887     properties:
57888       esr-system-info-id:
57889         type: string
57890         description: Unique ID of esr system info.
57891       system-name:
57892         type: string
57893         description: name of external system.
57894       type:
57895         type: string
57896         description: type of external systems.
57897       vendor:
57898         type: string
57899         description: vendor of external systems.
57900       version:
57901         type: string
57902         description: version of external systems.
57903       service-url:
57904         type: string
57905         description: url used to access external systems.
57906       user-name:
57907         type: string
57908         description: username used to access external systems.
57909       password:
57910         type: string
57911         description: password used to access external systems.
57912       system-type:
57913         type: string
57914         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
57915       protocol:
57916         type: string
57917         description: protocol of third party SDNC, for example netconf/snmp.
57918       ssl-cacert:
57919         type: string
57920         description: ca file content if enabled ssl on auth-url.
57921       ssl-insecure:
57922         type: boolean
57923         description: Whether to verify VIM's certificate.
57924       ip-address:
57925         type: string
57926         description: service IP of ftp server.
57927       port:
57928         type: string
57929         description: service port of ftp server.
57930       cloud-domain:
57931         type: string
57932         description: domain info for authentication.
57933       default-tenant:
57934         type: string
57935         description: default tenant of VIM.
57936       passive:
57937         type: boolean
57938         description: ftp passive mode or not.
57939       remote-path:
57940         type: string
57941         description: resource or performance data file path.
57942       system-status:
57943         type: string
57944         description: the status of external system.
57945       resource-version:
57946         type: string
57947         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57948       relationship-list:
57949         type: object
57950         $ref: "#/getDefinitions/relationship-list"
57951   esr-system-info-list:
57952     description: |
57953       Collection of persistent block-level external system auth info.
57954     properties:
57955       esr-system-info:
57956         type: array
57957         items:
57958           $ref: "#/getDefinitions/esr-system-info"
57959   esr-thirdparty-sdnc:
57960     description: |
57961       Persist SDNC address information used by ONAP SDNC.
57962       ###### Related Nodes
57963       - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
57964       - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
57965
57966       -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
57967     required:
57968     - thirdparty-sdnc-id
57969     properties:
57970       thirdparty-sdnc-id:
57971         type: string
57972         description: Unique ID of SDNC.
57973       location:
57974         type: string
57975         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
57976       product-name:
57977         type: string
57978         description: password used to access SDNC server.
57979       resource-version:
57980         type: string
57981         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57982       esr-system-info-list:
57983         type: object
57984         $ref: "#/getDefinitions/esr-system-info-list"
57985       relationship-list:
57986         type: object
57987         $ref: "#/getDefinitions/relationship-list"
57988   esr-thirdparty-sdnc-list:
57989     properties:
57990       esr-thirdparty-sdnc:
57991         type: array
57992         items:
57993           $ref: "#/getDefinitions/esr-thirdparty-sdnc"
57994   esr-vnfm:
57995     description: |
57996       Persist VNFM address information used by VF-C.
57997       ###### Related Nodes
57998       - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
57999
58000       -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
58001     required:
58002     - vnfm-id
58003     properties:
58004       vnfm-id:
58005         type: string
58006         description: Unique ID of VNFM.
58007       vim-id:
58008         type: string
58009         description: indecate the VIM to deploy VNF.
58010       certificate-url:
58011         type: string
58012         description: certificate url of VNFM.
58013       resource-version:
58014         type: string
58015         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58016       esr-system-info-list:
58017         type: object
58018         $ref: "#/getDefinitions/esr-system-info-list"
58019       relationship-list:
58020         type: object
58021         $ref: "#/getDefinitions/relationship-list"
58022   esr-vnfm-list:
58023     properties:
58024       esr-vnfm:
58025         type: array
58026         items:
58027           $ref: "#/getDefinitions/esr-vnfm"
58028   evc:
58029     description: |
58030       evc object is an optional child object of the Configuration object.
58031       ###### Related Nodes
58032       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
58033
58034       -(4) IF this TO node is deleted, this EVC is DELETED also
58035     required:
58036     - evc-id
58037     properties:
58038       evc-id:
58039         type: string
58040         description: Unique/key field for the evc object
58041       forwarding-path-topology:
58042         type: string
58043         description: Point-to-Point, Multi-Point
58044       cir-value:
58045         type: string
58046         description: Commited Information Rate
58047       cir-units:
58048         type: string
58049         description: CIR units
58050       connection-diversity-group-id:
58051         type: string
58052         description: Diversity Group ID
58053       service-hours:
58054         type: string
58055         description: formerly Performance Group
58056       esp-evc-circuit-id:
58057         type: string
58058         description: EVC Circuit ID of ESP EVC
58059       esp-evc-cir-value:
58060         type: string
58061         description: Committed Information Rate (For ESP)
58062       esp-evc-cir-units:
58063         type: string
58064         description: CIR units (For ESP)
58065       esp-itu-code:
58066         type: string
58067         description: Identifies ESP
58068       collector-pop-clli:
58069         type: string
58070         description: Collector POP CLLI (from the hostname of the access pnf)
58071       inter-connect-type-ingress:
58072         type: string
58073         description: Interconnect type on ingress side of EVC.
58074       tagmode-access-ingress:
58075         type: string
58076         description: tagode for collector side of EVC
58077       tagmode-access-egress:
58078         type: string
58079         description: tagMode for network side of EVC
58080       relationship-list:
58081         type: array
58082         items:
58083           $ref: "#/getDefinitions/relationship"
58084       resource-version:
58085         type: string
58086         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58087   evcs:
58088     properties:
58089       evc:
58090         type: array
58091         items:
58092           $ref: "#/getDefinitions/evc"
58093   external-system:
58094     description: |
58095       Namespace for external system.
58096     properties:
58097       esr-ems-list:
58098         type: object
58099         $ref: "#/getDefinitions/esr-ems-list"
58100       esr-vnfm-list:
58101         type: object
58102         $ref: "#/getDefinitions/esr-vnfm-list"
58103       esr-thirdparty-sdnc-list:
58104         type: object
58105         $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
58106   extra-properties:
58107     description: |
58108       Extra properties for inventory item for response list
58109     properties:
58110       extra-property:
58111         type: array
58112         items:
58113           $ref: "#/getDefinitions/extra-property"
58114   extra-property:
58115     properties:
58116       property-name:
58117         type: string
58118       property-value:
58119         type: string
58120   flavor:
58121     description: |
58122       Openstack flavor.
58123       ###### Related Nodes
58124       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
58125       - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)
58126       - FROM vserver( vserver Uses flavor, MANY2ONE)
58127
58128       -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
58129
58130     required:
58131     - flavor-id
58132     - flavor-name
58133     - flavor-selflink
58134     properties:
58135       flavor-id:
58136         type: string
58137         description: Flavor id, expected to be unique across cloud-region.
58138       flavor-name:
58139         type: string
58140         description: Cloud Region Flavor name
58141       flavor-vcpus:
58142         type: integer
58143         format: int32
58144         description: Number of CPUs
58145       flavor-ram:
58146         type: integer
58147         format: int32
58148         description: Amount of memory
58149       flavor-disk:
58150         type: integer
58151         format: int32
58152         description: Disk space
58153       flavor-ephemeral:
58154         type: integer
58155         format: int32
58156         description: Amount of ephemeral disk space
58157       flavor-swap:
58158         type: string
58159         description: amount of swap space allocation
58160       flavor-is-public:
58161         type: boolean
58162         description: whether flavor is available to all users or private to the tenant it was created in.
58163       flavor-selflink:
58164         type: string
58165         description: URL to endpoint where AAI can get more details
58166       flavor-disabled:
58167         type: boolean
58168         description: Boolean as to whether this flavor is no longer enabled
58169       hpa-capabilities:
58170         type: array
58171         items:
58172           $ref: "#/getDefinitions/hpa-capability"
58173         description: List of flavor specific HPA Capabilities
58174       resource-version:
58175         type: string
58176         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58177       relationship-list:
58178         type: array
58179         items:
58180           $ref: "#/getDefinitions/relationship"
58181   flavors:
58182     description: |
58183       Collection of openstack flavors.
58184     properties:
58185       flavor:
58186         type: array
58187         items:
58188           $ref: "#/getDefinitions/flavor"
58189   forwarder:
58190     description: |
58191       Entity describing a sequenced segment of forwarding path
58192       ###### Related Nodes
58193       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
58194       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
58195       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
58196       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
58197       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
58198
58199       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
58200       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
58201     required:
58202     - sequence
58203     properties:
58204       sequence:
58205         type: integer
58206         format: int32
58207         description: Unique ID of this segmentation
58208       forwarder-role:
58209         type: string
58210         description: ingress, intermediate, egress
58211       relationship-list:
58212         type: array
58213         items:
58214           $ref: "#/getDefinitions/relationship"
58215       resource-version:
58216         type: string
58217         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58218   forwarder-evc:
58219     description: |
58220       forwarder object is an optional child object of the Configuration object.
58221       ###### Related Nodes
58222       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
58223
58224       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
58225     required:
58226     - forwarder-evc-id
58227     properties:
58228       forwarder-evc-id:
58229         type: string
58230         description: Key for forwarder-evc object
58231       circuit-id:
58232         type: string
58233         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
58234       ivlan:
58235         type: string
58236         description: Internal VLAN.
58237       svlan:
58238         type: string
58239         description: SVLAN value for ingress of egress forwarder.
58240       cvlan:
58241         type: string
58242         description: CVLAN value for ingress of egress forwarder.
58243       relationship-list:
58244         type: array
58245         items:
58246           $ref: "#/getDefinitions/relationship"
58247       resource-version:
58248         type: string
58249         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58250   forwarder-evcs:
58251     properties:
58252       forwarder-evc:
58253         type: array
58254         items:
58255           $ref: "#/getDefinitions/forwarder-evc"
58256   forwarders:
58257     properties:
58258       forwarder:
58259         type: array
58260         items:
58261           $ref: "#/getDefinitions/forwarder"
58262   forwarding-path:
58263     description: |
58264       Entity that describes the sequenced forwarding path between interfaces of services or resources
58265       ###### Related Nodes
58266       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
58267       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
58268       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
58269
58270       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
58271       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
58272       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
58273     required:
58274     - forwarding-path-id
58275     - forwarding-path-name
58276     properties:
58277       forwarding-path-id:
58278         type: string
58279         description: Unique ID of this FP
58280       forwarding-path-name:
58281         type: string
58282         description: Name of the FP
58283       relationship-list:
58284         type: array
58285         items:
58286           $ref: "#/getDefinitions/relationship"
58287       resource-version:
58288         type: string
58289         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58290       selflink:
58291         type: string
58292         description: the self link for this FP
58293       forwarders:
58294         type: array
58295         items:
58296           $ref: "#/getDefinitions/forwarder"
58297   forwarding-paths:
58298     properties:
58299       forwarding-path:
58300         type: array
58301         items:
58302           $ref: "#/getDefinitions/forwarding-path"
58303   generic-vnf:
58304     description: |
58305       General purpose VNF
58306       ###### Related Nodes
58307       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
58308       - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
58309       - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
58310       - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
58311       - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
58312       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
58313       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
58314       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
58315       - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
58316       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
58317       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
58318       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
58319       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
58320       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
58321       - TO model-ver( generic-vnf IsA model-ver, Many2One)
58322       - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
58323       - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
58324       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
58325       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
58326       - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
58327       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
58328       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
58329       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
58330       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
58331       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
58332       - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
58333       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
58334       - FROM platform( platform Uses generic-vnf, MANY2MANY)
58335
58336       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
58337       -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
58338     required:
58339     - vnf-id
58340     - vnf-name
58341     - vnf-type
58342     - in-maint
58343     - is-closed-loop-disabled
58344     properties:
58345       vnf-id:
58346         type: string
58347         description: Unique id of VNF.  This is unique across the graph.
58348       vnf-instance-id:
58349         type: string
58350         description: vnf instance id.
58351       vnf-name:
58352         type: string
58353         description: Name of VNF.
58354       vnf-name2:
58355         type: string
58356         description: Alternate name of VNF.
58357       vnf-type:
58358         type: string
58359         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
58360       service-id:
58361         type: string
58362         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
58363       regional-resource-zone:
58364         type: string
58365         description: Regional way of organizing pservers, source of truth should define values
58366       prov-status:
58367         type: string
58368         description: Trigger for operational monitoring of this resource by Service Assurance systems.
58369       operational-status:
58370         type: string
58371         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
58372       license-key:
58373         type: string
58374         description: OBSOLETE -  do not use
58375       equipment-role:
58376         type: string
58377         description: Client should send valid enumerated value
58378       orchestration-status:
58379         type: string
58380         description: Orchestration status of this VNF, used by MSO.
58381       vnf-package-name:
58382         type: string
58383       vnf-discriptor-name:
58384         type: string
58385         description: vnf discriptor name
58386       job-id:
58387         type: string
58388         description: job id corresponding to vnf
58389       heat-stack-id:
58390         type: string
58391         description: Heat stack id corresponding to this instance, managed by MSO
58392       mso-catalog-key:
58393         type: string
58394         description: Corresponds to the SDN-C catalog id used to configure this VCE
58395       management-option:
58396         type: string
58397         description: identifier of managed by ATT or customer
58398       ipv4-oam-address:
58399         type: string
58400         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
58401       ipv4-loopback0-address:
58402         type: string
58403         description: v4 Loopback0 address
58404       nm-lan-v6-address:
58405         type: string
58406         description: v6 Loopback address
58407       management-v6-address:
58408         type: string
58409         description: v6 management address
58410       vcpu:
58411         type: integer
58412         format: int64
58413         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
58414       vcpu-units:
58415         type: string
58416         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
58417       vmemory:
58418         type: integer
58419         format: int64
58420         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
58421       vmemory-units:
58422         type: string
58423         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
58424       vdisk:
58425         type: integer
58426         format: int64
58427         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
58428       vdisk-units:
58429         type: string
58430         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
58431       nshd:
58432         type: integer
58433         format: int64
58434         description: number of associated SHD in vnf.
58435       nvm:
58436         type: integer
58437         format: int64
58438         description: number of vms in vnf.
58439       nnet:
58440         type: integer
58441         format: int64
58442         description: number of network in vnf.
58443       in-maint:
58444         type: boolean
58445         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
58446       is-closed-loop-disabled:
58447         type: boolean
58448         description: used to indicate whether closed loop function is enabled on this node
58449       resource-version:
58450         type: string
58451         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58452       summary-status:
58453         type: string
58454         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
58455       encrypted-access-flag:
58456         type: boolean
58457         description: indicates whether generic-vnf access uses SSH
58458       entitlement-assignment-group-uuid:
58459         type: string
58460         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
58461       entitlement-resource-uuid:
58462         type: string
58463         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
58464       license-assignment-group-uuid:
58465         type: string
58466         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
58467       license-key-uuid:
58468         type: string
58469         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
58470       model-invariant-id:
58471         type: string
58472         description: the ASDC model id for this resource or service model.
58473       model-version-id:
58474         type: string
58475         description: the ASDC model version for this resource or service model.
58476       persona-model-version:
58477         type: string
58478         description: the ASDC model version for this resource or service model.
58479       model-customization-id:
58480         type: string
58481         description: captures the id of all the configuration used to customize the resource for the service.
58482       widget-model-id:
58483         type: string
58484         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
58485       widget-model-version:
58486         type: string
58487         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
58488       as-number:
58489         type: string
58490         description: as-number of the VNF
58491       regional-resource-subzone:
58492         type: string
58493         description: represents sub zone of the rr plane
58494       nf-type:
58495         type: string
58496         description: Generic description of the type of NF
58497       nf-function:
58498         type: string
58499         description: English description of Network function that the specific VNF deployment is providing
58500       nf-role:
58501         type: string
58502         description: role in the network that this model will be providing
58503       nf-naming-code:
58504         type: string
58505         description: string assigned to this model used for naming purposes
58506       selflink:
58507         type: string
58508         description: Path to the controller object.
58509       ipv4-oam-gateway-address:
58510         type: string
58511         description: Gateway address
58512       ipv4-oam-gateway-address-prefix-length:
58513         type: integer
58514         format: int32
58515         description: Prefix length for oam-address
58516       vlan-id-outer:
58517         type: integer
58518         format: int64
58519         description: Temporary location for S-TAG to get to VCE
58520       nm-profile-name:
58521         type: string
58522         description: Network Management profile of this VNF
58523       relationship-list:
58524         type: array
58525         items:
58526           $ref: "#/getDefinitions/relationship"
58527       l-interfaces:
58528         type: array
58529         items:
58530           $ref: "#/getDefinitions/l-interface"
58531       lag-interfaces:
58532         type: array
58533         items:
58534           $ref: "#/getDefinitions/lag-interface"
58535       vf-modules:
58536         type: array
58537         items:
58538           $ref: "#/getDefinitions/vf-module"
58539       licenses:
58540         type: array
58541         items:
58542           $ref: "#/getDefinitions/license"
58543       entitlements:
58544         type: array
58545         items:
58546           $ref: "#/getDefinitions/entitlement"
58547   generic-vnfs:
58548     description: |
58549       Collection of VNFs
58550     properties:
58551       generic-vnf:
58552         type: array
58553         items:
58554           $ref: "#/getDefinitions/generic-vnf"
58555   group-assignment:
58556     description: |
58557       Openstack group-assignment used to store exclusivity groups (EG).
58558       ###### Related Nodes
58559       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
58560       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
58561       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
58562
58563     required:
58564     - group-id
58565     - group-type
58566     - group-name
58567     properties:
58568       group-id:
58569         type: string
58570         description: Group id, expected to be unique across cloud-region.
58571       group-type:
58572         type: string
58573         description: Group type - the type of group this instance refers to
58574       group-name:
58575         type: string
58576         description: Group name - name assigned to the group
58577       group-description:
58578         type: string
58579         description: Group description - description of the group
58580       resource-version:
58581         type: string
58582         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58583       relationship-list:
58584         type: array
58585         items:
58586           $ref: "#/getDefinitions/relationship"
58587   group-assignments:
58588     description: |
58589       Collection of openstack group assignments
58590     properties:
58591       group-assignment:
58592         type: array
58593         items:
58594           $ref: "#/getDefinitions/group-assignment"
58595   host-route:
58596     description: |
58597       ###### Related Nodes
58598       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
58599
58600       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
58601     required:
58602     - host-route-id
58603     - route-prefix
58604     - next-hop
58605     properties:
58606       host-route-id:
58607         type: string
58608         description: host-route id
58609       route-prefix:
58610         type: string
58611         description: subnet prefix
58612       next-hop:
58613         type: string
58614         description: Could be ip-address, hostname, or service-instance
58615       next-hop-type:
58616         type: string
58617         description: Should be ip-address, hostname, or service-instance to match next-hop
58618       resource-version:
58619         type: string
58620         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58621       relationship-list:
58622         type: array
58623         items:
58624           $ref: "#/getDefinitions/relationship"
58625   host-routes:
58626     properties:
58627       host-route:
58628         type: array
58629         items:
58630           $ref: "#/getDefinitions/host-route"
58631   hpa-capabilities:
58632     description: |
58633       Collection of HPA Capabilities
58634     properties:
58635       hpa-capability:
58636         type: array
58637         items:
58638           $ref: "#/getDefinitions/hpa-capability"
58639   hpa-capability:
58640     description: |
58641       Represents a HPA capability
58642       ###### Related Nodes
58643       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
58644       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
58645       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
58646
58647       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
58648     required:
58649     - hpa-capability-id
58650     - hpa-feature
58651     properties:
58652       hpa-capability-id:
58653         type: string
58654         description: UUID to uniquely identify a HPA capability
58655       hpa-feature:
58656         type: string
58657         description: Name of the HPACapability
58658       hpa-version:
58659         type: string
58660         description: HPA schema version
58661       architecture:
58662         type: string
58663         description: Hardware architecture
58664       resource-version:
58665         type: string
58666         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58667       relationship-list:
58668         type: array
58669         items:
58670           $ref: "#/getDefinitions/relationship"
58671       hpa-feature-attributes:
58672         type: array
58673         items:
58674           $ref: "#/getDefinitions/hpa-feature-attributes"
58675   hpa-feature-attributes:
58676     description: |
58677       HPA Capability Feature attributes
58678       ###### Related Nodes
58679       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
58680
58681       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
58682     required:
58683     - hpa-attribute-key
58684     properties:
58685       hpa-attribute-key:
58686         type: string
58687         description: name of the specific HPA attribute
58688       hpa-attribute-value:
58689         type: string
58690         description: JSON string specifying the value, unit and type of the specific HPA attribute
58691       resource-version:
58692         type: string
58693         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58694       relationship-list:
58695         type: array
58696         items:
58697           $ref: "#/getDefinitions/relationship"
58698   image:
58699     description: |
58700       Openstack image.
58701       ###### Related Nodes
58702       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
58703       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
58704       - FROM vserver( vserver Uses image, MANY2ONE)
58705
58706       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
58707       -IMAGE cannot be deleted if related to VSERVER
58708
58709     required:
58710     - image-id
58711     - image-name
58712     - image-os-distro
58713     - image-os-version
58714     - image-selflink
58715     properties:
58716       image-id:
58717         type: string
58718         description: Image id, expected to be unique across cloud region
58719       image-name:
58720         type: string
58721         description: Image name
58722       image-architecture:
58723         type: string
58724         description: Operating system architecture.
58725       image-os-distro:
58726         type: string
58727         description: The common name of the operating system distribution in lowercase
58728       image-os-version:
58729         type: string
58730         description: The operating system version as specified by the distributor.
58731       application:
58732         type: string
58733         description: The application that the image instantiates.
58734       application-vendor:
58735         type: string
58736         description: The vendor of the application.
58737       application-version:
58738         type: string
58739         description: The version of the application.
58740       image-selflink:
58741         type: string
58742         description: URL to endpoint where AAI can get more details
58743       resource-version:
58744         type: string
58745         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58746       relationship-list:
58747         type: array
58748         items:
58749           $ref: "#/getDefinitions/relationship"
58750       metadata:
58751         type: array
58752         items:
58753           $ref: "#/getDefinitions/metadatum"
58754   images:
58755     description: |
58756       Collectio of Openstack images.
58757     properties:
58758       image:
58759         type: array
58760         items:
58761           $ref: "#/getDefinitions/image"
58762   include-node-filter:
58763     properties:
58764       include-node-type:
58765         type: string
58766   instance-filter:
58767     description: |
58768       InstanceFilter for performing a named-query or model query
58769   instance-filters:
58770     description: |
58771       InstanceFilters for performing a named-query or model query
58772     properties:
58773       instance-filter:
58774         type: array
58775         items:
58776           $ref: "#/getDefinitions/instance-filter"
58777   instance-group:
58778     description: |
58779       General mechanism for grouping instances
58780       ###### Related Nodes
58781       - TO model( instance-group Targets model, MANY2MANY)
58782       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
58783       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
58784       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
58785       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
58786       - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
58787       - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
58788       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
58789       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
58790       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
58791       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
58792       - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
58793
58794     required:
58795     - id
58796     - description
58797     - type
58798     properties:
58799       instance-group-role:
58800         type: string
58801         description: role of the instance group.
58802       model-invariant-id:
58803         type: string
58804         description: ASDC model id for this resource or service model.
58805       model-version-id:
58806         type: string
58807         description: ASDC model version uid for this resource model.
58808       id:
58809         type: string
58810         description: Instance Group ID, UUID assigned to this instance.
58811       description:
58812         type: string
58813         description: Descriptive text to help identify the usage of this instance-group
58814       type:
58815         type: string
58816         description: Only valid value today is lower case ha for high availability
58817       sub-type:
58818         type: string
58819         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
58820       resource-version:
58821         type: string
58822         description: Concurrency value
58823       relationship-list:
58824         type: array
58825         items:
58826           $ref: "#/getDefinitions/relationship"
58827   instance-groups:
58828     description: |
58829       Collection of openstack route table references
58830     properties:
58831       instance-group:
58832         type: array
58833         items:
58834           $ref: "#/getDefinitions/instance-group"
58835   inventory:
58836     properties:
58837       search:
58838         type: object
58839         $ref: "#/getDefinitions/search"
58840       actions:
58841         type: object
58842         $ref: "#/getDefinitions/actions"
58843       cloud-infrastructure:
58844         type: object
58845         $ref: "#/getDefinitions/cloud-infrastructure"
58846       external-system:
58847         type: object
58848         $ref: "#/getDefinitions/external-system"
58849       business:
58850         type: object
58851         $ref: "#/getDefinitions/business"
58852       service-design-and-creation:
58853         type: object
58854         $ref: "#/getDefinitions/service-design-and-creation"
58855       network:
58856         type: object
58857         $ref: "#/getDefinitions/network"
58858       nodes:
58859         type: object
58860         $ref: "#/getDefinitions/nodes"
58861   inventory-item:
58862     properties:
58863       inventory-item-type:
58864         type: string
58865       inventory-item-link:
58866         type: string
58867       inventory-item-data:
58868         type: array
58869         items:
58870           $ref: "#/getDefinitions/inventory-item-data"
58871       tagged-inventory-item-list:
58872         type: array
58873         items:
58874           $ref: "#/getDefinitions/tagged-inventory-item-list"
58875   inventory-item-data:
58876     properties:
58877       property-name:
58878         type: string
58879       property-value:
58880         type: string
58881   inventory-response-item:
58882     description: |
58883       Inventory item for response list
58884     properties:
58885       model-name:
58886         type: string
58887       extra-properties:
58888         type: object
58889         $ref: "#/getDefinitions/extra-properties"
58890       inventory-response-items:
58891         type: object
58892         $ref: "#/getDefinitions/inventory-response-items"
58893   inventory-response-items:
58894     description: |
58895       Container for inventory items in response list
58896     properties:
58897       inventory-response-item:
58898         type: array
58899         items:
58900           $ref: "#/getDefinitions/inventory-response-item"
58901   ipsec-configuration:
58902     description: |
58903       IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
58904       ###### Related Nodes
58905       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
58906       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
58907
58908       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
58909     required:
58910     - ipsec-configuration-id
58911     properties:
58912       ipsec-configuration-id:
58913         type: string
58914         description: UUID of this configuration
58915       requested-vig-address-type:
58916         type: string
58917         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
58918       requested-encryption-strength:
58919         type: string
58920         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
58921       requested-dmz-type:
58922         type: string
58923         description: ATT can offer a shared DMZ or a DMZ specific to a customer
58924       shared-dmz-network-address:
58925         type: string
58926         description: Network address of shared DMZ
58927       requested-customer-name:
58928         type: string
58929         description: If the DMZ is a custom DMZ, this field will indicate the customer information
58930       ike-version:
58931         type: string
58932         description: can be 1 or 2
58933       ikev1-authentication:
58934         type: string
58935         description: Contains values like md5, sha1, sha256, sha384
58936       ikev1-encryption:
58937         type: string
58938         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
58939       ikev1-dh-group:
58940         type: string
58941         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
58942       ikev1-am-group-id:
58943         type: string
58944         description: Group name defined in VIG for clients using aggressive mode
58945       ikev1-am-password:
58946         type: string
58947         description: pre-shared key for the above group name
58948       ikev1-sa-lifetime:
58949         type: string
58950         description: Lifetime for IKEv1 SA
58951       ipsec-authentication:
58952         type: string
58953         description: md5, sha1, sha256, sha384
58954       ipsec-encryption:
58955         type: string
58956         description: 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
58957       ipsec-sa-lifetime:
58958         type: string
58959         description: Life time for IPSec SA
58960       ipsec-pfs:
58961         type: string
58962         description: enable PFS or not
58963       xauth-userid:
58964         type: string
58965         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
58966       xauth-user-password:
58967         type: string
58968         description: Encrypted using the Juniper $9$ algorithm
58969       dpd-interval:
58970         type: string
58971         description: The time between DPD probe
58972       dpd-frequency:
58973         type: string
58974         description: Maximum number of DPD before claiming the tunnel is down
58975       resource-version:
58976         type: string
58977         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58978       relationship-list:
58979         type: array
58980         items:
58981           $ref: "#/getDefinitions/relationship"
58982       vig-servers:
58983         type: array
58984         items:
58985           $ref: "#/getDefinitions/vig-server"
58986   ipsec-configurations:
58987     properties:
58988       ipsec-configuration:
58989         type: array
58990         items:
58991           $ref: "#/getDefinitions/ipsec-configuration"
58992   key-data:
58993     properties:
58994       key-name:
58995         type: string
58996       key-value:
58997         type: string
58998   l-interface:
58999     description: |
59000       Logical interfaces, e.g., a vnic.
59001       ###### Related Nodes
59002       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
59003       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
59004       - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
59005       - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
59006       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
59007       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
59008       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
59009       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
59010       - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
59011       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
59012       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
59013       - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)
59014       - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)
59015       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
59016       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
59017       - FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
59018       - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)
59019       - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
59020
59021       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
59022       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
59023       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
59024     required:
59025     - interface-name
59026     - is-port-mirrored
59027     - in-maint
59028     - is-ip-unnumbered
59029     properties:
59030       interface-name:
59031         type: string
59032         description: Name given to the interface
59033       interface-role:
59034         type: string
59035         description: E.g., CUSTOMER, UPLINK, etc.
59036       v6-wan-link-ip:
59037         type: string
59038         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
59039       selflink:
59040         type: string
59041         description: URL to endpoint where AAI can get more details
59042       interface-id:
59043         type: string
59044         description: ID of interface
59045       macaddr:
59046         type: string
59047         description: MAC address for the interface
59048       network-name:
59049         type: string
59050         description: Name of the network
59051       management-option:
59052         type: string
59053         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
59054       interface-description:
59055         type: string
59056         description: Human friendly text regarding this interface.
59057       is-port-mirrored:
59058         type: boolean
59059         description: boolean indicatating whether or not port is a mirrored.
59060       resource-version:
59061         type: string
59062         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59063       in-maint:
59064         type: boolean
59065         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
59066       prov-status:
59067         type: string
59068         description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
59069       is-ip-unnumbered:
59070         type: boolean
59071         description: Flag indicating the interface uses the IP Unnumbered configuration.
59072       allowed-address-pairs:
59073         type: string
59074         description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
59075       vlans:
59076         type: array
59077         items:
59078           $ref: "#/getDefinitions/vlan"
59079       sriov-vfs:
59080         type: array
59081         items:
59082           $ref: "#/getDefinitions/sriov-vf"
59083       l-interfaces:
59084         type: array
59085         items:
59086           $ref: "#/getDefinitions/l-interface"
59087       relationship-list:
59088         type: array
59089         items:
59090           $ref: "#/getDefinitions/relationship"
59091       l3-interface-ipv4-address-list:
59092         type: array
59093         items:
59094           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
59095       l3-interface-ipv6-address-list:
59096         type: array
59097         items:
59098           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
59099   l-interfaces:
59100     description: |
59101       Collection of logical interfaces.
59102     properties:
59103       l-interface:
59104         type: array
59105         items:
59106           $ref: "#/getDefinitions/l-interface"
59107   l3-interface-ipv4-address-list:
59108     description: |
59109       IPv4 Address Range
59110       ###### Related Nodes
59111       - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
59112       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
59113       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
59114       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
59115       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
59116       - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
59117
59118       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
59119     required:
59120     - l3-interface-ipv4-address
59121     properties:
59122       l3-interface-ipv4-address:
59123         type: string
59124         description: IP address
59125       l3-interface-ipv4-prefix-length:
59126         type: integer
59127         format: int64
59128         description: Prefix length, 32 for single address
59129       vlan-id-inner:
59130         type: integer
59131         format: int64
59132         description: Inner VLAN tag
59133       vlan-id-outer:
59134         type: integer
59135         format: int64
59136         description: Outer VLAN tag
59137       is-floating:
59138         type: boolean
59139         description: Indicator of fixed or floating address
59140       resource-version:
59141         type: string
59142         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59143       neutron-network-id:
59144         type: string
59145         description: Neutron network id of the interface that address belongs to
59146       neutron-subnet-id:
59147         type: string
59148         description: Neutron id of subnet that address belongs to
59149       relationship-list:
59150         type: array
59151         items:
59152           $ref: "#/getDefinitions/relationship"
59153   l3-interface-ipv6-address-list:
59154     description: |
59155       IPv6 Address Range
59156       ###### Related Nodes
59157       - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
59158       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
59159       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
59160       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
59161       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
59162       - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
59163
59164       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
59165     required:
59166     - l3-interface-ipv6-address
59167     properties:
59168       l3-interface-ipv6-address:
59169         type: string
59170         description: IP address
59171       l3-interface-ipv6-prefix-length:
59172         type: integer
59173         format: int64
59174         description: Prefix length, 128 for single address
59175       vlan-id-inner:
59176         type: integer
59177         format: int64
59178         description: Inner VLAN tag
59179       vlan-id-outer:
59180         type: integer
59181         format: int64
59182         description: Outer VLAN tag
59183       is-floating:
59184         type: boolean
59185         description: Indicator of fixed or floating address
59186       resource-version:
59187         type: string
59188         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59189       neutron-network-id:
59190         type: string
59191         description: Neutron network id of the interface that address belongs to
59192       neutron-subnet-id:
59193         type: string
59194         description: Neutron id of subnet that address belongs to
59195       relationship-list:
59196         type: array
59197         items:
59198           $ref: "#/getDefinitions/relationship"
59199   l3-network:
59200     description: |
59201       Generic network definition
59202       ###### Related Nodes
59203       - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
59204       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
59205       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
59206       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
59207       - TO model-ver( l3-network IsA model-ver, Many2One)
59208       - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
59209       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
59210       - FROM complex( complex Uses l3-network, MANY2MANY)
59211       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
59212       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
59213       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
59214       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
59215       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
59216       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
59217       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
59218       - FROM tenant( tenant Uses l3-network, MANY2MANY)
59219       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
59220
59221       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
59222     required:
59223     - network-id
59224     - network-name
59225     - is-bound-to-vpn
59226     - is-provider-network
59227     - is-shared-network
59228     - is-external-network
59229     properties:
59230       network-id:
59231         type: string
59232         description: Network ID, should be uuid. Unique across A&AI.
59233       network-name:
59234         type: string
59235         description: Name of the network, governed by some naming convention..
59236       network-type:
59237         type: string
59238         description: Type of the network - who defines these values?
59239       network-role:
59240         type: string
59241         description: Role the network plans - who defines these values?
59242       network-technology:
59243         type: string
59244         description: Network technology - who defines these values?
59245       neutron-network-id:
59246         type: string
59247         description: Neutron network id of this Interface
59248       is-bound-to-vpn:
59249         type: boolean
59250         description: Set to true if bound to VPN
59251       service-id:
59252         type: string
59253         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
59254       network-role-instance:
59255         type: integer
59256         format: int64
59257         description: network role instance
59258       resource-version:
59259         type: string
59260         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59261       orchestration-status:
59262         type: string
59263         description: Orchestration status of this VNF, mastered by MSO
59264       heat-stack-id:
59265         type: string
59266         description: Heat stack id corresponding to this instance, managed by MSO
59267       mso-catalog-key:
59268         type: string
59269         description: Corresponds to the SDN-C catalog id used to configure this VCE
59270       contrail-network-fqdn:
59271         type: string
59272         description: Contrail FQDN for the network
59273       model-invariant-id:
59274         type: string
59275         description: the ASDC model id for this resource or service model.
59276       model-version-id:
59277         type: string
59278         description: the ASDC model version for this resource or service model.
59279       persona-model-version:
59280         type: string
59281         description: the ASDC model version for this resource or service model.
59282       model-customization-id:
59283         type: string
59284         description: captures the id of all the configuration used to customize the resource for the service.
59285       widget-model-id:
59286         type: string
59287         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59288       widget-model-version:
59289         type: string
59290         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59291       physical-network-name:
59292         type: string
59293         description: Name associated with the physical network.
59294       is-provider-network:
59295         type: boolean
59296         description: boolean indicatating whether or not network is a provider network.
59297       is-shared-network:
59298         type: boolean
59299         description: boolean indicatating whether or not network is a shared network.
59300       is-external-network:
59301         type: boolean
59302         description: boolean indicatating whether or not network is an external network.
59303       selflink:
59304         type: string
59305         description: Path to the controller object.
59306       operational-status:
59307         type: string
59308         description: Indicator for whether the resource is considered operational.
59309       subnets:
59310         type: array
59311         items:
59312           $ref: "#/getDefinitions/subnet"
59313       ctag-assignments:
59314         type: array
59315         items:
59316           $ref: "#/getDefinitions/ctag-assignment"
59317       segmentation-assignments:
59318         type: array
59319         items:
59320           $ref: "#/getDefinitions/segmentation-assignment"
59321       relationship-list:
59322         type: array
59323         items:
59324           $ref: "#/getDefinitions/relationship"
59325         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
59326   l3-networks:
59327     properties:
59328       l3-network:
59329         type: array
59330         items:
59331           $ref: "#/getDefinitions/l3-network"
59332   lag-interface:
59333     description: |
59334       Link aggregate interface
59335       ###### Related Nodes
59336       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
59337       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
59338       - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
59339       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
59340       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
59341       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
59342       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
59343       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
59344       - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)
59345
59346       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
59347       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
59348       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
59349     required:
59350     - interface-name
59351     - in-maint
59352     properties:
59353       interface-name:
59354         type: string
59355         description: Name that identifies the link aggregate interface
59356       interface-description:
59357         type: string
59358         description: Human friendly text regarding this interface.
59359       resource-version:
59360         type: string
59361         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59362       speed-value:
59363         type: string
59364         description: Captures the numeric part of the speed
59365       speed-units:
59366         type: string
59367         description: Captures the units corresponding to the speed
59368       interface-id:
59369         type: string
59370         description: ID of interface
59371       interface-role:
59372         type: string
59373         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
59374       prov-status:
59375         type: string
59376         description: Trigger for operational monitoring of this resource by Service Assurance systems.
59377       in-maint:
59378         type: boolean
59379         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
59380       relationship-list:
59381         type: array
59382         items:
59383           $ref: "#/getDefinitions/relationship"
59384       l-interfaces:
59385         type: array
59386         items:
59387           $ref: "#/getDefinitions/l-interface"
59388   lag-interfaces:
59389     description: |
59390       Collection of link aggregate interfaces.
59391     properties:
59392       lag-interface:
59393         type: array
59394         items:
59395           $ref: "#/getDefinitions/lag-interface"
59396   lag-link:
59397     description: |
59398       LAG links can connect lag-interfaces
59399       ###### Related Nodes
59400       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
59401       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
59402
59403       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
59404     required:
59405     - link-name
59406     properties:
59407       link-name:
59408         type: string
59409         description: Alphabetical concatenation of lag-interface names
59410       resource-version:
59411         type: string
59412         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59413       relationship-list:
59414         type: array
59415         items:
59416           $ref: "#/getDefinitions/relationship"
59417   lag-links:
59418     description: |
59419       Collection of link aggregation connections
59420     properties:
59421       lag-link:
59422         type: array
59423         items:
59424           $ref: "#/getDefinitions/lag-link"
59425   license:
59426     description: |
59427       Metadata for license group.
59428       ###### Related Nodes
59429       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
59430       - TO vce( license BelongsTo vce, MANY2ONE)(4)
59431
59432       -(4) IF this TO node is deleted, this LICENSE is DELETED also
59433     required:
59434     - group-uuid
59435     - resource-uuid
59436     properties:
59437       group-uuid:
59438         type: string
59439         description: Unique ID for the license group the resource belongs to, should be uuid.
59440       resource-uuid:
59441         type: string
59442         description: Unique ID of a license resource.
59443       resource-version:
59444         type: string
59445         description: Concurrency value
59446       relationship-list:
59447         type: array
59448         items:
59449           $ref: "#/getDefinitions/relationship"
59450   licenses:
59451     description: |
59452       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
59453     properties:
59454       license:
59455         type: array
59456         items:
59457           $ref: "#/getDefinitions/license"
59458   line-of-business:
59459     description: |
59460       describes a line-of-business
59461       ###### Related Nodes
59462       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
59463
59464     required:
59465     - line-of-business-name
59466     properties:
59467       line-of-business-name:
59468         type: string
59469         description: Name of the line-of-business (product)
59470       resource-version:
59471         type: string
59472         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59473       relationship-list:
59474         type: array
59475         items:
59476           $ref: "#/getDefinitions/relationship"
59477   lines-of-business:
59478     description: |
59479       Collection of lines-of-business
59480     properties:
59481       line-of-business:
59482         type: array
59483         items:
59484           $ref: "#/getDefinitions/line-of-business"
59485   logical-link:
59486     description: |
59487       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
59488       ###### Related Nodes
59489       - TO l-interface( logical-link Source l-interface, ONE2MANY)(4)
59490       - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)
59491       - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
59492       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
59493       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
59494       - TO logical-link( logical-link Uses logical-link, MANY2MANY)
59495       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
59496       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
59497       - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
59498       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
59499       - TO model-ver( logical-link IsA model-ver, Many2One)
59500       - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
59501       - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
59502       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
59503       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
59504       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
59505       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
59506       - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
59507
59508       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
59509       -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also
59510     required:
59511     - link-name
59512     - in-maint
59513     - link-type
59514     properties:
59515       link-name:
59516         type: string
59517         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
59518       in-maint:
59519         type: boolean
59520         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
59521       link-type:
59522         type: string
59523         description: Type of logical link, e.g., evc
59524       speed-value:
59525         type: string
59526         description: Captures the numeric part of the speed
59527       speed-units:
59528         type: string
59529         description: Captures the units corresponding to the speed
59530       ip-version:
59531         type: string
59532         description: v4, v6, or ds for dual stack
59533       routing-protocol:
59534         type: string
59535         description: For example, static or BGP
59536       resource-version:
59537         type: string
59538         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59539       model-invariant-id:
59540         type: string
59541         description: the ASDC model id for this resource or service model.
59542       model-version-id:
59543         type: string
59544         description: the ASDC model version for this resource or service model.
59545       persona-model-version:
59546         type: string
59547         description: the ASDC model version for this resource or service model.
59548       widget-model-id:
59549         type: string
59550         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59551       widget-model-version:
59552         type: string
59553         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59554       operational-status:
59555         type: string
59556         description: Indication of operational status of the logical link.
59557       prov-status:
59558         type: string
59559         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
59560       link-role:
59561         type: string
59562         description: Indication of the network use of the logical link.
59563       link-name2:
59564         type: string
59565         description: Alias or alternate name (CLCI or D1 name).
59566       link-id:
59567         type: string
59568         description: UUID of the logical-link, SDNC generates this.
59569       circuit-id:
59570         type: string
59571         description: Circuit id
59572       purpose:
59573         type: string
59574         description: Reason for this entity, role it is playing
59575       relationship-list:
59576         type: array
59577         items:
59578           $ref: "#/getDefinitions/relationship"
59579   logical-links:
59580     description: |
59581       Collection of logical connections
59582     properties:
59583       logical-link:
59584         type: array
59585         items:
59586           $ref: "#/getDefinitions/logical-link"
59587   metadata:
59588     description: |
59589       Collection of metadatum (key/value pairs)
59590     properties:
59591       metadatum:
59592         type: array
59593         items:
59594           $ref: "#/getDefinitions/metadatum"
59595   metadatum:
59596     description: |
59597       Key/value pairs
59598       ###### Related Nodes
59599       - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
59600       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
59601       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
59602       - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
59603       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
59604
59605       -(4) IF this TO node is deleted, this METADATUM is DELETED also
59606     required:
59607     - metaname
59608     - metaval
59609     properties:
59610       metaname:
59611         type: string
59612       metaval:
59613         type: string
59614       resource-version:
59615         type: string
59616         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59617   model:
59618     description: |
59619       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
59620       ###### Related Nodes
59621       - TO model( model-ver BelongsTo model, MANY2ONE)(1)
59622       - FROM instance-group( instance-group Targets model, MANY2MANY)
59623       - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
59624       - FROM named-query( named-query AppliesTo model, ONE2MANY)
59625       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
59626
59627       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
59628       -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
59629
59630     required:
59631     - model-invariant-id
59632     - model-type
59633     properties:
59634       model-invariant-id:
59635         type: string
59636         description: Unique identifier corresponding to the main definition of a model in ASDC
59637       model-type:
59638         type: string
59639         description: Type of the model, e.g., service, resource, widget, etc.
59640       resource-version:
59641         type: string
59642         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59643       model-vers:
59644         type: array
59645         items:
59646           $ref: "#/getDefinitions/model-ver"
59647       relationship-list:
59648         type: array
59649         items:
59650           $ref: "#/getDefinitions/relationship"
59651   model-and-named-query-search:
59652     description: |
59653       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
59654     properties:
59655       query-parameters:
59656         type: object
59657         $ref: "#/getDefinitions/query-parameters"
59658       instance-filters:
59659         type: object
59660         $ref: "#/getDefinitions/instance-filters"
59661       secondary-filts:
59662         type: object
59663         $ref: "#/getDefinitions/secondary-filts"
59664       top-node-type:
59665         type: string
59666       secondary-filter-cut-point:
59667         type: string
59668   model-constraint:
59669     description: |
59670       This is how we would capture constraints defining allowed sets of elements.
59671       ###### Related Nodes
59672       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
59673       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
59674
59675       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
59676       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
59677     required:
59678     - model-constraint-uuid
59679     - constrained-element-set-uuid-to-replace
59680     properties:
59681       model-constraint-uuid:
59682         type: string
59683       constrained-element-set-uuid-to-replace:
59684         type: string
59685       constrained-element-sets:
59686         type: array
59687         items:
59688           $ref: "#/getDefinitions/constrained-element-set"
59689       resource-version:
59690         type: string
59691         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59692   model-constraints:
59693     properties:
59694       model-constraint:
59695         type: array
59696         items:
59697           $ref: "#/getDefinitions/model-constraint"
59698   model-element:
59699     description: |
59700       Defines how other models combine to make up a higher-level model.
59701       ###### Related Nodes
59702       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
59703       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
59704       - TO model-ver( model-element IsA model-ver, MANY2ONE)
59705       - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
59706       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
59707       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
59708       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
59709
59710       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
59711       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
59712     required:
59713     - model-element-uuid
59714     - new-data-del-flag
59715     - cardinality
59716     properties:
59717       model-element-uuid:
59718         type: string
59719       new-data-del-flag:
59720         type: string
59721         description: Indicates whether this element was created as part of instantiation from this model
59722       cardinality:
59723         type: string
59724         description: How many of this type of element are required/allowed
59725       linkage-points:
59726         type: string
59727       resource-version:
59728         type: string
59729         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59730       model-elements:
59731         type: array
59732         items:
59733           $ref: "#/getDefinitions/model-element"
59734         description: Defines how other models combine to make up a higher-level model
59735       model-constraints:
59736         type: array
59737         items:
59738           $ref: "#/getDefinitions/model-constraint"
59739         description: Describes new constraints on this model element that are not part of that model's definition
59740       relationship-list:
59741         type: array
59742         items:
59743           $ref: "#/getDefinitions/relationship"
59744   model-elements:
59745     properties:
59746       model-element:
59747         type: array
59748         items:
59749           $ref: "#/getDefinitions/model-element"
59750   model-ver:
59751     description: |
59752       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
59753       ###### Related Nodes
59754       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
59755       - FROM model-element( model-element IsA model-ver, MANY2ONE)
59756       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
59757       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
59758       - FROM allotted-resource( allotted-resource IsA model-ver, Many2One)
59759       - FROM generic-vnf( generic-vnf IsA model-ver, Many2One)
59760       - FROM l3-network( l3-network IsA model-ver, Many2One)
59761       - FROM logical-link( logical-link IsA model-ver, Many2One)
59762       - FROM service-instance( service-instance IsA model-ver, Many2One)
59763       - FROM vf-module( vf-module IsA model-ver, Many2One)
59764
59765       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
59766       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
59767       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
59768
59769     required:
59770     - model-version-id
59771     - model-name
59772     - model-version
59773     properties:
59774       model-version-id:
59775         type: string
59776         description: Unique identifier corresponding to one version of a model in ASDC
59777       model-name:
59778         type: string
59779         description: Name of the model, which can change from version to version.
59780       model-version:
59781         type: string
59782         description: Version
59783       distribution-status:
59784         type: string
59785         description: Distribution Status
59786       model-description:
59787         type: string
59788         description: Description
59789       resource-version:
59790         type: string
59791         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59792       model-elements:
59793         type: array
59794         items:
59795           $ref: "#/getDefinitions/model-element"
59796       metadata:
59797         type: array
59798         items:
59799           $ref: "#/getDefinitions/metadatum"
59800       relationship-list:
59801         type: array
59802         items:
59803           $ref: "#/getDefinitions/relationship"
59804   model-vers:
59805     properties:
59806       model-ver:
59807         type: array
59808         items:
59809           $ref: "#/getDefinitions/model-ver"
59810   models:
59811     description: |
59812       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
59813     properties:
59814       model:
59815         type: array
59816         items:
59817           $ref: "#/getDefinitions/model"
59818   multicast-configuration:
59819     description: |
59820       ###### Related Nodes
59821       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
59822
59823     required:
59824     - multicast-configuration-id
59825     - multicast-protocol
59826     - rp-type
59827     properties:
59828       multicast-configuration-id:
59829         type: string
59830         description: Unique id of multicast configuration.
59831       multicast-protocol:
59832         type: string
59833         description: protocol of multicast configuration
59834       rp-type:
59835         type: string
59836         description: rp type of multicast configuration
59837       resource-version:
59838         type: string
59839         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59840       relationship-list:
59841         type: array
59842         items:
59843           $ref: "#/getDefinitions/relationship"
59844   multicast-configurations:
59845     description: |
59846       multicast configuration of generic-vnf ip-address
59847     properties:
59848       multicast-configuration:
59849         type: array
59850         items:
59851           $ref: "#/getDefinitions/multicast-configuration"
59852   named-queries:
59853     properties:
59854       named-query:
59855         type: array
59856         items:
59857           $ref: "#/getDefinitions/named-query"
59858   named-query:
59859     description: |
59860       TBD
59861       ###### Related Nodes
59862       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
59863       - TO model( named-query AppliesTo model, ONE2MANY)
59864       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
59865
59866       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
59867     required:
59868     - named-query-uuid
59869     - named-query-name
59870     - named-query-version
59871     properties:
59872       named-query-uuid:
59873         type: string
59874       named-query-name:
59875         type: string
59876       named-query-version:
59877         type: string
59878       required-input-param:
59879         type: string
59880       description:
59881         type: string
59882       resource-version:
59883         type: string
59884       named-query-elements:
59885         type: array
59886         items:
59887           $ref: "#/getDefinitions/named-query-element"
59888       relationship-list:
59889         type: array
59890         items:
59891           $ref: "#/getDefinitions/relationship"
59892   named-query-element:
59893     description: |
59894       TBD
59895       ###### Related Nodes
59896       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
59897       - TO model( named-query-element IsA model, MANY2ONE)
59898       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
59899       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
59900       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
59901       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
59902
59903       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
59904       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
59905     required:
59906     - named-query-element-uuid
59907     properties:
59908       named-query-element-uuid:
59909         type: string
59910       property-collect-list:
59911         type: string
59912       resource-version:
59913         type: string
59914       property-limit-desc:
59915         type: string
59916       do-not-output:
59917         type: string
59918       named-query-elements:
59919         type: array
59920         items:
59921           $ref: "#/getDefinitions/named-query-element"
59922       related-lookups:
59923         type: array
59924         items:
59925           $ref: "#/getDefinitions/related-lookup"
59926       property-constraints:
59927         type: array
59928         items:
59929           $ref: "#/getDefinitions/property-constraint"
59930       relationship-list:
59931         type: array
59932         items:
59933           $ref: "#/getDefinitions/relationship"
59934   named-query-elements:
59935     properties:
59936       named-query-element:
59937         type: array
59938         items:
59939           $ref: "#/getDefinitions/named-query-element"
59940   network:
59941     description: |
59942       Namespace for network inventory resources.
59943     properties:
59944       logical-links:
59945         type: array
59946         items:
59947           $ref: "#/getDefinitions/logical-link"
59948       site-pair-sets:
59949         type: array
59950         items:
59951           $ref: "#/getDefinitions/site-pair-set"
59952       vpn-bindings:
59953         type: array
59954         items:
59955           $ref: "#/getDefinitions/vpn-binding"
59956       vpls-pes:
59957         type: array
59958         items:
59959           $ref: "#/getDefinitions/vpls-pe"
59960       multicast-configurations:
59961         type: array
59962         items:
59963           $ref: "#/getDefinitions/multicast-configuration"
59964       vces:
59965         type: array
59966         items:
59967           $ref: "#/getDefinitions/vce"
59968       vnfcs:
59969         type: array
59970         items:
59971           $ref: "#/getDefinitions/vnfc"
59972       l3-networks:
59973         type: array
59974         items:
59975           $ref: "#/getDefinitions/l3-network"
59976       network-policies:
59977         type: array
59978         items:
59979           $ref: "#/getDefinitions/network-policy"
59980       generic-vnfs:
59981         type: array
59982         items:
59983           $ref: "#/getDefinitions/generic-vnf"
59984       lag-links:
59985         type: array
59986         items:
59987           $ref: "#/getDefinitions/lag-link"
59988       newvces:
59989         type: array
59990         items:
59991           $ref: "#/getDefinitions/newvce"
59992       pnfs:
59993         type: array
59994         items:
59995           $ref: "#/getDefinitions/pnf"
59996       physical-links:
59997         type: array
59998         items:
59999           $ref: "#/getDefinitions/physical-link"
60000       ipsec-configurations:
60001         type: array
60002         items:
60003           $ref: "#/getDefinitions/ipsec-configuration"
60004       route-table-references:
60005         type: array
60006         items:
60007           $ref: "#/getDefinitions/route-table-reference"
60008       instance-groups:
60009         type: array
60010         items:
60011           $ref: "#/getDefinitions/instance-group"
60012       zones:
60013         type: array
60014         items:
60015           $ref: "#/getDefinitions/zone"
60016       configurations:
60017         type: array
60018         items:
60019           $ref: "#/getDefinitions/configuration"
60020       forwarding-paths:
60021         type: array
60022         items:
60023           $ref: "#/getDefinitions/forwarding-path"
60024   network-policies:
60025     properties:
60026       network-policy:
60027         type: array
60028         items:
60029           $ref: "#/getDefinitions/network-policy"
60030   network-policy:
60031     description: |
60032       ###### Related Nodes
60033       - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
60034       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
60035
60036     required:
60037     - network-policy-id
60038     properties:
60039       network-policy-id:
60040         type: string
60041         description: UUID representing unique key to this instance
60042       network-policy-fqdn:
60043         type: string
60044         description: Contrail FQDN for the policy
60045       heat-stack-id:
60046         type: string
60047         description: ID for the openStack Heat instance
60048       resource-version:
60049         type: string
60050         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60051       relationship-list:
60052         type: array
60053         items:
60054           $ref: "#/getDefinitions/relationship"
60055   network-profile:
60056     description: |
60057       Network profile populated by SDN-GP for SNMP
60058       ###### Related Nodes
60059       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
60060
60061     required:
60062     - nm-profile-name
60063     properties:
60064       nm-profile-name:
60065         type: string
60066         description: Unique name of network profile.
60067       community-string:
60068         type: string
60069         description: Encrypted SNMP community string
60070       resource-version:
60071         type: string
60072         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60073       relationship-list:
60074         type: array
60075         items:
60076           $ref: "#/getDefinitions/relationship"
60077   network-profiles:
60078     description: |
60079       Collection of network profiles
60080     properties:
60081       network-profile:
60082         type: array
60083         items:
60084           $ref: "#/getDefinitions/network-profile"
60085   newvce:
60086     description: |
60087       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
60088       ###### Related Nodes
60089       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
60090
60091       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
60092     required:
60093     - vnf-id2
60094     - vnf-name
60095     - vnf-type
60096     properties:
60097       vnf-id2:
60098         type: string
60099         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
60100       vnf-name:
60101         type: string
60102         description: Name of VNF.
60103       vnf-name2:
60104         type: string
60105         description: Alternate name of VNF.
60106       vnf-type:
60107         type: string
60108         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
60109       prov-status:
60110         type: string
60111         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
60112       operational-status:
60113         type: string
60114         description: Indicator for whether the resource is considered operational
60115       license-key:
60116         type: string
60117         description: OBSOLETE -  do not use
60118       ipv4-oam-address:
60119         type: string
60120         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
60121       equipment-role:
60122         type: string
60123         description: Client should send valid enumerated value.
60124       resource-version:
60125         type: string
60126         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60127       ipv4-loopback0-address:
60128         type: string
60129         description: v4 Loopback0 address
60130       orchestration-status:
60131         type: string
60132         description: Orchestration status of this VNF, mastered by MSO.
60133       heat-stack-id:
60134         type: string
60135         description: Heat stack id corresponding to this instance, managed by MSO
60136       mso-catalog-key:
60137         type: string
60138         description: Corresponds to the SDN-C catalog id used to configure this VCE
60139       relationship-list:
60140         type: array
60141         items:
60142           $ref: "#/getDefinitions/relationship"
60143       l-interfaces:
60144         type: array
60145         items:
60146           $ref: "#/getDefinitions/l-interface"
60147   newvces:
60148     description: |
60149       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
60150     properties:
60151       newvce:
60152         type: array
60153         items:
60154           $ref: "#/getDefinitions/newvce"
60155   nodes:
60156     properties:
60157       inventory-item-data:
60158         type: array
60159         items:
60160           $ref: "#/getDefinitions/inventory-item-data"
60161   notification-event:
60162     properties:
60163       cambria.partition:
60164         type: string
60165       notification-event-header:
60166         type: object
60167         $ref: "#/getDefinitions/notification-event-header"
60168   notification-event-header:
60169     properties:
60170       id:
60171         type: string
60172       timestamp:
60173         type: string
60174       source-name:
60175         type: string
60176       domain:
60177         type: string
60178       sequence-number:
60179         type: string
60180       severity:
60181         type: string
60182       event-type:
60183         type: string
60184       version:
60185         type: string
60186       action:
60187         type: string
60188       entity-type:
60189         type: string
60190       top-entity-type:
60191         type: string
60192       entity-link:
60193         type: string
60194       status:
60195         type: string
60196   notify:
60197     required:
60198     - event-id
60199     properties:
60200       event-id:
60201         type: string
60202       node-type:
60203         type: string
60204       event-trigger:
60205         type: string
60206       key-data:
60207         type: array
60208         items:
60209           $ref: "#/getDefinitions/key-data"
60210       selflink:
60211         type: string
60212   oam-network:
60213     description: |
60214       OAM network, to be deprecated shortly.  Do not use for new purposes.
60215       ###### Related Nodes
60216       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
60217       - TO complex( oam-network AppliesTo complex, MANY2MANY)
60218       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
60219
60220     required:
60221     - network-uuid
60222     - network-name
60223     - cvlan-tag
60224     properties:
60225       network-uuid:
60226         type: string
60227         description: UUID of the network. Unique across a cloud-region
60228       network-name:
60229         type: string
60230         description: Name of the network.
60231       cvlan-tag:
60232         type: integer
60233         format: int64
60234         description: cvlan-id
60235       ipv4-oam-gateway-address:
60236         type: string
60237         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60238       ipv4-oam-gateway-address-prefix-length:
60239         type: integer
60240         format: int32
60241         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60242       resource-version:
60243         type: string
60244         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60245       relationship-list:
60246         type: array
60247         items:
60248           $ref: "#/getDefinitions/relationship"
60249   oam-networks:
60250     description: |
60251       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
60252     properties:
60253       oam-network:
60254         type: array
60255         items:
60256           $ref: "#/getDefinitions/oam-network"
60257   operational-environment:
60258     description: |
60259       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
60260       ###### Related Nodes
60261       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
60262       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
60263
60264     required:
60265     - operational-environment-id
60266     - operational-environment-name
60267     - operational-environment-type
60268     - operational-environment-status
60269     - tenant-context
60270     - workload-context
60271     properties:
60272       operational-environment-id:
60273         type: string
60274         description: UUID of an operational environment
60275       operational-environment-name:
60276         type: string
60277         description: Operational Environment name
60278       operational-environment-type:
60279         type: string
60280         description: Operational Environment Type.
60281       operational-environment-status:
60282         type: string
60283         description: Status
60284       tenant-context:
60285         type: string
60286         description: Tenant Context.
60287       workload-context:
60288         type: string
60289         description: Workload Context.
60290       resource-version:
60291         type: string
60292         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60293       relationship-list:
60294         type: array
60295         items:
60296           $ref: "#/getDefinitions/relationship"
60297   operational-environments:
60298     description: |
60299       a logical partition of the cloud which allows to have multiple environments in the production AIC.
60300     properties:
60301       operational-environment:
60302         type: array
60303         items:
60304           $ref: "#/getDefinitions/operational-environment"
60305   overloaded-model:
60306     description: |
60307       Allows for legacy POST of old-style and new-style models
60308     required:
60309     - model-invariant-id
60310     - model-name-version-id
60311     - model-type
60312     - model-name
60313     - model-id
60314     - model-version
60315     properties:
60316       model-invariant-id:
60317         type: string
60318         description: Unique identifier corresponding to the main definition of a model in ASDC
60319       model-name-version-id:
60320         type: string
60321         description: Unique identifier corresponding to one version of a model in ASDC
60322       model-type:
60323         type: string
60324         description: Type of the model, e.g., service, resource, widget, etc.
60325       model-name:
60326         type: string
60327         description: Name of the model, which can change from version to version.
60328       model-id:
60329         type: string
60330         description: Invariant unique ID which does not change from version to version
60331       model-version:
60332         type: string
60333         description: Version
60334       model-description:
60335         type: string
60336         description: Description
60337       resource-version:
60338         type: string
60339         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60340       model-vers:
60341         type: object
60342         $ref: "#/getDefinitions/model-vers"
60343       relationship-list:
60344         type: object
60345         $ref: "#/getDefinitions/relationship-list"
60346   owning-entities:
60347     description: |
60348       Collection of owning-entities
60349     properties:
60350       owning-entity:
60351         type: array
60352         items:
60353           $ref: "#/getDefinitions/owning-entity"
60354   owning-entity:
60355     description: |
60356       describes an owning-entity
60357       ###### Related Nodes
60358       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
60359
60360     required:
60361     - owning-entity-id
60362     - owning-entity-name
60363     properties:
60364       owning-entity-id:
60365         type: string
60366         description: UUID of an owning entity
60367       owning-entity-name:
60368         type: string
60369         description: Owning entity name
60370       resource-version:
60371         type: string
60372         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60373       relationship-list:
60374         type: array
60375         items:
60376           $ref: "#/getDefinitions/relationship"
60377   p-interface:
60378     description: |
60379       Physical interface (e.g., nic)
60380       ###### Related Nodes
60381       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
60382       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
60383       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
60384       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
60385       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
60386       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
60387       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
60388       - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
60389       - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)
60390
60391       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
60392       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
60393       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
60394     required:
60395     - interface-name
60396     - in-maint
60397     properties:
60398       interface-name:
60399         type: string
60400         description: Name that identifies the physical interface
60401       selflink:
60402         type: string
60403         description: URL to endpoint where AAI can get more details.
60404       speed-value:
60405         type: string
60406         description: Captures the numeric part of the speed
60407       speed-units:
60408         type: string
60409         description: Captures the units corresponding to the speed
60410       port-description:
60411         type: string
60412         description: Nature of the services and connectivity on this port.
60413       equipment-identifier:
60414         type: string
60415         description: CLEI or other specification for p-interface hardware.
60416       interface-role:
60417         type: string
60418         description: Role specification for p-interface hardware.
60419       interface-type:
60420         type: string
60421         description: Indicates the physical properties of the interface.
60422       prov-status:
60423         type: string
60424         description: Trigger for operational monitoring of this resource by Service Assurance systems.
60425       mac-addresss:
60426         type: string
60427         description: MAC Address of the p-interface.
60428       resource-version:
60429         type: string
60430         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60431       in-maint:
60432         type: boolean
60433         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
60434       inv-status:
60435         type: string
60436         description: inventory status
60437       relationship-list:
60438         type: array
60439         items:
60440           $ref: "#/getDefinitions/relationship"
60441       sriov-pfs:
60442         type: array
60443         items:
60444           $ref: "#/getDefinitions/sriov-pf"
60445       l-interfaces:
60446         type: array
60447         items:
60448           $ref: "#/getDefinitions/l-interface"
60449   p-interfaces:
60450     description: |
60451       Collection of physical interfaces.
60452     properties:
60453       p-interface:
60454         type: array
60455         items:
60456           $ref: "#/getDefinitions/p-interface"
60457   physical-link:
60458     description: |
60459       Collection of physical connections, typically between p-interfaces
60460       ###### Related Nodes
60461       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
60462
60463       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
60464     required:
60465     - link-name
60466     properties:
60467       link-name:
60468         type: string
60469         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
60470       speed-value:
60471         type: string
60472         description: Captures the numeric part of the speed
60473       speed-units:
60474         type: string
60475         description: Captures the units corresponding to the speed
60476       circuit-id:
60477         type: string
60478         description: Circuit it
60479       dual-mode:
60480         type: string
60481         description: Dual access mode (e.g., primary, secondary
60482       management-option:
60483         type: string
60484         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
60485       service-provider-name:
60486         type: string
60487         description: Name of the service Provider on this link.
60488       service-provider-bandwidth-up-value:
60489         type: integer
60490         format: int32
60491         description: Upstream Bandwidth value agreed with the service provider
60492       service-provider-bandwidth-up-units:
60493         type: string
60494         description: Units for the upstream BW value
60495       service-provider-bandwidth-down-value:
60496         type: integer
60497         format: int32
60498         description: Downstream Bandwidth value agreed with the service provider
60499       service-provider-bandwidth-down-units:
60500         type: string
60501         description: Units for downstream BW value
60502       resource-version:
60503         type: string
60504         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60505       relationship-list:
60506         type: array
60507         items:
60508           $ref: "#/getDefinitions/relationship"
60509   physical-links:
60510     description: |
60511       Collection of physical connections, typically between p-interfaces
60512     properties:
60513       physical-link:
60514         type: array
60515         items:
60516           $ref: "#/getDefinitions/physical-link"
60517   platform:
60518     description: |
60519       describes a platform
60520       ###### Related Nodes
60521       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
60522
60523     required:
60524     - platform-name
60525     properties:
60526       platform-name:
60527         type: string
60528         description: Name of the platform
60529       resource-version:
60530         type: string
60531         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60532       relationship-list:
60533         type: array
60534         items:
60535           $ref: "#/getDefinitions/relationship"
60536   platforms:
60537     description: |
60538       Collection of platforms
60539     properties:
60540       platform:
60541         type: array
60542         items:
60543           $ref: "#/getDefinitions/platform"
60544   pnf:
60545     description: |
60546       PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
60547       ###### Related Nodes
60548       - TO complex( pnf LocatedIn complex, MANY2ONE)
60549       - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
60550       - TO zone( pnf LocatedIn zone, MANY2ONE)
60551       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
60552       - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
60553       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
60554       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
60555       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
60556       - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
60557       - FROM configuration( configuration AppliesTo pnf, ONE2MANY)
60558
60559       -(1) IF this PNF node is deleted, this FROM node is DELETED also
60560     required:
60561     - pnf-name
60562     - in-maint
60563     properties:
60564       pnf-name:
60565         type: string
60566         description: unique name of Physical Network Function.
60567       pnf-name2:
60568         type: string
60569         description: name of Physical Network Function.
60570       selflink:
60571         type: string
60572         description: URL to endpoint where AAI can get more details.
60573       pnf-name2-source:
60574         type: string
60575         description: source of name2
60576       pnf-id:
60577         type: string
60578         description: id of pnf
60579       equip-type:
60580         type: string
60581         description: Equipment type.  Source of truth should define valid values.
60582       equip-vendor:
60583         type: string
60584         description: Equipment vendor.  Source of truth should define valid values.
60585       equip-model:
60586         type: string
60587         description: Equipment model.  Source of truth should define valid values.
60588       management-option:
60589         type: string
60590         description: identifier of managed by ATT or customer
60591       ipaddress-v4-oam:
60592         type: string
60593         description: ipv4-oam-address with new naming convention for IP addresses
60594       sw-version:
60595         type: string
60596         description: sw-version is the version of SW for the hosted application on the PNF.
60597       in-maint:
60598         type: boolean
60599         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
60600       frame-id:
60601         type: string
60602         description: ID of the physical frame (relay rack) where pnf is installed.
60603       serial-number:
60604         type: string
60605         description: Serial number of the device
60606       ipaddress-v4-loopback-0:
60607         type: string
60608         description: IPV4 Loopback 0 address
60609       ipaddress-v6-loopback-0:
60610         type: string
60611         description: IPV6 Loopback 0 address
60612       ipaddress-v4-aim:
60613         type: string
60614         description: IPV4 AIM address
60615       ipaddress-v6-aim:
60616         type: string
60617         description: IPV6 AIM address
60618       ipaddress-v6-oam:
60619         type: string
60620         description: IPV6 OAM address
60621       inv-status:
60622         type: string
60623         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
60624       resource-version:
60625         type: string
60626         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60627       prov-status:
60628         type: string
60629         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
60630       nf-role:
60631         type: string
60632         description: Nf Role is the role performed by this instance in the network.
60633       relationship-list:
60634         type: array
60635         items:
60636           $ref: "#/getDefinitions/relationship"
60637       p-interfaces:
60638         type: array
60639         items:
60640           $ref: "#/getDefinitions/p-interface"
60641       lag-interfaces:
60642         type: array
60643         items:
60644           $ref: "#/getDefinitions/lag-interface"
60645   pnfs:
60646     description: |
60647       Collection of Physical Network Functions.
60648     properties:
60649       pnf:
60650         type: array
60651         items:
60652           $ref: "#/getDefinitions/pnf"
60653   port-group:
60654     description: |
60655       Used to capture the network interfaces of this VCE
60656       ###### Related Nodes
60657       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
60658       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
60659
60660       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
60661       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
60662     required:
60663     - interface-id
60664     - orchestration-status
60665     properties:
60666       interface-id:
60667         type: string
60668         description: Unique ID of the interface
60669       neutron-network-id:
60670         type: string
60671         description: Neutron network id of this Interface
60672       neutron-network-name:
60673         type: string
60674         description: Neutron network name of this Interface
60675       interface-role:
60676         type: string
60677         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
60678       resource-version:
60679         type: string
60680         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60681       port-group-id:
60682         type: string
60683         description: Unique ID for port group in vmware
60684       port-group-name:
60685         type: string
60686         description: Likely to duplicate value of neutron network name
60687       switch-name:
60688         type: string
60689         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
60690       orchestration-status:
60691         type: string
60692         description: Orchestration status of this VNF, mastered by MSO
60693       heat-stack-id:
60694         type: string
60695         description: Heat stack id corresponding to this instance, managed by MSO
60696       mso-catalog-key:
60697         type: string
60698         description: Corresponds to the SDN-C catalog id used to configure this VCE
60699       cvlan-tags:
60700         type: array
60701         items:
60702           $ref: "#/getDefinitions/cvlan-tag-entry"
60703       relationship-list:
60704         type: array
60705         items:
60706           $ref: "#/getDefinitions/relationship"
60707   port-groups:
60708     properties:
60709       port-group:
60710         type: array
60711         items:
60712           $ref: "#/getDefinitions/port-group"
60713   project:
60714     description: |
60715       describes the project
60716       ###### Related Nodes
60717       - TO service-instance( project Uses service-instance, ONE2MANY)
60718
60719     required:
60720     - project-name
60721     properties:
60722       project-name:
60723         type: string
60724         description: Name of the project deploying a service
60725       resource-version:
60726         type: string
60727         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60728       relationship-list:
60729         type: array
60730         items:
60731           $ref: "#/getDefinitions/relationship"
60732   projects:
60733     description: |
60734       Collection of projects
60735     properties:
60736       project:
60737         type: array
60738         items:
60739           $ref: "#/getDefinitions/project"
60740   properties:
60741     description: |
60742       Property holder for query properties or instance properties
60743     properties:
60744       property-name:
60745         type: string
60746       property-value:
60747         type: string
60748   property-constraint:
60749     description: |
60750       TBD
60751       ###### Related Nodes
60752       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
60753
60754       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
60755     required:
60756     - property-constraint-uuid
60757     - constraint-type
60758     - property-name
60759     - property-value
60760     properties:
60761       property-constraint-uuid:
60762         type: string
60763       constraint-type:
60764         type: string
60765       property-name:
60766         type: string
60767       property-value:
60768         type: string
60769       resource-version:
60770         type: string
60771   property-constraints:
60772     properties:
60773       property-constraint:
60774         type: array
60775         items:
60776           $ref: "#/getDefinitions/property-constraint"
60777   pserver:
60778     description: |
60779       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
60780       ###### Related Nodes
60781       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
60782       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
60783       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
60784       - TO complex( pserver LocatedIn complex, MANY2ONE)
60785       - TO zone( pserver LocatedIn zone, MANY2ONE)
60786       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
60787       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
60788       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
60789       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
60790       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
60791
60792       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
60793       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
60794
60795     required:
60796     - hostname
60797     - in-maint
60798     properties:
60799       hostname:
60800         type: string
60801         description: Value from executing hostname on the compute node.
60802       ptnii-equip-name:
60803         type: string
60804         description: PTNII name
60805       number-of-cpus:
60806         type: integer
60807         format: int32
60808         description: Number of cpus
60809       disk-in-gigabytes:
60810         type: integer
60811         format: int32
60812         description: Disk size, in GBs
60813       ram-in-megabytes:
60814         type: integer
60815         format: int32
60816         description: RAM size, in MBs
60817       equip-type:
60818         type: string
60819         description: Equipment type.  Source of truth should define valid values.
60820       equip-vendor:
60821         type: string
60822         description: Equipment vendor.  Source of truth should define valid values.
60823       equip-model:
60824         type: string
60825         description: Equipment model.  Source of truth should define valid values.
60826       fqdn:
60827         type: string
60828         description: Fully-qualified domain name
60829       pserver-selflink:
60830         type: string
60831         description: URL to endpoint where AAI can get more details
60832       ipv4-oam-address:
60833         type: string
60834         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
60835       serial-number:
60836         type: string
60837         description: Serial number, may be queried
60838       ipaddress-v4-loopback-0:
60839         type: string
60840         description: IPV4 Loopback 0 address
60841       ipaddress-v6-loopback-0:
60842         type: string
60843         description: IPV6 Loopback 0 address
60844       ipaddress-v4-aim:
60845         type: string
60846         description: IPV4 AIM address
60847       ipaddress-v6-aim:
60848         type: string
60849         description: IPV6 AIM address
60850       ipaddress-v6-oam:
60851         type: string
60852         description: IPV6 OAM address
60853       inv-status:
60854         type: string
60855         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
60856       pserver-id:
60857         type: string
60858         description: ID of Pserver
60859       internet-topology:
60860         type: string
60861         description: internet topology of Pserver
60862       in-maint:
60863         type: boolean
60864         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
60865       resource-version:
60866         type: string
60867         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60868       pserver-name2:
60869         type: string
60870         description: alternative pserver name
60871       purpose:
60872         type: string
60873         description: purpose of pserver
60874       prov-status:
60875         type: string
60876         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
60877       management-option:
60878         type: string
60879         description: Indicates who owns and or manages the device.
60880       host-profile:
60881         type: string
60882         description: The host profile that defines the configuration of the pserver.
60883       relationship-list:
60884         type: array
60885         items:
60886           $ref: "#/getDefinitions/relationship"
60887       p-interfaces:
60888         type: array
60889         items:
60890           $ref: "#/getDefinitions/p-interface"
60891       lag-interfaces:
60892         type: array
60893         items:
60894           $ref: "#/getDefinitions/lag-interface"
60895   pservers:
60896     description: |
60897       Collection of compute hosts.
60898     properties:
60899       pserver:
60900         type: array
60901         items:
60902           $ref: "#/getDefinitions/pserver"
60903   query-parameters:
60904     description: |
60905       QueryParameters for performing a named-query or model query
60906     properties:
60907       named-query:
60908         type: object
60909         $ref: "#/getDefinitions/named-query"
60910       overloaded-model:
60911         type: object
60912         $ref: "#/getDefinitions/overloaded-model"
60913   related-lookup:
60914     description: |
60915       TBD
60916       ###### Related Nodes
60917       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
60918
60919       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
60920     required:
60921     - related-lookup-uuid
60922     - source-node-type
60923     - source-node-property
60924     - target-node-type
60925     - target-node-property
60926     properties:
60927       related-lookup-uuid:
60928         type: string
60929       source-node-type:
60930         type: string
60931       source-node-property:
60932         type: string
60933       target-node-type:
60934         type: string
60935       target-node-property:
60936         type: string
60937       property-collect-list:
60938         type: string
60939       resource-version:
60940         type: string
60941       relationship-list:
60942         type: array
60943         items:
60944           $ref: "#/getDefinitions/relationship"
60945   related-lookups:
60946     properties:
60947       related-lookup:
60948         type: array
60949         items:
60950           $ref: "#/getDefinitions/related-lookup"
60951   related-to-property:
60952     properties:
60953       property-key:
60954         type: string
60955         description: Key part of a key/value pair
60956       property-value:
60957         type: string
60958         description: Value part of a key/value pair
60959   relationship:
60960     properties:
60961       related-to:
60962         type: string
60963         description: A keyword provided by A&AI to indicate type of node.
60964       relationship-label:
60965         type: string
60966         description: The edge label for this relationship.
60967       related-link:
60968         type: string
60969         description: URL to the object in A&AI.
60970       relationship-data:
60971         type: array
60972         items:
60973           $ref: "#/getDefinitions/relationship-data"
60974       related-to-property:
60975         type: array
60976         items:
60977           $ref: "#/getDefinitions/related-to-property"
60978   relationship-data:
60979     required:
60980     - relationship-key
60981     - relationship-value
60982     properties:
60983       relationship-key:
60984         type: string
60985         description: A keyword provided by A&AI to indicate an attribute.
60986       relationship-value:
60987         type: string
60988         description: Value of the attribute.
60989   relationship-list:
60990     properties:
60991       relationship:
60992         type: array
60993         items:
60994           $ref: "#/getDefinitions/relationship"
60995   reserved-prop-names:
60996     description: |
60997       Internal map to define some reserved properties of a vertex
60998     properties:
60999       last-mod-source-of-truth:
61000         type: string
61001       aai-node-type:
61002         type: string
61003       aai-created-ts:
61004         type: integer
61005         format: int64
61006       aai-unique-key:
61007         type: string
61008       aai-last-mod-ts:
61009         type: integer
61010         format: int64
61011       source-of-truth:
61012         type: string
61013       aai-uri:
61014         type: string
61015   response-list:
61016     description: |
61017       Response container for the results of a named-query or model query
61018     properties:
61019       inventory-response-items:
61020         type: object
61021         $ref: "#/getDefinitions/inventory-response-items"
61022   result-data:
61023     properties:
61024       resource-type:
61025         type: string
61026         description: The specific type of node in the A&AI graph
61027       resource-link:
61028         type: string
61029         description: The URL to the specific resource
61030   route-table-reference:
61031     description: |
61032       Openstack route table reference.
61033       ###### Related Nodes
61034       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
61035
61036     required:
61037     - route-table-reference-id
61038     - route-table-reference-fqdn
61039     properties:
61040       route-table-reference-id:
61041         type: string
61042         description: Route Table Reference id, UUID assigned to this instance.
61043       route-table-reference-fqdn:
61044         type: string
61045         description: FQDN entry in the route table.
61046       resource-version:
61047         type: string
61048         description: Concurrency value
61049       relationship-list:
61050         type: array
61051         items:
61052           $ref: "#/getDefinitions/relationship"
61053   route-table-references:
61054     description: |
61055       Collection of openstack route table references
61056     properties:
61057       route-table-reference:
61058         type: array
61059         items:
61060           $ref: "#/getDefinitions/route-table-reference"
61061   route-target:
61062     description: |
61063       Route target information
61064       ###### Related Nodes
61065       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
61066
61067       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
61068     required:
61069     - global-route-target
61070     - route-target-role
61071     properties:
61072       global-route-target:
61073         type: string
61074         description: Number used to identify an RT, globally unique in the network
61075       route-target-role:
61076         type: string
61077         description: Role assigned to this route target
61078       resource-version:
61079         type: string
61080         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61081       relationship-list:
61082         type: array
61083         items:
61084           $ref: "#/getDefinitions/relationship"
61085   route-targets:
61086     description: |
61087       Collection of route target information
61088     properties:
61089       route-target:
61090         type: array
61091         items:
61092           $ref: "#/getDefinitions/route-target"
61093   routing-instance:
61094     description: |
61095       ###### Related Nodes
61096       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
61097       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
61098
61099       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
61100       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
61101     required:
61102     - routing-instance-id
61103     properties:
61104       routing-instance-id:
61105         type: string
61106         description: Unique id of routing instance
61107       rpm-owner:
61108         type: string
61109         description: rpm owner
61110       resource-version:
61111         type: string
61112         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61113       site-pairs:
61114         type: array
61115         items:
61116           $ref: "#/getDefinitions/site-pair"
61117       relationship-list:
61118         type: array
61119         items:
61120           $ref: "#/getDefinitions/relationship"
61121   routing-instances:
61122     description: |
61123       set of probes related to generic-vnf routing instance
61124     properties:
61125       routing-instance:
61126         type: array
61127         items:
61128           $ref: "#/getDefinitions/routing-instance"
61129   sdn-zone-response:
61130     properties:
61131       oam-networks:
61132         type: object
61133         $ref: "#/getDefinitions/oam-networks"
61134       az-and-dvs-switches:
61135         type: array
61136         items:
61137           $ref: "#/getDefinitions/az-and-dvs-switches"
61138   search:
61139     properties:
61140       edge-tag-query-result:
61141         type: object
61142         $ref: "#/getDefinitions/edge-tag-query-result"
61143       edge-tag-query-request:
61144         type: object
61145         $ref: "#/getDefinitions/edge-tag-query-request"
61146       search-results:
61147         type: object
61148         $ref: "#/getDefinitions/search-results"
61149       sdn-zone-response:
61150         type: object
61151         $ref: "#/getDefinitions/sdn-zone-response"
61152   search-results:
61153     properties:
61154       result-data:
61155         type: array
61156         items:
61157           $ref: "#/getDefinitions/result-data"
61158   secondary-filt:
61159     description: |
61160       SecondaryFilt for performing a named-query or model query
61161   secondary-filter:
61162     properties:
61163       property-name:
61164         type: string
61165       filter-type:
61166         type: string
61167       property-value:
61168         type: string
61169   secondary-filts:
61170     description: |
61171       SecondaryFilts for performing a named-query or model query
61172     properties:
61173       secondary-filt:
61174         type: array
61175         items:
61176           $ref: "#/getDefinitions/secondary-filt"
61177   segmentation-assignment:
61178     description: |
61179       Openstack segmentation assignment.
61180       ###### Related Nodes
61181       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
61182
61183       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
61184     required:
61185     - segmentation-id
61186     properties:
61187       segmentation-id:
61188         type: string
61189         description: Route Table Reference id, UUID assigned to this instance.
61190       resource-version:
61191         type: string
61192         description: Concurrency value
61193       relationship-list:
61194         type: array
61195         items:
61196           $ref: "#/getDefinitions/relationship"
61197   segmentation-assignments:
61198     description: |
61199       Collection of openstack segmentation assignments
61200     properties:
61201       segmentation-assignment:
61202         type: array
61203         items:
61204           $ref: "#/getDefinitions/segmentation-assignment"
61205   service:
61206     description: |
61207       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
61208     required:
61209     - service-id
61210     - service-description
61211     properties:
61212       service-id:
61213         type: string
61214         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61215       service-description:
61216         type: string
61217         description: Description of the service
61218       service-selflink:
61219         type: string
61220         description: URL to endpoint where AAI can get more details
61221       resource-version:
61222         type: string
61223         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61224       service-version:
61225         type: string
61226         description: service version
61227       relationship-list:
61228         type: array
61229         items:
61230           $ref: "#/getDefinitions/relationship"
61231   service-capabilities:
61232     description: |
61233       Collection of service capabilities.
61234     properties:
61235       service-capability:
61236         type: array
61237         items:
61238           $ref: "#/getDefinitions/service-capability"
61239   service-capability:
61240     description: |
61241       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
61242       ###### Related Nodes
61243       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
61244       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
61245
61246       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
61247
61248     required:
61249     - service-type
61250     - vnf-type
61251     properties:
61252       service-type:
61253         type: string
61254         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61255       vnf-type:
61256         type: string
61257         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
61258       resource-version:
61259         type: string
61260         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61261       relationship-list:
61262         type: array
61263         items:
61264           $ref: "#/getDefinitions/relationship"
61265   service-design-and-creation:
61266     description: |
61267       Namespace for objects managed by ASDC
61268     properties:
61269       vnf-images:
61270         type: array
61271         items:
61272           $ref: "#/getDefinitions/vnf-image"
61273       services:
61274         type: array
61275         items:
61276           $ref: "#/getDefinitions/service"
61277       service-capabilities:
61278         type: array
61279         items:
61280           $ref: "#/getDefinitions/service-capability"
61281       models:
61282         type: array
61283         items:
61284           $ref: "#/getDefinitions/model"
61285       named-queries:
61286         type: array
61287         items:
61288           $ref: "#/getDefinitions/named-query"
61289   service-instance:
61290     description: |
61291       Instance of a service
61292       ###### Related Nodes
61293       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
61294       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
61295       - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
61296       - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
61297       - TO configuration( service-instance Uses configuration, ONE2MANY)
61298       - TO connector( service-instance Uses connector, MANY2MANY)
61299       - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
61300       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
61301       - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
61302       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
61303       - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
61304       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
61305       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
61306       - TO zone( service-instance LocatedIn zone, MANY2ONE)
61307       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
61308       - TO vce( service-instance ComposedOf vce, ONE2MANY)
61309       - TO model-ver( service-instance IsA model-ver, Many2One)
61310       - FROM project( project Uses service-instance, ONE2MANY)
61311       - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
61312       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
61313       - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
61314       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
61315
61316       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
61317       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
61318       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
61319     required:
61320     - service-instance-id
61321     properties:
61322       service-instance-id:
61323         type: string
61324         description: Uniquely identifies this instance of a service
61325       service-instance-name:
61326         type: string
61327         description: This field will store a name assigned to the service-instance.
61328       service-type:
61329         type: string
61330         description: String capturing type of service.
61331       service-role:
61332         type: string
61333         description: String capturing the service role.
61334       environment-context:
61335         type: string
61336         description: This field will store the environment context assigned to the service-instance.
61337       workload-context:
61338         type: string
61339         description: This field will store the workload context assigned to the service-instance.
61340       created-at:
61341         type: string
61342         description: create time of Network Service.
61343       updated-at:
61344         type: string
61345         description: last update of Network Service.
61346       description:
61347         type: string
61348         description: short description for service-instance.
61349       model-invariant-id:
61350         type: string
61351         description: the ASDC model id for this resource or service model.
61352       model-version-id:
61353         type: string
61354         description: the ASDC model version for this resource or service model.
61355       persona-model-version:
61356         type: string
61357         description: the ASDC model version for this resource or service model.
61358       widget-model-id:
61359         type: string
61360         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
61361       widget-model-version:
61362         type: string
61363         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
61364       bandwidth-total:
61365         type: string
61366         description: Indicates the total bandwidth to be used for this service.
61367       bandwidth-up-wan1:
61368         type: string
61369         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
61370       bandwidth-down-wan1:
61371         type: string
61372         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
61373       bandwidth-up-wan2:
61374         type: string
61375         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
61376       bandwidth-down-wan2:
61377         type: string
61378         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
61379       vhn-portal-url:
61380         type: string
61381         description: URL customers will use to access the vHN Portal.
61382       service-instance-location-id:
61383         type: string
61384         description: An identifier that customers assign to the location where this service is being used.
61385       resource-version:
61386         type: string
61387         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61388       selflink:
61389         type: string
61390         description: Path to the controller object.
61391       orchestration-status:
61392         type: string
61393         description: Orchestration status of this service.
61394       relationship-list:
61395         type: array
61396         items:
61397           $ref: "#/getDefinitions/relationship"
61398       metadata:
61399         type: array
61400         items:
61401           $ref: "#/getDefinitions/metadatum"
61402       allotted-resources:
61403         type: array
61404         items:
61405           $ref: "#/getDefinitions/allotted-resource"
61406   service-instances:
61407     description: |
61408       Collection of service instances
61409     properties:
61410       service-instance:
61411         type: array
61412         items:
61413           $ref: "#/getDefinitions/service-instance"
61414   service-subscription:
61415     description: |
61416       Object that group service instances.
61417       ###### Related Nodes
61418       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
61419       - TO tenant( service-subscription Uses tenant, MANY2MANY)
61420       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
61421
61422       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
61423       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
61424     required:
61425     - service-type
61426     properties:
61427       service-type:
61428         type: string
61429         description: Value defined by orchestration to identify this service across ECOMP.
61430       temp-ub-sub-account-id:
61431         type: string
61432         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
61433       resource-version:
61434         type: string
61435         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61436       service-instances:
61437         type: array
61438         items:
61439           $ref: "#/getDefinitions/service-instance"
61440       relationship-list:
61441         type: array
61442         items:
61443           $ref: "#/getDefinitions/relationship"
61444   service-subscriptions:
61445     description: |
61446       Collection of objects that group service instances.
61447     properties:
61448       service-subscription:
61449         type: array
61450         items:
61451           $ref: "#/getDefinitions/service-subscription"
61452   services:
61453     description: |
61454       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
61455     properties:
61456       service:
61457         type: array
61458         items:
61459           $ref: "#/getDefinitions/service"
61460   site-pair:
61461     description: |
61462       ###### Related Nodes
61463       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
61464       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
61465
61466       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
61467       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
61468     required:
61469     - site-pair-id
61470     properties:
61471       site-pair-id:
61472         type: string
61473         description: unique identifier of probe
61474       source-ip:
61475         type: string
61476         description: Prefix address
61477       destination-ip:
61478         type: string
61479         description: Prefix address
61480       ip-version:
61481         type: string
61482         description: ip version, v4, v6
61483       destination-hostname:
61484         type: string
61485         description: Hostname of the destination equipment to which SLAs are measured against.
61486       destination-equip-type:
61487         type: string
61488         description: The type of destinatination equipment. Could be Router, UCPE, etc.
61489       resource-version:
61490         type: string
61491         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61492       classes-of-service:
61493         type: array
61494         items:
61495           $ref: "#/getDefinitions/class-of-service"
61496       relationship-list:
61497         type: array
61498         items:
61499           $ref: "#/getDefinitions/relationship"
61500   site-pair-set:
61501     description: |
61502       Set of instances for probes used to measure service level agreements
61503       ###### Related Nodes
61504       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
61505       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
61506
61507       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
61508     required:
61509     - site-pair-set-id
61510     properties:
61511       site-pair-set-id:
61512         type: string
61513         description: Unique id of site pair set.
61514       resource-version:
61515         type: string
61516         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61517       routing-instances:
61518         type: array
61519         items:
61520           $ref: "#/getDefinitions/routing-instance"
61521       relationship-list:
61522         type: array
61523         items:
61524           $ref: "#/getDefinitions/relationship"
61525   site-pair-sets:
61526     description: |
61527       Collection of sets of instances for probes related to generic-vnf
61528     properties:
61529       site-pair-set:
61530         type: array
61531         items:
61532           $ref: "#/getDefinitions/site-pair-set"
61533   site-pairs:
61534     description: |
61535       probe within a set
61536     properties:
61537       site-pair:
61538         type: array
61539         items:
61540           $ref: "#/getDefinitions/site-pair"
61541   snapshot:
61542     description: |
61543       Openstack snapshot
61544       ###### Related Nodes
61545       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
61546       - FROM vserver( vserver Uses snapshot, ONE2ONE)
61547
61548     required:
61549     - snapshot-id
61550     properties:
61551       snapshot-id:
61552         type: string
61553         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
61554       snapshot-name:
61555         type: string
61556         description: Snapshot name
61557       snapshot-architecture:
61558         type: string
61559         description: Operating system architecture
61560       snapshot-os-distro:
61561         type: string
61562         description: The common name of the operating system distribution in lowercase
61563       snapshot-os-version:
61564         type: string
61565         description: The operating system version as specified by the distributor.
61566       application:
61567         type: string
61568         description: The application that the image instantiates.
61569       application-vendor:
61570         type: string
61571         description: The vendor of the application.
61572       application-version:
61573         type: string
61574         description: The version of the application.
61575       snapshot-selflink:
61576         type: string
61577         description: URL to endpoint where AAI can get more details
61578       prev-snapshot-id:
61579         type: string
61580         description: This field contains the UUID of the previous snapshot (if any).
61581       resource-version:
61582         type: string
61583         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61584       relationship-list:
61585         type: array
61586         items:
61587           $ref: "#/getDefinitions/relationship"
61588   snapshots:
61589     description: |
61590       Collection of openstack snapshots
61591     properties:
61592       snapshot:
61593         type: array
61594         items:
61595           $ref: "#/getDefinitions/snapshot"
61596   sriov-pf:
61597     description: |
61598       SR-IOV Physical Function
61599       ###### Related Nodes
61600       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
61601       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
61602
61603       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
61604     required:
61605     - pf-pci-id
61606     properties:
61607       pf-pci-id:
61608         type: string
61609         description: Identifier for the sriov-pf
61610       resource-version:
61611         type: string
61612         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61613       relationship-list:
61614         type: array
61615         items:
61616           $ref: "#/getDefinitions/relationship"
61617   sriov-pfs:
61618     description: |
61619       Collection of SR-IOV Physical Functions.
61620     properties:
61621       sriov-pf:
61622         type: array
61623         items:
61624           $ref: "#/getDefinitions/sriov-pf"
61625   sriov-vf:
61626     description: |
61627       SR-IOV Virtual Function (not to be confused with virtual network function)
61628       ###### Related Nodes
61629       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
61630       - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
61631
61632       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
61633     required:
61634     - pci-id
61635     properties:
61636       pci-id:
61637         type: string
61638         description: PCI ID used to identify the sriov-vf
61639       vf-vlan-filter:
61640         type: string
61641         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
61642       vf-mac-filter:
61643         type: string
61644         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
61645       vf-vlan-strip:
61646         type: boolean
61647         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
61648       vf-vlan-anti-spoof-check:
61649         type: boolean
61650         description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
61651       vf-mac-anti-spoof-check:
61652         type: boolean
61653         description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
61654       vf-mirrors:
61655         type: string
61656         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
61657       vf-broadcast-allow:
61658         type: boolean
61659         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
61660       vf-unknown-multicast-allow:
61661         type: boolean
61662         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
61663       vf-unknown-unicast-allow:
61664         type: boolean
61665         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
61666       vf-insert-stag:
61667         type: boolean
61668         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
61669       vf-link-status:
61670         type: string
61671         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
61672       resource-version:
61673         type: string
61674         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61675       neutron-network-id:
61676         type: string
61677         description: Neutron network id of the interface
61678       relationship-list:
61679         type: array
61680         items:
61681           $ref: "#/getDefinitions/relationship"
61682   sriov-vfs:
61683     description: |
61684       Collection of SR-IOV Virtual Functions.
61685     properties:
61686       sriov-vf:
61687         type: array
61688         items:
61689           $ref: "#/getDefinitions/sriov-vf"
61690   start-node-filter:
61691     properties:
61692       property-name:
61693         type: string
61694       property-value:
61695         type: string
61696   subnet:
61697     description: |
61698       ###### Related Nodes
61699       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
61700       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
61701       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
61702       - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
61703       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
61704       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
61705
61706       -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
61707       -(4) IF this TO node is deleted, this SUBNET is DELETED also
61708       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
61709
61710     required:
61711     - subnet-id
61712     - dhcp-enabled
61713     properties:
61714       subnet-id:
61715         type: string
61716         description: Subnet ID, should be UUID.
61717       subnet-name:
61718         type: string
61719         description: Name associated with the subnet.
61720       neutron-subnet-id:
61721         type: string
61722         description: Neutron id of this subnet
61723       gateway-address:
61724         type: string
61725         description: gateway ip address
61726       network-start-address:
61727         type: string
61728         description: network start address
61729       cidr-mask:
61730         type: string
61731         description: cidr mask
61732       ip-version:
61733         type: string
61734         description: ip version
61735       orchestration-status:
61736         type: string
61737         description: Orchestration status of this VNF, mastered by MSO
61738       dhcp-enabled:
61739         type: boolean
61740         description: dhcp enabled
61741       dhcp-start:
61742         type: string
61743         description: the start address reserved for use by dhcp
61744       dhcp-end:
61745         type: string
61746         description: the last address reserved for use by dhcp
61747       subnet-role:
61748         type: string
61749         description: role of the subnet, referenced when assigning IPs
61750       ip-assignment-direction:
61751         type: string
61752         description: ip address assignment direction of the subnet
61753       resource-version:
61754         type: string
61755         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61756       subnet-sequence:
61757         type: integer
61758         format: int32
61759         description: sequence of the subnet
61760       host-routes:
61761         type: array
61762         items:
61763           $ref: "#/getDefinitions/host-route"
61764       relationship-list:
61765         type: array
61766         items:
61767           $ref: "#/getDefinitions/relationship"
61768   subnets:
61769     properties:
61770       subnet:
61771         type: array
61772         items:
61773           $ref: "#/getDefinitions/subnet"
61774   tagged-inventory-item-list:
61775     properties:
61776       inventory-item:
61777         type: array
61778         items:
61779           $ref: "#/getDefinitions/inventory-item"
61780   tenant:
61781     description: |
61782       Openstack tenant
61783       ###### Related Nodes
61784       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
61785       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
61786       - TO l3-network( tenant Uses l3-network, MANY2MANY)
61787       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
61788       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
61789       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
61790
61791       -TENANT cannot be deleted if related to VSERVER
61792
61793     required:
61794     - tenant-id
61795     - tenant-name
61796     properties:
61797       tenant-id:
61798         type: string
61799         description: Unique id relative to the cloud-region.
61800       tenant-name:
61801         type: string
61802         description: Readable name of tenant
61803       tenant-context:
61804         type: string
61805         description: This field will store the tenant context.
61806       resource-version:
61807         type: string
61808         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61809       vservers:
61810         type: array
61811         items:
61812           $ref: "#/getDefinitions/vserver"
61813       relationship-list:
61814         type: array
61815         items:
61816           $ref: "#/getDefinitions/relationship"
61817   tenants:
61818     description: |
61819       Collection of openstack tenants.
61820     properties:
61821       tenant:
61822         type: array
61823         items:
61824           $ref: "#/getDefinitions/tenant"
61825   tunnel-xconnect:
61826     description: |
61827       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
61828       ###### Related Nodes
61829       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
61830
61831       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
61832     required:
61833     - id
61834     properties:
61835       id:
61836         type: string
61837         description: Allotted Resource id UUID assigned to this instance.
61838       bandwidth-up-wan1:
61839         type: string
61840         description: The WAN uplink bandwidth for WAN1
61841       bandwidth-down-wan1:
61842         type: string
61843         description: The WAN downlink bandwidth for WAN1
61844       bandwidth-up-wan2:
61845         type: string
61846         description: The WAN uplink bandwidth for WAN2
61847       bandwidth-down-wan2:
61848         type: string
61849         description: The WAN downlink bandwidth for WAN2
61850       resource-version:
61851         type: string
61852         description: Concurrency value
61853       relationship-list:
61854         type: array
61855         items:
61856           $ref: "#/getDefinitions/relationship"
61857   tunnel-xconnects:
61858     description: |
61859       This object is used to store the specific tunnel cross connect aspects of an allotted resource
61860     properties:
61861       tunnel-xconnect:
61862         type: array
61863         items:
61864           $ref: "#/getDefinitions/tunnel-xconnect"
61865   update:
61866     description: |
61867       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
61868     required:
61869     - update-node-type
61870     properties:
61871       update-node-type:
61872         type: string
61873       update-node-key:
61874         type: array
61875         items:
61876           $ref: "#/getDefinitions/update-node-key"
61877       update-node-uri:
61878         type: string
61879       action:
61880         type: array
61881         items:
61882           $ref: "#/getDefinitions/action"
61883   update-node-key:
61884     properties:
61885       key-name:
61886         type: string
61887       key-value:
61888         type: string
61889   vce:
61890     description: |
61891       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
61892       ###### Related Nodes
61893       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
61894       - TO complex( vce LocatedIn complex, MANY2MANY)
61895       - TO vserver( vce HostedOn vserver, ONE2MANY)
61896       - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
61897       - FROM license( license BelongsTo vce, MANY2ONE)(1)
61898       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
61899       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
61900
61901       -(1) IF this VCE node is deleted, this FROM node is DELETED also
61902     required:
61903     - vnf-id
61904     - vnf-name
61905     - vnf-type
61906     properties:
61907       vnf-id:
61908         type: string
61909         description: Unique id of VNF.  This is unique across the graph.
61910       vnf-name:
61911         type: string
61912         description: Name of VNF.
61913       vnf-name2:
61914         type: string
61915         description: Alternate name of VNF.
61916       vnf-type:
61917         type: string
61918         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
61919       service-id:
61920         type: string
61921         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
61922       regional-resource-zone:
61923         type: string
61924         description: Regional way of organizing pservers, source of truth should define values
61925       prov-status:
61926         type: string
61927         description: Trigger for operational monitoring of this resource by Service Assurance systems.
61928       operational-status:
61929         type: string
61930         description: Indicator for whether the resource is considered operational
61931       license-key:
61932         type: string
61933         description: OBSOLETE -  do not use
61934       equipment-role:
61935         type: string
61936         description: Network role being played by this VNF
61937       orchestration-status:
61938         type: string
61939         description: Orchestration status of this VNF, mastered by MSO
61940       heat-stack-id:
61941         type: string
61942         description: Heat stack id corresponding to this instance, managed by MSO
61943       mso-catalog-key:
61944         type: string
61945         description: Corresponds to the SDN-C catalog id used to configure this VCE
61946       vpe-id:
61947         type: string
61948         description: Unique ID of VPE connected to this VCE.
61949       v6-vce-wan-address:
61950         type: string
61951         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
61952       ipv4-oam-address:
61953         type: string
61954         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
61955       resource-version:
61956         type: string
61957         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61958       ipv4-loopback0-address:
61959         type: string
61960         description: Loopback0 address
61961       entitlement-resource-uuid:
61962         type: string
61963         description: OBSOLETE -  see child relationships
61964       port-groups:
61965         type: array
61966         items:
61967           $ref: "#/getDefinitions/port-group"
61968       licenses:
61969         type: array
61970         items:
61971           $ref: "#/getDefinitions/license"
61972       entitlements:
61973         type: array
61974         items:
61975           $ref: "#/getDefinitions/entitlement"
61976       relationship-list:
61977         type: array
61978         items:
61979           $ref: "#/getDefinitions/relationship"
61980   vces:
61981     description: |
61982       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
61983     properties:
61984       vce:
61985         type: array
61986         items:
61987           $ref: "#/getDefinitions/vce"
61988   vf-module:
61989     description: |
61990       a deployment unit of VNFCs
61991       ###### Related Nodes
61992       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
61993       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
61994       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
61995       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
61996       - TO vserver( vf-module Uses vserver, ONE2MANY)
61997       - TO model-ver( vf-module IsA model-ver, Many2One)
61998
61999       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
62000       -VF-MODULE cannot be deleted if related to VNFC
62001
62002     required:
62003     - vf-module-id
62004     - is-base-vf-module
62005     properties:
62006       vf-module-id:
62007         type: string
62008         description: Unique ID of vf-module.
62009       vf-module-name:
62010         type: string
62011         description: Name of vf-module
62012       heat-stack-id:
62013         type: string
62014         description: Heat stack id corresponding to this instance.
62015       orchestration-status:
62016         type: string
62017         description: orchestration status of this vf-module, mastered by MSO
62018       is-base-vf-module:
62019         type: boolean
62020         description: used to indicate whether or not this object is base vf module
62021       resource-version:
62022         type: string
62023         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62024       model-invariant-id:
62025         type: string
62026         description: the ASDC model id for this resource or service model.
62027       model-version-id:
62028         type: string
62029         description: the ASDC model version for this resource or service model.
62030       persona-model-version:
62031         type: string
62032         description: the ASDC model version for this resource or service model.
62033       model-customization-id:
62034         type: string
62035         description: captures the id of all the configuration used to customize the resource for the service.
62036       widget-model-id:
62037         type: string
62038         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
62039       widget-model-version:
62040         type: string
62041         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
62042       contrail-service-instance-fqdn:
62043         type: string
62044         description: the Contrail unique ID for a service-instance
62045       module-index:
62046         type: integer
62047         format: int32
62048         description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
62049       selflink:
62050         type: string
62051         description: Path to the controller object.
62052       relationship-list:
62053         type: array
62054         items:
62055           $ref: "#/getDefinitions/relationship"
62056   vf-modules:
62057     description: |
62058       Collection of vf-modules, a deployment unit of VNFCs
62059     properties:
62060       vf-module:
62061         type: array
62062         items:
62063           $ref: "#/getDefinitions/vf-module"
62064   vig-server:
62065     description: |
62066       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
62067       ###### Related Nodes
62068       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
62069
62070       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
62071     required:
62072     - vig-address-type
62073     properties:
62074       vig-address-type:
62075         type: string
62076         description: indicates whether the VIG is for AVPN or INTERNET
62077       ipaddress-v4-vig:
62078         type: string
62079         description: v4 IP of the vig server
62080       ipaddress-v6-vig:
62081         type: string
62082         description: v6 IP of the vig server
62083       resource-version:
62084         type: string
62085         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62086       relationship-list:
62087         type: array
62088         items:
62089           $ref: "#/getDefinitions/relationship"
62090   vig-servers:
62091     properties:
62092       vig-server:
62093         type: array
62094         items:
62095           $ref: "#/getDefinitions/vig-server"
62096   vip-ipv4-address-list:
62097     description: |
62098       IPv4 Address Range
62099       ###### Related Nodes
62100       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
62101       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
62102       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
62103       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
62104
62105     required:
62106     - vip-ipv4-address
62107     properties:
62108       vip-ipv4-address:
62109         type: string
62110         description: IP address
62111       vip-ipv4-prefix-length:
62112         type: integer
62113         format: int64
62114         description: Prefix length, 32 for single address
62115       vlan-id-inner:
62116         type: integer
62117         format: int64
62118         description: Inner VLAN tag
62119       vlan-id-outer:
62120         type: integer
62121         format: int64
62122         description: Outer VLAN tag
62123       is-floating:
62124         type: boolean
62125         description: Indicator of fixed or floating address
62126       resource-version:
62127         type: string
62128         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62129       neutron-network-id:
62130         type: string
62131         description: Neutron network id of the interface that address belongs to
62132       neutron-subnet-id:
62133         type: string
62134         description: Neutron id of subnet that address belongs to
62135       relationship-list:
62136         type: array
62137         items:
62138           $ref: "#/getDefinitions/relationship"
62139   vip-ipv6-address-list:
62140     description: |
62141       IPv6 Address Range
62142       ###### Related Nodes
62143       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
62144       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
62145       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
62146       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
62147
62148     required:
62149     - vip-ipv6-address
62150     properties:
62151       vip-ipv6-address:
62152         type: string
62153         description: IP address
62154       vip-ipv6-prefix-length:
62155         type: integer
62156         format: int64
62157         description: Prefix length, 128 for single address
62158       vlan-id-inner:
62159         type: integer
62160         format: int64
62161         description: Inner VLAN tag
62162       vlan-id-outer:
62163         type: integer
62164         format: int64
62165         description: Outer VLAN tag
62166       is-floating:
62167         type: boolean
62168         description: Indicator of fixed or floating address
62169       resource-version:
62170         type: string
62171         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62172       neutron-network-id:
62173         type: string
62174         description: Neutron network id of the interface that address belongs to
62175       neutron-subnet-id:
62176         type: string
62177         description: Neutron id of subnet that address belongs to
62178       relationship-list:
62179         type: array
62180         items:
62181           $ref: "#/getDefinitions/relationship"
62182   virtual-data-center:
62183     description: |
62184       Virtual organization of cloud infrastructure elements in a data center context
62185       ###### Related Nodes
62186       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
62187       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
62188       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
62189
62190     required:
62191     - vdc-id
62192     - vdc-name
62193     properties:
62194       vdc-id:
62195         type: string
62196         description: Unique ID of the vdc
62197       vdc-name:
62198         type: string
62199         description: Name of the virtual data center
62200       resource-version:
62201         type: string
62202         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62203       relationship-list:
62204         type: array
62205         items:
62206           $ref: "#/getDefinitions/relationship"
62207   virtual-data-centers:
62208     description: |
62209       Virtual organization of cloud infrastructure elements in a data center context
62210     properties:
62211       virtual-data-center:
62212         type: array
62213         items:
62214           $ref: "#/getDefinitions/virtual-data-center"
62215   vlan:
62216     description: |
62217       Definition of vlan
62218       ###### Related Nodes
62219       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
62220       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
62221       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
62222       - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
62223       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
62224       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
62225       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
62226
62227       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
62228       -(2) IF this VLAN node is deleted, this TO node is DELETED also
62229       -(4) IF this TO node is deleted, this VLAN is DELETED also
62230     required:
62231     - vlan-interface
62232     - in-maint
62233     - is-ip-unnumbered
62234     properties:
62235       vlan-interface:
62236         type: string
62237         description: String that identifies the interface
62238       vlan-id-inner:
62239         type: integer
62240         format: int64
62241         description: Inner VLAN tag
62242       vlan-id-outer:
62243         type: integer
62244         format: int64
62245         description: Outer VLAN tag
62246       resource-version:
62247         type: string
62248         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62249       speed-value:
62250         type: string
62251         description: Captures the numeric part of the speed
62252       speed-units:
62253         type: string
62254         description: Captures the units corresponding to the speed
62255       vlan-description:
62256         type: string
62257         description: Used to describe (the service associated with) the vlan
62258       backdoor-connection:
62259         type: string
62260         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
62261       vpn-key:
62262         type: string
62263         description: This indicates the customers VPN ID associated with this vlan
62264       orchestration-status:
62265         type: string
62266         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
62267       in-maint:
62268         type: boolean
62269         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
62270       prov-status:
62271         type: string
62272         description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
62273       is-ip-unnumbered:
62274         type: boolean
62275         description: Flag indicating the interface uses the IP Unnumbered configuration.
62276       relationship-list:
62277         type: array
62278         items:
62279           $ref: "#/getDefinitions/relationship"
62280       l3-interface-ipv4-address-list:
62281         type: array
62282         items:
62283           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
62284       l3-interface-ipv6-address-list:
62285         type: array
62286         items:
62287           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
62288   vlans:
62289     properties:
62290       vlan:
62291         type: array
62292         items:
62293           $ref: "#/getDefinitions/vlan"
62294   vnf:
62295     description: |
62296       Abstract vnf class
62297     required:
62298     - vnf-id
62299     properties:
62300       vnf-id:
62301         type: string
62302         description: Unique id of VNF.  This is unique across the graph.
62303   vnf-image:
62304     description: |
62305       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
62306       ###### Related Nodes
62307       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
62308
62309       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
62310
62311     required:
62312     - vnf-image-uuid
62313     - application
62314     - application-vendor
62315     properties:
62316       vnf-image-uuid:
62317         type: string
62318         description: Unique ID of this asset
62319       application:
62320         type: string
62321         description: The application that the image instantiates.
62322       application-vendor:
62323         type: string
62324         description: The vendor of the application.
62325       application-version:
62326         type: string
62327         description: The version of the application.
62328       selflink:
62329         type: string
62330         description: URL to endpoint where AAI can get more details
62331       resource-version:
62332         type: string
62333         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62334       relationship-list:
62335         type: array
62336         items:
62337           $ref: "#/getDefinitions/relationship"
62338   vnf-images:
62339     description: |
62340       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
62341     properties:
62342       vnf-image:
62343         type: array
62344         items:
62345           $ref: "#/getDefinitions/vnf-image"
62346   vnfc:
62347     description: |
62348       ###### Related Nodes
62349       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
62350       - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
62351       - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
62352       - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
62353       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
62354       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
62355       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
62356       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
62357
62358       -(1) IF this VNFC node is deleted, this FROM node is DELETED also
62359       -(4) IF this TO node is deleted, this VNFC is DELETED also
62360     required:
62361     - vnfc-name
62362     - nfc-naming-code
62363     - nfc-function
62364     - in-maint
62365     - is-closed-loop-disabled
62366     properties:
62367       vnfc-name:
62368         type: string
62369         description: Unique ID of vnfc.
62370       nfc-naming-code:
62371         type: string
62372         description: Short code that is used in naming instances of the item being modeled
62373       nfc-function:
62374         type: string
62375         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
62376       prov-status:
62377         type: string
62378         description: prov status of this vnfc
62379       orchestration-status:
62380         type: string
62381         description: Orchestration status of this VNF, mastered by APP-C
62382       ipaddress-v4-oam-vip:
62383         type: string
62384         description: Oam V4 vip address of this vnfc
62385       in-maint:
62386         type: boolean
62387         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
62388       is-closed-loop-disabled:
62389         type: boolean
62390         description: used to indicate whether closed loop function is enabled on this node
62391       group-notation:
62392         type: string
62393         description: Group notation of VNFC
62394       model-invariant-id:
62395         type: string
62396         description: the ASDC model id for this resource or service model.
62397       model-version-id:
62398         type: string
62399         description: the ASDC model version for this resource or service model.
62400       resource-version:
62401         type: string
62402         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62403       relationship-list:
62404         type: array
62405         items:
62406           $ref: "#/getDefinitions/relationship"
62407       l3-interface-ipv4-address-list:
62408         type: array
62409         items:
62410           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
62411       l3-interface-ipv6-address-list:
62412         type: array
62413         items:
62414           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
62415   vnfcs:
62416     description: |
62417       virtual network components associated with a vserver from application controller.
62418     properties:
62419       vnfc:
62420         type: array
62421         items:
62422           $ref: "#/getDefinitions/vnfc"
62423   volume:
62424     description: |
62425       Ephemeral Block storage volume.
62426       ###### Related Nodes
62427       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
62428
62429       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
62430     required:
62431     - volume-id
62432     - volume-selflink
62433     properties:
62434       volume-id:
62435         type: string
62436         description: Unique ID of block storage volume relative to the vserver.
62437       volume-selflink:
62438         type: string
62439         description: URL to endpoint where AAI can get more details
62440       resource-version:
62441         type: string
62442         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62443       relationship-list:
62444         type: array
62445         items:
62446           $ref: "#/getDefinitions/relationship"
62447   volume-group:
62448     description: |
62449       Persistent block-level storage.
62450       ###### Related Nodes
62451       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
62452       - TO complex( volume-group LocatedIn complex, MANY2ONE)
62453       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
62454       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
62455       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
62456
62457     required:
62458     - volume-group-id
62459     - volume-group-name
62460     - vnf-type
62461     properties:
62462       volume-group-id:
62463         type: string
62464         description: Unique ID of volume-group.
62465       volume-group-name:
62466         type: string
62467         description: Name of the volume group.
62468       heat-stack-id:
62469         type: string
62470         description: Heat stack id corresponding to this volume-group
62471       vnf-type:
62472         type: string
62473         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
62474       orchestration-status:
62475         type: string
62476         description: Orchestration status of this volume-group
62477       model-customization-id:
62478         type: string
62479         description: captures the id of all the configuration used to customize the resource for the service.
62480       vf-module-model-customization-id:
62481         type: string
62482         description: helps relate the volume group to the vf-module whose components will require the volume group
62483       resource-version:
62484         type: string
62485         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62486       relationship-list:
62487         type: array
62488         items:
62489           $ref: "#/getDefinitions/relationship"
62490   volume-groups:
62491     description: |
62492       Collection of persistent block-level storage.
62493     properties:
62494       volume-group:
62495         type: array
62496         items:
62497           $ref: "#/getDefinitions/volume-group"
62498   volumes:
62499     description: |
62500       Collection of ephemeral Block storage volumes.
62501     properties:
62502       volume:
62503         type: array
62504         items:
62505           $ref: "#/getDefinitions/volume"
62506   vpls-pe:
62507     description: |
62508       VPLS Provider Edge routers.
62509       ###### Related Nodes
62510       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
62511       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
62512       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
62513       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
62514
62515       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
62516     required:
62517     - equipment-name
62518     properties:
62519       equipment-name:
62520         type: string
62521       prov-status:
62522         type: string
62523         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
62524       ipv4-oam-address:
62525         type: string
62526         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
62527       equipment-role:
62528         type: string
62529         description: Client should send valid enumerated value, e.g., VPLS-PE.
62530       vlan-id-outer:
62531         type: integer
62532         format: int64
62533         description: Temporary location for stag to get to VCE
62534       resource-version:
62535         type: string
62536         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62537       relationship-list:
62538         type: array
62539         items:
62540           $ref: "#/getDefinitions/relationship"
62541       p-interfaces:
62542         type: array
62543         items:
62544           $ref: "#/getDefinitions/p-interface"
62545       lag-interfaces:
62546         type: array
62547         items:
62548           $ref: "#/getDefinitions/lag-interface"
62549   vpls-pes:
62550     description: |
62551       Collection of VPLS Provider Edge routers
62552     properties:
62553       vpls-pe:
62554         type: array
62555         items:
62556           $ref: "#/getDefinitions/vpls-pe"
62557   vpn-binding:
62558     description: |
62559       VPN binding
62560       ###### Related Nodes
62561       - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
62562       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
62563       - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
62564       - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
62565
62566       -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
62567       -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
62568
62569     required:
62570     - vpn-id
62571     - vpn-name
62572     properties:
62573       vpn-id:
62574         type: string
62575         description: VPN ID, globally unique within A&AI
62576       vpn-name:
62577         type: string
62578         description: VPN Name
62579       vpn-platform:
62580         type: string
62581         description: the platform associated with the VPN example AVPN, Mobility
62582       vpn-type:
62583         type: string
62584         description: Type of the vpn, should be taken from enumerated/valid values
62585       vpn-region:
62586         type: string
62587         description: region of customer vpn
62588       customer-vpn-id:
62589         type: string
62590         description: id for this customer vpn
62591       route-distinguisher:
62592         type: string
62593         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
62594       resource-version:
62595         type: string
62596         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62597       route-targets:
62598         type: array
62599         items:
62600           $ref: "#/getDefinitions/route-target"
62601       relationship-list:
62602         type: array
62603         items:
62604           $ref: "#/getDefinitions/relationship"
62605         description: l3-networks relate to vpn-bindings
62606   vpn-bindings:
62607     properties:
62608       vpn-binding:
62609         type: array
62610         items:
62611           $ref: "#/getDefinitions/vpn-binding"
62612   vserver:
62613     description: |
62614       Virtual Servers, aka virtual machine or VM.
62615       ###### Related Nodes
62616       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
62617       - TO flavor( vserver Uses flavor, MANY2ONE)
62618       - TO image( vserver Uses image, MANY2ONE)
62619       - TO pserver( vserver HostedOn pserver, MANY2ONE)
62620       - TO snapshot( vserver Uses snapshot, ONE2ONE)
62621       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
62622       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
62623       - FROM vce( vce HostedOn vserver, ONE2MANY)
62624       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
62625       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
62626       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
62627
62628       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
62629       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
62630     required:
62631     - vserver-id
62632     - vserver-name
62633     - vserver-selflink
62634     - in-maint
62635     - is-closed-loop-disabled
62636     properties:
62637       vserver-id:
62638         type: string
62639         description: Unique identifier for this vserver relative to its tenant
62640       vserver-name:
62641         type: string
62642         description: Name of vserver
62643       vserver-name2:
62644         type: string
62645         description: Alternative name of vserver
62646       prov-status:
62647         type: string
62648         description: Trigger for operational monitoring of this resource by Service Assurance systems.
62649       vserver-selflink:
62650         type: string
62651         description: URL to endpoint where AAI can get more details
62652       in-maint:
62653         type: boolean
62654         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
62655       is-closed-loop-disabled:
62656         type: boolean
62657         description: Used to indicate whether closed loop function is enabled on this node
62658       resource-version:
62659         type: string
62660         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62661       volumes:
62662         type: array
62663         items:
62664           $ref: "#/getDefinitions/volume"
62665       relationship-list:
62666         type: array
62667         items:
62668           $ref: "#/getDefinitions/relationship"
62669       l-interfaces:
62670         type: array
62671         items:
62672           $ref: "#/getDefinitions/l-interface"
62673   vservers:
62674     description: |
62675       Collection of virtual Servers, aka virtual machines or VMs.
62676     properties:
62677       vserver:
62678         type: array
62679         items:
62680           $ref: "#/getDefinitions/vserver"
62681   zone:
62682     description: |
62683       A zone is a grouping of assets in a location homing to the same connections into the CBB
62684       ###### Related Nodes
62685       - TO complex( zone LocatedIn complex, MANY2ONE)
62686       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
62687       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
62688       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
62689       - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
62690
62691     required:
62692     - zone-id
62693     - zone-name
62694     - design-type
62695     - zone-context
62696     properties:
62697       zone-id:
62698         type: string
62699         description: Code assigned by AIC to the zone
62700       zone-name:
62701         type: string
62702         description: English name associated with the zone
62703       design-type:
62704         type: string
62705         description: Design of zone [Medium/Large…]
62706       zone-context:
62707         type: string
62708         description: Context of zone [production/test]
62709       status:
62710         type: string
62711         description: Status of a zone.
62712       resource-version:
62713         type: string
62714         description: Concurrency value
62715       relationship-list:
62716         type: array
62717         items:
62718           $ref: "#/getDefinitions/relationship"
62719   zones:
62720     description: |
62721       Collection of zones
62722     properties:
62723       zone:
62724         type: array
62725         items:
62726           $ref: "#/getDefinitions/zone"